BunyipsLib/org.murraybridgebunyips.bunyipslib/Reference

Reference

open class Reference<V>

Represents an object reference that may be reassigned.

Author

Lucas Bubner, 2024

Since

1.0.0-pre

Parameters

<V>

the type of the reference

Constructors

Reference

constructor()

Creates a new reference with a null value.

constructor(@Nullable value: V)

Creates a new reference with the given value.

Functions

clear

open fun clear()

Clears the reference, setting it to null.

empty

open fun <V> empty(): Reference<V>

Creates a new reference with a null value.

equals

open fun equals(obj: Any): Boolean

get

@Nullable

open fun get(): V

Gets the value of the reference.

getOrElse

open fun getOrElse(other: V): V

Returns the value of the reference if it is not null, otherwise returns the given value.

hashCode

open fun hashCode(): Int

Returns the hash code of the reference.

ifNotPresent

open fun ifNotPresent(runnable: Runnable)

Runs the runnable on the value of the reference if it is null.

ifPresent

open fun ifPresent(consumer: Consumer<V>)

Runs the consumer on the value of the reference if it is not null.

ifPresentOrElse

open fun ifPresentOrElse(consumer: Consumer<V>, runnable: Runnable)

Runs the consumer on the value of the reference if it is not null.

isNotNull

open fun isNotNull(): Boolean

Checks if the reference is not null.

isNull

open fun isNull(): Boolean

Checks if the reference is null.

open fun <V> of(@Nullable value: V): Reference<V>

Creates a new reference with the given value.

require

@NonNull

open fun require(): V

Gets the value of the reference.

set

open fun set(@Nullable value: V)

Sets the value of the reference.

setIfNotPresent

open fun setIfNotPresent(@Nullable value: V)

Sets the value of the reference if it is not already set.

setIfPresent

open fun setIfPresent(@Nullable value: V)

Sets the value of the reference if it is already set.

toString

@NonNull

open fun toString(): String

Returns a string representation of the reference.