Class LocationProperties

  • All Implemented Interfaces:
    java.io.Serializable

    public class LocationProperties
    extends ReferenceableProperties
    LocationProperties is a class for representing a physical or digital location.
    See Also:
    Serialized Form
    • Constructor Detail

      • LocationProperties

        public LocationProperties()
        Default constructor
      • LocationProperties

        public LocationProperties​(LocationProperties template)
        Copy/clone constructor.
        Parameters:
        template - object to copy
    • Method Detail

      • getDisplayName

        public java.lang.String getDisplayName()
        Return a human memorable name for the location.
        Returns:
        string name
      • setDisplayName

        public void setDisplayName​(java.lang.String displayName)
        Set up a human memorable name for the location.
        Parameters:
        displayName - string name
      • getDescription

        public java.lang.String getDescription()
        Return the description of the location.
        Returns:
        string text
      • setDescription

        public void setDescription​(java.lang.String description)
        Set up the description of the location.
        Parameters:
        description - string text
      • toString

        public java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class ReferenceableProperties
        Returns:
        print out of variables in a JSON-style
      • equals

        public boolean equals​(java.lang.Object objectToCompare)
        Compare the values of the supplied object with those stored in the current object.
        Overrides:
        equals in class ReferenceableProperties
        Parameters:
        objectToCompare - supplied object
        Returns:
        boolean result of comparison