Method Detail

• getFieldName

  @Nonnull
  public java.lang.String getFieldName()

  A field name hinting where this reference was used.

• toJson

  protected java.lang.Object toJson()

• create

  public static <T> Reference<T> create(java.lang.String fieldName)

  Creates a dummy empty reference that serves as a null object to prevent NullPointerExceptions.

  Parameters:

  fieldName - Name of the attribute in the parent object where the reference is used, for better error messages.

• isExpanded

  public boolean isExpanded()

  Checks whether a reference has been expanded. User code should always check for isExpanded before calling get(). This way, the user won't get an exception even if the reference was empty in the parent object.

  Overrides:

  isExpanded in class Reference<T>

• isEmpty

  public boolean isEmpty()

  Description copied from class: Reference
  True if this reference has no value in the parent object. If Reference.isEmpty() returns true, there's not much to do with this reference - Reference.isExpanded() will return false and all other methods will throw a ReferenceException.

  Overrides:

  isEmpty in class Reference<T>

• get

  public T get()
        throws ReferenceException

  Description copied from class: Reference
  Returns the object represented by this reference. If the reference has not been expanded, throws a ReferenceException. Never returns null.

  Overrides:

  get in class Reference<T>

  Throws:

  ReferenceException - If this reference has not been expanded.

• getId

  public java.lang.String getId()
                         throws ReferenceException

  Description copied from class: Reference
  Id of the object this reference represents.

  Overrides:

  getId in class Reference<T>

  Throws:

  ReferenceException

• getTypeId

  public java.lang.String getTypeId()
                             throws ReferenceException

  Description copied from class: Reference
  Type id of the object this reference represents, e.g. "customer".

  Overrides:

  getTypeId in class Reference<T>

  Throws:

  ReferenceException

• equals

  public boolean equals(java.lang.Object o)

  Overrides:

  equals in class Reference<T>

• hashCode

  public int hashCode()

  Overrides:

  hashCode in class Reference<T>

• toString

  public java.lang.String toString()

  Overrides:

  toString in class Reference<T>

• toReferenceIdOrNull

  public ReferenceId<T> toReferenceIdOrNull()

  Overrides:

  toReferenceIdOrNull in class Reference<T>