org.rvpf.metadata.entity

Class EngineEntity

Object

AbstractEntity

MetadataEntity

ParamsEntity

ProxyEntity

EngineEntity

All Implemented Interfaces:

Comparable<Entity>, Entity

public final class EngineEntity
extends ProxyEntity

Engine entity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EngineEntity.Builder Builder.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT_NAME Engine element name.
static String	ENTITY_PREFIX Engine entity prefix.
static String	ENTITY_REFERENCE_NAME Engine reference name.

Fields inherited from interface Entity

UUID_COMPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EngineEntity(Optional<String> name, Optional<UUID> uuid, Optional<KeyedGroups> attributes, Optional<Map<String,Text>> texts, Optional<Params> params, Optional<ClassDefEntity> classDef, Optional<Proxied> instance) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
EngineEntity	copy() Creates a copy of this entity.
boolean	equals(Object other) For two Entity to be equal, they must at least be instances of the same class, have the same UUID and name.
String	getElementName() Gets the entity element name.
Optional<? extends Engine>	getEngine() Gets the Engine instance.
String	getPrefix() Gets the class prefix.
String	getReferenceName() Gets the entity reference name.
int	hashCode()
static EngineEntity.Builder	newBuilder() Returns a new builder.

Methods inherited from class ProxyEntity

clearInstance, createDefaultInstance, getClassDef, getInstance, getProxy, is, is, setInstance, setUp, tearDown

Methods inherited from class ParamsEntity

getParams, setParams

Methods inherited from class MetadataEntity

addText, getAttributes, getAttributes, getTexts, setAttributes

Methods inherited from class AbstractEntity

compareTo, getName, getNameInUpperCase, getThisLogger, getUUID, setName, setUUID, toString

Methods inherited from class Object

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

Field Detail

ELEMENT_NAME

public static final String ELEMENT_NAME

Engine element name.

See Also:

Constant Field Values

ENTITY_PREFIX

public static final String ENTITY_PREFIX

Engine entity prefix.

See Also:

Constant Field Values

ENTITY_REFERENCE_NAME

public static final String ENTITY_REFERENCE_NAME

Engine reference name.

See Also:

Constant Field Values

Constructor Detail

EngineEntity

protected EngineEntity(@Nonnull
                       Optional<String> name,
                       @Nonnull
                       Optional<UUID> uuid,
                       @Nonnull
                       Optional<KeyedGroups> attributes,
                       @Nonnull
                       Optional<Map<String,Text>> texts,
                       @Nonnull
                       Optional<Params> params,
                       @Nonnull
                       Optional<ClassDefEntity> classDef,
                       @Nonnull
                       Optional<Proxied> instance)

Constructs an instance.

Parameters:

name - The optional entity name.

uuid - The optional entity UUID.

attributes - The optional attributes.

texts - The optional texts.

params - The optional params.

classDef - The optional class definition.

instance - The optional proxied instance.

Method Detail

newBuilder

@Nonnull
 @CheckReturnValue
public static EngineEntity.Builder newBuilder()

Returns a new builder.

Returns:

The new builder.

copy

public EngineEntity copy()

Creates a copy of this entity.

Returns:

The copy.

equals

public boolean equals(Object other)

For two Entity to be equal, they must at least be instances of the same class, have the same UUID and name.

For two Metadata Entity to be equal, they must at least be instances of the same class, have the same UUID, Attributes, name and descriptive texts.

Overrides:

equals in class ProxyEntity

getElementName

public String getElementName()

Gets the entity element name.

The entity element is used to in the generation of the entity URI.

Returns:

The entity element name.

getEngine

@Nonnull
 @CheckReturnValue
public Optional<? extends Engine> getEngine()

Gets the Engine instance.

Returns:

The optional Engine instance.

getPrefix

public String getPrefix()

Gets the class prefix.

Each concrete entity subclass has its own prefix which will be the same for all its instances. This prefix is used to avoid name collision between different classes in a common registry.

Returns:

The class prefix.

getReferenceName

public String getReferenceName()

Gets the entity reference name.

Returns:

The entity reference name.

hashCode

public int hashCode()

Overrides:

hashCode in class ProxyEntity