Class NameValue

  • Direct Known Subclasses:
    ExternalEntityNameValue

    @API(type=EXTENDABLE,
         src=PRIVATE)
    public class NameValue
    extends java.lang.Object
    A pair class with name and value.
    • Constructor Summary

      Constructors 
      Constructor Description
      NameValue​(java.lang.String name, java.lang.String value)
      Constructor.
      NameValue​(java.lang.String name, java.lang.String value, java.lang.String documentation)
      Constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object other)
      Verifies if two objects are equals
      java.lang.String getDocumentation()
      Gets the documentation.
      java.lang.String getName()
      Gets the name.
      java.lang.String getValue()
      Gets the value.
      int hashCode()  
      void setDocumentation​(java.lang.String documentation)  
      java.lang.String toString()
      Returns the name and value formated as n: name v: value
      • Methods inherited from class java.lang.Object

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

      • NameValue

        public NameValue​(java.lang.String name,
                         java.lang.String value)
        Constructor.
        Parameters:
        name - The name.
        value - The value.
      • NameValue

        public NameValue​(java.lang.String name,
                         java.lang.String value,
                         java.lang.String documentation)
        Constructor.
        Parameters:
        name - The name.
        value - The value.
        documentation - The documentation.
    • Method Detail

      • getName

        public java.lang.String getName()
        Gets the name.
        Returns:
        The name.
      • getValue

        public java.lang.String getValue()
        Gets the value.
        Returns:
        The value.
      • getDocumentation

        public java.lang.String getDocumentation()
        Gets the documentation.
        Returns:
        The documentation.
      • toString

        public java.lang.String toString()
        Returns the name and value formated as n: name v: value
        Overrides:
        toString in class java.lang.Object
        Returns:
        the name and value of the NameValue object.
      • equals

        public boolean equals​(java.lang.Object other)
        Verifies if two objects are equals
        Overrides:
        equals in class java.lang.Object
        Parameters:
        other - The object to compare to.
        Returns:
        True if the two object have the same name and value. False otherwise.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
        See Also:
        Object.hashCode()
      • setDocumentation

        public void setDocumentation​(java.lang.String documentation)
        Parameters:
        documentation - The documentation to set.