Package com.iizigo.vs

Class VSConnection

  • public class VSConnection
extends java.lang.Object
    Class used to create connection to a VS field.
    Author:
    Christopher Mindus

    • Constructor Summary

      Constructors 
      ConstructorDescription
      VSConnection​(PropCnr masterParent, PropCnr property, java.lang.String vsBaseReference)
      Creates the connection.
      VSConnection​(PropCnr masterParent, PropCnr property, java.lang.String vsBaseReference, java.lang.String suggestedName)
      Creates the connection.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.StringgetName()
      Gets the VS field name.
      voidsetName​(java.lang.String name)
      Assigns the relative reference name.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • masterParent

        public final PropCnr masterParent
        The master parent.

      • property

        public final PropCnr property
        The property to connect to a VS field.

      • suggestedName

        public final java.lang.String suggestedName
        The suggested name.

      • vsBaseReference

        public final java.lang.String vsBaseReference
        The base reference to the VS (base property container must exist).

    • Constructor Detail

      • VSConnection

        public VSConnection​(PropCnr masterParent,
                    PropCnr property,
                    java.lang.String vsBaseReference)
        Creates the connection.
        Parameters:
        masterParent - The "master" parent, i.e. maybe not the direct parent.
        property - The property.
        vsBaseReference - The base reference to the VS (base property container must exist).

      • VSConnection

        public VSConnection​(PropCnr masterParent,
                    PropCnr property,
                    java.lang.String vsBaseReference,
                    java.lang.String suggestedName)
        Creates the connection.
        Parameters:
        masterParent - The "master" parent, i.e. maybe not the direct parent.
        property - The property.
        vsBaseReference - The base reference to the VS (base property container must exist).
        suggestedName - The suggested name, or null to use the property name.

    • Method Detail

      • setName

        public void setName​(java.lang.String name)
        Assigns the relative reference name.
        Parameters:
        name - The VS Field reference.

      • getName

        public java.lang.String getName()
        Gets the VS field name.
        Returns:
        The VS field name.