org.rvpf.metadata.entity

Class PointInput

Object

PointInput

All Implemented Interfaces:

PointRelation

@NotThreadSafe
public final class PointInput
extends Object
implements PointRelation

Point input.

Constructor Summary

Constructors

Constructor and Description
PointInput(PointEntity inputPoint, PointEntity resultPoint) Creates an instance.
PointInput(PointInput original) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
void	addBehaviorEntity(BehaviorEntity behaviorEntity) Adds a behavior entity to this relation.
boolean	equals(Object other)
Point	getInputPoint() Gets the input point definition.
PointEntity	getInputPointEntity() Gets the input point entity.
Params	getParams() Gets the params.
Optional<Behavior>	getPrimaryBehavior() Gets the primary behavior.
Point	getResultPoint() Gets the result point definition.
PointEntity	getResultPointEntity() Gets the result point entity.
Optional<Sync>	getSync() Gets a sync object for this.
Optional<SyncEntity>	getSyncEntity() Gets the sync entity.
int	hashCode()
boolean	isControl() Asks if this is a control input.
void	setControl(boolean control) Sets the control input indicator.
void	setInputPoint(Point point) Sets a new input point.
void	setParams(Optional<Params> params) Sets the params.
void	setResultPoint(Point point) Sets a new result point.
void	setSyncEntity(Optional<SyncEntity> syncEntity) Sets the sync entity.
boolean	setUp(Metadata metadata, Optional<TransformEntity.Arg> arg) Sets up this.
void	tearDown() Tears down what has been set up.

Methods inherited from class Object

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

Constructor Detail

PointInput

public PointInput(@Nonnull
                  PointInput original)

Constructs an instance.

Parameters:

original - The original point input.

PointInput

public PointInput(@Nonnull
                  PointEntity inputPoint,
                  @Nonnull
                  PointEntity resultPoint)

Creates an instance.

Parameters:

inputPoint - The point entity providing inputs.

resultPoint - The point entity holding results.

Method Detail

addBehaviorEntity

public void addBehaviorEntity(@Nonnull
                              BehaviorEntity behaviorEntity)

Adds a behavior entity to this relation.

Parameters:

behaviorEntity - The behavior entity.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

getInputPoint

public Point getInputPoint()

Gets the input point definition.

Specified by:

getInputPoint in interface PointRelation

Returns:

The input point definition.

getInputPointEntity

@Nonnull
 @CheckReturnValue
public PointEntity getInputPointEntity()

Gets the input point entity.

Returns:

The input point entity.

getParams

public Params getParams()

Gets the params.

Specified by:

getParams in interface PointRelation

Returns:

The params.

getPrimaryBehavior

@Nonnull
 @CheckReturnValue
public Optional<Behavior> getPrimaryBehavior()

Gets the primary behavior.

Returns:

The optional primary behavior.

getResultPoint

public Point getResultPoint()

Gets the result point definition.

Specified by:

getResultPoint in interface PointRelation

Returns:

The result point definition.

getResultPointEntity

@Nonnull
 @CheckReturnValue
public PointEntity getResultPointEntity()

Gets the result point entity.

Returns:

The result point entity.

getSync

public Optional<Sync> getSync()

Gets a sync object for this.

Specified by:

getSync in interface PointRelation

Returns:

The optional sync object.

getSyncEntity

@Nonnull
 @CheckReturnValue
public Optional<SyncEntity> getSyncEntity()

Gets the sync entity.

Returns:

The optional sync entity.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isControl

@CheckReturnValue
public boolean isControl()

Asks if this is a control input.

Returns:

True if it is a control input.

setControl

public void setControl(boolean control)

Sets the control input indicator.

Parameters:

control - The control input indicator.

setInputPoint

public void setInputPoint(@Nonnull
                          Point point)

Sets a new input point.

Parameters:

point - The new input point.

setParams

public void setParams(@Nonnull
                      Optional<Params> params)

Sets the params.

Parameters:

params - The optional params.

setResultPoint

public void setResultPoint(@Nonnull
                           Point point)

Sets a new result point.

Parameters:

point - The new result point.

setSyncEntity

public void setSyncEntity(@Nonnull
                          Optional<SyncEntity> syncEntity)

Sets the sync entity.

Parameters:

syncEntity - The optional sync entity.

setUp

@CheckReturnValue
public boolean setUp(@Nonnull
                                        Metadata metadata,
                                        @Nonnull
                                        Optional<TransformEntity.Arg> arg)

Sets up this.

Parameters:

metadata - The metadata.

arg - The optional corresponding transform argument.

Returns:

True on success.

tearDown

public void tearDown()

Tears down what has been set up.