Class Reference


  • public class Reference
    extends java.lang.Object
    Class holding information about a reference.
    Author:
    Christopher Mindus
    • Field Summary

      Fields 
      Modifier and TypeFieldDescription
      GProp<?>owner
      The reference owner.
      GProp<?>target
      The reference target.
      java.lang.Class<?>type
      The reference type in form of a class.
    • Constructor Summary

      Constructors 
      ConstructorDescription
      Reference​(GProp<?> target, GProp<?> owner, java.lang.Class<?> type)
      Creates the reference instance.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.StringtoString()
      Returns a string representation of this class.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • target

        public final GProp<?> target
        The reference target.

        This member is never null.

      • owner

        public final GProp<?> owner
        The reference owner. The owner is generally retargeted from the reference property to its parent that is the actual owner of the reference. An exception to this is KString that retargets to the parent only when the parent is not a TextTable.

        This member is never null.

      • type

        public final java.lang.Class<?> type
        The reference type in form of a class.

        The classes should be something like:

        • KString (for all out- and in-bound references for KString's and KStringProps [including VS and TextTable]),
        • IUILabelForTarget (UI label-for),
        • UIPanelPart
        • VSComponent or VS-specific class,
        • IVSParticipant,
        • FileURIPropCnr (for Asset references),
        • Styles.

        The type (class) is used to verify for circular references.

        This member is never null.

    • Constructor Detail

      • Reference

        public Reference​(GProp<?> target,
                         GProp<?> owner,
                         java.lang.Class<?> type)
        Creates the reference instance.
        Parameters:
        target - The reference target.
        owner - The owner of the reference.
        type - The type.
        Throws:
        java.lang.NullPointerException - If any of the parameters are null.
    • Method Detail

      • toString

        public java.lang.String toString()
        Returns a string representation of this class.
        Overrides:
        toString in class java.lang.Object