com.spss.psapi

Class Enum

  • java.lang.Object
    • com.spss.psapi.Enum
    • Constructor Summary

      Constructors 
      Modifier Constructor and Description
      protected Enum(java.lang.String name, java.util.Map enumMap)
      A constructor for the enumeration.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      boolean equals(java.lang.Object object)
      Returns true if the supplied object is equal to this object.
      protected static Enum getEnum(java.lang.String name, java.util.Map enumMap)
      Returns the Enum with the supplied name or null if no such enum exists.
      java.lang.String getName()
      Returns the name of the enumeration.
      int hashCode()
      Returns the hash code for this object.
      boolean isUnknown()
      Returns true if this enumeration value represents an unknown or undefined object or false otherwise.
      protected static void putEnum(java.lang.String name, Enum enumValue, java.util.Map enumMap)
      Puts the supplied enum in the map.
      java.lang.String toString()
      Returns the name of the enumeration.
      • Methods inherited from class java.lang.Object

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

      • Enum

        protected Enum(java.lang.String name,
            java.util.Map enumMap)
        A constructor for the enumeration.
        Parameters:
        name - the enum name
        enumMap - the map of enumeration values
    • Method Detail

      • putEnum

        protected static void putEnum(java.lang.String name,
                   Enum enumValue,
                   java.util.Map enumMap)
        Puts the supplied enum in the map.
        Parameters:
        name - the enum name
        enumValue - the value to be added
        enumMap - the map containing the existing enum values
        Throws:
        java.lang.IllegalArgumentException - if the map already contains an entry with the specified name
      • getEnum

        protected static Enum getEnum(java.lang.String name,
                   java.util.Map enumMap)
        Returns the Enum with the supplied name or null if no such enum exists.
        Parameters:
        name -
        enumMap -
        Returns:
        the Enum with the supplied name or null
      • getName

        public java.lang.String getName()
        Returns the name of the enumeration. Same as toString().
        Returns:
        the name of the enumeration
        See Also:
        toString()
      • toString

        public java.lang.String toString()
        Returns the name of the enumeration. Same as getName().
        Overrides:
        toString in class java.lang.Object
        Returns:
        the name of the enumeration
        See Also:
        getName()
      • equals

        public boolean equals(java.lang.Object object)
        Returns true if the supplied object is equal to this object.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        object - the other object
        Returns:
        true if the supplied object is equal to this object
      • hashCode

        public int hashCode()
        Returns the hash code for this object.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        the hash code
      • isUnknown

        public boolean isUnknown()
        Returns true if this enumeration value represents an unknown or undefined object or false otherwise. An enumeration may contain at most one value that represents an unknown or undefined value.
        Returns:
        true if this enumeration value represents an unknown object

Copyright © 2014 Integral Solutions Ltd. All Rights Reserved.