org.nuxeo.ecm.core.api
Class IdRef

java.lang.Object
  org.nuxeo.ecm.core.api.IdRef

All Implemented Interfaces:

java.io.Serializable, DocumentRef

public class IdRef
extends java.lang.Object
implements DocumentRef

An ID reference to a document.

Author:

Bogdan Stefanescu

See Also:

Serialized Form

Field Summary

java.lang.String

value

Fields inherited from interface org.nuxeo.ecm.core.api.DocumentRef

ID, PATH

Constructor Summary

IdRef(java.lang.String value)

Method Summary

boolean	equals(java.lang.Object obj)
int	hashCode()
java.lang.Object	reference() Gets the reference value.
java.lang.String	toString()
int	type() Gets the type of the reference.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

value

public final java.lang.String value

Constructor Detail

IdRef

public IdRef(java.lang.String value)

Method Detail

type

public int type()

Description copied from interface: DocumentRef

Gets the type of the reference.

Specified by:

type in interface DocumentRef

Returns:

the type of the reference

reference

public java.lang.Object reference()

Description copied from interface: DocumentRef

Gets the reference value.

For an ID reference, this is the document UUID.

For an ID reference, this is the document path.

For an INSTANCE reference this is the document itself.

Specified by:

reference in interface DocumentRef

Returns:

the reference value

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object