Package org.odpi.openmetadata.frameworks.governanceaction.properties

Class OpenMetadataEnumElementDef

java.lang.Object
org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataTypeDefElementHeader
org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataEnumElementDef
public class OpenMetadataEnumElementDef extends OpenMetadataTypeDefElementHeader
OpenMetadataEnumElementDef describes a single valid value defined for an enum.

  • Constructor Details

    • OpenMetadataEnumElementDef

      public OpenMetadataEnumElementDef()
      Default constructor sets up an empty OpenMetadataEnumElementDef

    • OpenMetadataEnumElementDef

      public OpenMetadataEnumElementDef(OpenMetadataEnumElementDef template)
      Copy/clone constructor sets up an OpenMetadataEnumElementDef based on the values supplied in the template.
      Parameters:
      template - OpenMetadataEnumElementDef

  • Method Details

    • getOrdinal

      public int getOrdinal()
      Return the numeric value used for the enum value.
      Returns:
      int ordinal

    • setOrdinal

      public void setOrdinal(int ordinal)
      Set up the numeric value for the enum value.
      Parameters:
      ordinal - int

    • getValue

      public String getValue()
      Return the symbolic name for the enum value.
      Returns:
      String name

    • setValue

      public void setValue(String value)
      Set up the symbolic name for the enum value.
      Parameters:
      value - String name

    • getDescription

      public String getDescription()
      Return the description for the enum value.
      Returns:
      String description

    • setDescription

      public void setDescription(String description)
      Set up the description for the enum value.
      Parameters:
      description - String

    • getDescriptionGUID

      public String getDescriptionGUID()
      Return the unique identifier (guid) of the glossary term that describes this OpenMetadataEnumElementDef.
      Returns:
      String guid

    • setDescriptionGUID

      public void setDescriptionGUID(String descriptionGUID)
      Set up the unique identifier (guid) of the glossary term that describes this OpenMetadataEnumElementDef.
      Parameters:
      descriptionGUID - String guid

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Object
      Returns:
      JSON style description of variables.

    • equals

      public boolean equals(Object objectToCompare)
      Validate that an object is equal depending on their stored values.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - object
      Returns:
      boolean result

    • hashCode

      public int hashCode()
      Return a hash code based on the values of this object.
      Overrides:
      hashCode in class Object
      Returns:
      in hash code