jalse.misc

Interface Identifiable

All Known Subinterfaces:

Entity, JALSE

All Known Implementing Classes:

AbstractIdentifiable, AttributeEvent, DefaultEntity, DefaultJALSE, EntityEvent, EntityTypeEvent, Parent

public interface Identifiable

This is for anything that should be uniquely identifiable within JALSE. This interface allows for easy equality and comparison.

Method Summary

Modifier and Type	Method and Description
static boolean	equals(Identifiable a, java.lang.Object b) Checks if the two identifiable objects are equals using their unique identifiers.
java.util.UUID	getID() Gets the unique identifier.
static java.util.UUID	getID(java.lang.Object obj) Gets the ID of the object if it is an Identifiable.
static int	hashCode(Identifiable obj) Generates a hashcode for an identifiable.
static java.util.function.Predicate<Identifiable>	is(Identifiable obj) Predicate to check if the identifiable is equal to that supplied.
static java.util.function.Predicate<Identifiable>	not(Identifiable obj) Predicate to check if the identifiable is not equal to that supplied.
static java.lang.String	toString(Identifiable obj) Creates a simple to string for the identifiable.

Method Detail

equals

static boolean equals(Identifiable a,
                      java.lang.Object b)

Checks if the two identifiable objects are equals using their unique identifiers.

Parameters:

a - First object.

b - Second object.

Returns:

Whether the unique identifiers are equal.

getID

static java.util.UUID getID(java.lang.Object obj)

Gets the ID of the object if it is an Identifiable.

Parameters:

obj - Object to get ID for.

Returns:

ID of object if Identifiable instance otherwise return null.

hashCode

static int hashCode(Identifiable obj)

Generates a hashcode for an identifiable.

Parameters:

obj - Identifiable instance.

Returns:

Hashcode for the identifiable or 0 if null.

is

static java.util.function.Predicate<Identifiable> is(Identifiable obj)

Predicate to check if the identifiable is equal to that supplied.

Parameters:

obj - Identifiable to check for.

Returns:

Predicate of true if the identifiable is equal or false if it is not.

See Also:

equals(Identifiable, Object)

not

static java.util.function.Predicate<Identifiable> not(Identifiable obj)

Predicate to check if the identifiable is not equal to that supplied.

Parameters:

obj - Identifiable to check against.

Returns:

Predicate of false if the identifiable is equal or true if it is.

See Also:

getID()

toString

static java.lang.String toString(Identifiable obj)

Creates a simple to string for the identifiable. This is structured like <SIMPLE_CLASS_NAME> [id=X].

Parameters:

obj - Identifiable to create a string representation for.

Returns:

String representation of the identifiable.

getID

java.util.UUID getID()

Gets the unique identifier.

Returns:

This objects identifier.