public final class TransformEntity extends ProxyEntity
Instances of this class act as proxy for objects implementing the
Transform
interface.
Modifier and Type | Class and Description |
---|---|
static class |
TransformEntity.Arg
Transform arg.
|
static class |
TransformEntity.Builder
Transform entity builder.
|
Modifier and Type | Field and Description |
---|---|
static String |
ELEMENT_NAME
Transform element name.
|
static String |
ENTITY_PREFIX
Transform entity prefix.
|
static String |
ENTITY_REFERENCE_NAME
Transform entity reference name.
|
UUID_COMPARATOR
Modifier | Constructor and Description |
---|---|
protected |
TransformEntity(Optional<String> name,
Optional<UUID> uuid,
Optional<KeyedGroups> attributes,
Optional<Map<String,Text>> texts,
Optional<Params> params,
Optional<ClassDefEntity> classDef,
Optional<Proxied> instance,
Optional<EngineEntity> engineEntity,
List<TransformEntity.Arg> args)
Constructs an instance.
|
Modifier and Type | Method and Description |
---|---|
TransformEntity |
copy()
Creates a copy of this entity.
|
boolean |
equals(Object other)
|
List<TransformEntity.Arg> |
getArgs()
Gets the arguments (signature).
|
Optional<BehaviorEntity> |
getDefaultBehavior(PointRelation relation)
Gets the default (primary) behavior.
|
String |
getElementName()
Gets the entity element name.
|
Optional<EngineEntity> |
getEngineEntity()
Gets the engine entity.
|
String |
getPrefix()
Gets the class prefix.
|
String |
getReferenceName()
Gets the entity reference name.
|
Transform |
getTransform()
Gets the actual transform instance, as generated by the engine.
|
int |
hashCode() |
static TransformEntity.Builder |
newBuilder()
Returns a new builder.
|
boolean |
setUp(Metadata metadata)
Sets up this transform.
|
void |
tearDown()
Tears down what has been set up.
|
clearInstance, createDefaultInstance, getClassDef, getInstance, getProxy, is, is, setInstance
getParams, setParams
addText, getAttributes, getAttributes, getTexts, setAttributes
compareTo, getName, getNameInUpperCase, getThisLogger, getUUID, setName, setUUID, toString
public static final String ELEMENT_NAME
public static final String ENTITY_PREFIX
public static final String ENTITY_REFERENCE_NAME
protected TransformEntity(@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, @Nonnull Optional<EngineEntity> engineEntity, @Nonnull List<TransformEntity.Arg> args)
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.engineEntity
- The engine entity.args
- The arguments (signature).@Nonnull @CheckReturnValue public static TransformEntity.Builder newBuilder()
public TransformEntity copy()
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.
equals
in class ProxyEntity
@Nonnull @CheckReturnValue public List<TransformEntity.Arg> getArgs()
TransformEntity.Arg
.@Nonnull @CheckReturnValue public Optional<BehaviorEntity> getDefaultBehavior(PointRelation relation)
relation
- The relation needing a primary behavior.public String getElementName()
The entity element is used to in the generation of the entity URI.
@Nonnull @CheckReturnValue public Optional<EngineEntity> getEngineEntity()
public String getPrefix()
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.
public String getReferenceName()
@Nullable @CheckReturnValue public Transform getTransform()
public int hashCode()
hashCode
in class ProxyEntity
public boolean setUp(Metadata metadata)
This means making sure that its engine is ready for action.
setUp
in class ProxyEntity
metadata
- The metadata.public void tearDown()
tearDown
in class ProxyEntity
Copyright © 2003-2019 Serge Brisson. All Rights Reserved.