Package de.xima.fc.workflow

Class ObjectReferenceDescriptor

java.lang.Object

de.xima.fc.workflow.ObjectReferenceDescriptor

All Implemented Interfaces:

IObjectReferenceDescriptor, Serializable

public final class ObjectReferenceDescriptor
extends Object
implements IObjectReferenceDescriptor

POJO implementation of IObjectReferenceDescriptor.

Since:

8.5.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ObjectReferenceDescriptor(Serializable key, IObjectReference reference)	Creates a new POJO instance with the given data.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Serializable	getPath()	Returns the object identifying the location or path of the object reference.
IObjectReference	getReference()	Returns the reference to an object in the properties at the given path.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectReferenceDescriptor

public ObjectReferenceDescriptor(Serializable key,
                                 IObjectReference reference)

Creates a new POJO instance with the given data.

Parameters:

key - The key or path to the reference.

reference - The reference.

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getPath

public Serializable getPath()

Description copied from interface: IObjectReferenceDescriptor

Returns the object identifying the location or path of the object reference. You may use any serializable object you wish. It is guaranteed that the path you return from readObjectReferences is the same path that will be passed to writeObjectReferences later. You can then use this path to write back the object to the properties model. For example, you may choose to use simple string names; or JSON paths if your properties model contains lists or maps.

Specified by:

getPath in interface IObjectReferenceDescriptor

Returns:

The path identifying the location of the object reference.

getReference

public IObjectReference getReference()

Description copied from interface: IObjectReferenceDescriptor

Returns the reference to an object in the properties at the given path. Usually this is the ID of the object that can be used to identify it.

Specified by:

getReference in interface IObjectReferenceDescriptor

Returns:

The reference to the object at the path.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object