ObjectIndex
open class ObjectIndex
Constructors
<init>
constructor(contents: List<T>)
Index of arbitrary values of type T. Can be looked-up into by position, or by Index.
Parameters
Name | Description |
---|---|
contents: List<T>
|
Methods
add
fun add(value: T, identifier: Identifier?)
Adds the value to the ObjectIndex, with accompanying (optional) identifier.
Parameters
Name | Description |
---|---|
value: T
|
|
identifier: Identifier?
|
ReturnValue
Name | Description |
---|---|
Unit
|
get
operator fun get(index: Index<IdentifierType>): T?
Gets the value (T) from the ObjectIndex using the given Index. Returns null
if it
can't be found.
Parameters
Name | Description |
---|---|
index: Index<IdentifierType>
|
ReturnValue
Name | Description |
---|---|
T?
|
set
operator fun set(index: Index<*>, value: T)
Sets the value at the given index to a new value.
Parameters
Name | Description |
---|---|
index: Index<*>
|
|
value: T
|
ReturnValue
Name | Description |
---|---|
Unit
|
contains
operator fun contains(index: Index<*>): Boolean
Returns whether or not the ObjectIndex contains a value for the given index.
Parameters
Name | Description |
---|---|
index: Index<*>
|
ReturnValue
Name | Description |
---|---|
Boolean
|
equals
open fun equals(other: Any?): Boolean
Parameters
Name | Description |
---|---|
other: Any?
|
ReturnValue
Name | Description |
---|---|
Boolean
|
hashCode
open fun hashCode(): Int
ReturnValue
Name | Description |
---|---|
Int
|
Index of arbitrary values of type T. Can be looked-up into by position, or by Index.