Class PathRef

java.lang.Object
org.nuxeo.ecm.core.api.PathRef
All Implemented Interfaces:
Serializable, DocumentRef

public class PathRef extends Object implements DocumentRef
A PATH reference to a document.
Author:
Bogdan Stefanescu
See Also:
  • Field Details

    • value

      public final String value
  • Constructor Details

    • PathRef

      public PathRef(String parentPath, String name)
    • PathRef

      public PathRef(String path)
    • PathRef

      public PathRef(PathRef parentRef, String name)
      Since:
      5.6
  • Method Details

    • checkName

      public static void checkName(String name)
    • 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 Object reference()
      Description copied from interface: DocumentRef
      Gets the reference value.

      For an ID reference, this is the document UUID.

      For a PATH 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
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object