Class ValidValueProperties

  • All Implemented Interfaces:
    java.io.Serializable

    public class ValidValueProperties
    extends ReferenceableProperties
    ValidValueProperties provides the common super class for ValidValueSet and ValidValueDefinition.
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      java.lang.String getDescription()
      Returns the stored description property for the valid value.
      java.lang.String getDisplayName()
      Returns the stored display name property for the valid value.
      boolean getIsDeprecated()
      Is the valid value deprecated?
      java.lang.String getPreferredValue()
      Return the preferred values to use in implementations (normally used with definitions)
      java.lang.String getScope()
      Return the scope of values that this valid value covers (normally used with sets)
      java.lang.String getUsage()
      Return the description of how this valid value should be used.
      int hashCode()
      Return hash code based on properties.
      void setDescription​(java.lang.String description)
      Set up the stored description property associated with the valid value.
      void setDisplayName​(java.lang.String displayName)
      Set up the stored display name property for the valid value.
      void setIsDeprecated​(boolean deprecated)
      Set whether the valid value is deprecated or not.
      void setPreferredValue​(java.lang.String preferredValue)
      Set up the preferred values to use in implementations (normally used with definitions)
      void setScope​(java.lang.String scope)
      Set up the scope of values that this valid value covers (normally used with sets)
      void setUsage​(java.lang.String usage)
      Set up the description of how this valid value should be used.
      java.lang.String toString()
      Generate a string containing the properties.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ValidValueProperties

        public ValidValueProperties()
        Constructor
      • ValidValueProperties

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

      • getDisplayName

        public java.lang.String getDisplayName()
        Returns the stored display name property for the valid value. If no display name is available then null is returned.
        Returns:
        String name
      • setDisplayName

        public void setDisplayName​(java.lang.String displayName)
        Set up the stored display name property for the valid value.
        Parameters:
        displayName - String name
      • getDescription

        public java.lang.String getDescription()
        Returns the stored description property for the valid value. If no description is provided then null is returned.
        Returns:
        description String text
      • setDescription

        public void setDescription​(java.lang.String description)
        Set up the stored description property associated with the valid value.
        Parameters:
        description - String text
      • getUsage

        public java.lang.String getUsage()
        Return the description of how this valid value should be used.
        Returns:
        String text
      • setUsage

        public void setUsage​(java.lang.String usage)
        Set up the description of how this valid value should be used.
        Parameters:
        usage - String text
      • getScope

        public java.lang.String getScope()
        Return the scope of values that this valid value covers (normally used with sets)
        Returns:
        String text
      • setScope

        public void setScope​(java.lang.String scope)
        Set up the scope of values that this valid value covers (normally used with sets)
        Parameters:
        scope - String text
      • getPreferredValue

        public java.lang.String getPreferredValue()
        Return the preferred values to use in implementations (normally used with definitions)
        Returns:
        String value
      • setPreferredValue

        public void setPreferredValue​(java.lang.String preferredValue)
        Set up the preferred values to use in implementations (normally used with definitions)
        Parameters:
        preferredValue - String value
      • getIsDeprecated

        public boolean getIsDeprecated()
        Is the valid value deprecated?
        Returns:
        boolean flag
      • setIsDeprecated

        public void setIsDeprecated​(boolean deprecated)
        Set whether the valid value is deprecated or not. Default is false.
        Parameters:
        deprecated - boolean flag
      • toString

        public java.lang.String toString()
        Generate a string containing the properties.
        Overrides:
        toString in class ReferenceableProperties
        Returns:
        string value
      • 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