space.vectrix.ignite.util

Class BlackboardMap.Key<T>

java.lang.Object

space.vectrix.ignite.util.BlackboardMap.Key<T>

Type Parameters:

T - the value type

All Implemented Interfaces:

java.lang.Comparable<BlackboardMap.Key<T>>

Enclosing class:

BlackboardMap

public static final class BlackboardMap.Key<T>
extends java.lang.Object
implements java.lang.Comparable<BlackboardMap.Key<T>>

Represents a key for a BlackboardMap.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
int	compareTo(@NotNull BlackboardMap.Key<T> other)
T	defaultValue() Returns the default value.
boolean	equals(@Nullable java.lang.Object other)
int	hashCode()
@NotNull java.lang.String	name() Returns the name.
static <V> @NotNull BlackboardMap.Key<V>	of(@NotNull BlackboardMap map, @NotNull java.lang.String name, @NotNull java.lang.Class<? super V> type, V defaultValue) Returns a new blackboard key for the given BlackboardMap, with the given name and type.
java.lang.String	toString()
@NotNull java.lang.Class<T>	type() Returns the type.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

of

@NotNull
public static <V> @NotNull BlackboardMap.Key<V> of(@NotNull
                                                             @NotNull BlackboardMap map,
                                                             @NotNull
                                                             @NotNull java.lang.String name,
                                                             @NotNull
                                                             @NotNull java.lang.Class<? super V> type,
                                                             V defaultValue)

Returns a new blackboard key for the given BlackboardMap, with the given name and type.

Type Parameters:

V - the value type

Parameters:

map - the blackboard

name - the name

type - the type

defaultValue - the default value

Returns:

a new key

Since:

1.0.0

name

@NotNull
public @NotNull java.lang.String name()

Returns the name.

Returns:

the name

Since:

1.0.0

type

@NotNull
public @NotNull java.lang.Class<T> type()

Returns the type.

Returns:

the type

Since:

1.0.0

defaultValue

public T defaultValue()

Returns the default value.

Returns:

the default value

Since:

1.0.0

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(@Nullable
                      @Nullable java.lang.Object other)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(@NotNull
                     @NotNull BlackboardMap.Key<T> other)

Specified by:

compareTo in interface java.lang.Comparable<BlackboardMap.Key<T>>