org.rvpf.metadata.entity

Class ProxyEntity

Object

AbstractEntity

MetadataEntity

ParamsEntity

ProxyEntity

All Implemented Interfaces:

Comparable<Entity>, Entity

Direct Known Subclasses:

BehaviorEntity, ContentEntity, EngineEntity, StoreEntity, TransformEntity

public abstract class ProxyEntity
extends ParamsEntity

Proxy entity.

Each instance of a subclass keeps a reference to an implementation of the interface associated with the type of entity that it represents.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from interface Entity

UUID_COMPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProxyEntity(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
void	clearInstance() Clears the proxied instance.
protected Proxied	createDefaultInstance() Creates a default instance.
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.
Optional<ClassDefEntity>	getClassDef() Gets the class definition.
protected Optional<? extends Proxied>	getInstance() Gets the proxied instance.
ProxyEntity	getProxy(Proxied instance) Gets a proxy for the supplied instance.
int	hashCode()
boolean	is(Class<?> classObject) Asks if the proxied entity implements an interface.
boolean	is(String className) Asks if the proxied entity implements an interface.
void	setInstance(Proxied instance) Sets the proxied instance.
boolean	setUp(Metadata metadata) Sets up the proxied object.
void	tearDown() Tears down what has been set up.

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

Methods inherited from interface Entity

copy, getElementName, getPrefix, getReferenceName

Constructor Detail

ProxyEntity

protected ProxyEntity(@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

clearInstance

public final void clearInstance()

Clears the proxied instance.

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 ParamsEntity

getClassDef

@Nonnull
 @CheckReturnValue
public final Optional<ClassDefEntity> getClassDef()

Gets the class definition.

Returns:

The optional class definition.

getProxy

@Nonnull
 @CheckReturnValue
public final ProxyEntity getProxy(@Nonnull
                                                                Proxied instance)

Gets a proxy for the supplied instance.

Parameters:

instance - The instance to be proxied.

Returns:

The proxy.

hashCode

public int hashCode()

Overrides:

hashCode in class ParamsEntity

is

@CheckReturnValue
public final boolean is(Class<?> classObject)
                                    throws UndefinedEntityException

Asks if the proxied entity implements an interface.

Parameters:

classObject - A class object.

Returns:

True if the interface is implemented.

Throws:

UndefinedEntityException - When the interface is undefined.

is

@CheckReturnValue
public final boolean is(String className)
                                    throws UndefinedEntityException

Asks if the proxied entity implements an interface.

Parameters:

className - The name of the class or interface.

Returns:

True if the interface is implemented.

Throws:

UndefinedEntityException - When the interface is undefined.

setInstance

public final void setInstance(@Nonnull
                              Proxied instance)

Sets the proxied instance.

Parameters:

instance - The proxied instance.

setUp

@CheckReturnValue
public boolean setUp(@Nonnull
                                        Metadata metadata)

Sets up the proxied object.

Note: this method must be prepared to be called redundantly. Such calls happen during the normal setup of the points in a processor.

Parameters:

metadata - The metadata.

Returns:

True if successful.

tearDown

public void tearDown()

Tears down what has been set up.

createDefaultInstance

@Nonnull
 @CheckReturnValue
protected Proxied createDefaultInstance()

Creates a default instance.

This must be overriden by the subclass when the 'classDef' attribute is optional; otherwise, it will always fail.

Returns:

A new instance or fails.

getInstance

@Nonnull
 @CheckReturnValue
protected final Optional<? extends Proxied> getInstance()

Gets the proxied instance.

Returns:

The optional proxied instance.