inspekt/dev.rnett.inspekt.model/Parameters

Parameters

data class Parameters : List<Parameter> (source)

The parameters of a callable. Parameters are ordered by kind (Parameter.Kind):

Dispatch receiver (if present)
Any context parameters
Extension receiver (if present)
Any value parameters.

Properties

context

val context: List<Parameter>

Gets the context parameters. Does not allocate a new list.

dispatch

val dispatch: Parameter?

Gets the dispatch receiver parameter, if present.

extension

val extension: Parameter?

Gets the extension receiver parameter, if present.

hasDispatch

val hasDispatch: Boolean

hasExtension

val hasExtension: Boolean

size

open override val size: Int

value

val value: List<Parameter>

Gets the value parameters. Does not allocate a new list.

Functions

arguments

fun arguments(args: Array<Any?>): ArgumentList

fun arguments(args: Iterable<Any?>): ArgumentList

Requires specifying a value for all parameters, aka args.size == this.size.

buildArguments

inline fun buildArguments(builder: ArgumentsBuilder): ArgumentList

contains

open operator override fun contains(element: Parameter): Boolean

containsAll

open override fun containsAll(elements: Collection<Parameter>): Boolean

context

fun context(indexInContextParameters: Int): Parameter

Gets the context parameter at indexInContextParameters in the list of context parameters.

count

fun count(kind: Parameter.Kind): Int

Gets the number of parameters of a given kind.

get

operator fun get(name: String): Parameter?

Get the parameter named name, if present. Cannot be used with "this", as it could refer to the dispatch or extension receiver.

operator fun get(kind: Parameter.Kind, indexInKind: Int): Parameter

Get a parameter by its index in its own kind. For example, get(Kind.VALUE, 2) gets the third value parameter.

open operator override fun get(index: Int): Parameter

globalIndex

fun globalIndex(kind: Parameter.Kind, indexInKind: Int): Int

Gets the index in this list of a parameter at indexInKind in its kind.

indexOf

open override fun indexOf(element: Parameter): Int

isEmpty

open override fun isEmpty(): Boolean

iterator

open operator override fun iterator(): Iterator<Parameter>

lastIndexOf

open override fun lastIndexOf(element: Parameter): Int

listIterator

open override fun listIterator(): ListIterator<Parameter>

open override fun listIterator(index: Int): ListIterator<Parameter>

startOffset

fun startOffset(kind: Parameter.Kind): Int

Get the start offset in the parameter list of the given kind. Returning a value does not guarantee that parameters of type kind are present.

subList

open override fun subList(fromIndex: Int, toIndex: Int): List<Parameter>

toString

open override fun toString(): String

value

fun value(indexInValueParameters: Int): Parameter

Gets the value parameter at indexInValueParameters in the list of value parameters.