Enum AcknowledgeType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<AcknowledgeType>

    public enum AcknowledgeType
    extends java.lang.Enum<AcknowledgeType>
    Convenience class to determine what sort of notices to include in a query.
    Since:
    1.8.1
    Version:
    $Id: $
    Author:
    ranger
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static AcknowledgeType getAcknowledgeType​(java.lang.String ackTypeString)
      getAcknowledgeType
      protected java.lang.String getAcknowledgeTypeClause()
      Convenience method for getting the SQL ORDER BY clause related this sort style.
      java.lang.String getName()
      getName
      java.lang.String getShortName()
      getShortName
      java.lang.String toString()
      toString
      static AcknowledgeType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static AcknowledgeType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Method Detail

      • values

        public static AcknowledgeType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (AcknowledgeType c : AcknowledgeType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static AcknowledgeType valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • toString

        public java.lang.String toString()

        toString

        Overrides:
        toString in class java.lang.Enum<AcknowledgeType>
        Returns:
        a String object.
      • getName

        public java.lang.String getName()

        getName

        Returns:
        a String object.
      • getShortName

        public java.lang.String getShortName()

        getShortName

        Returns:
        a String object.
      • getAcknowledgeTypeClause

        protected java.lang.String getAcknowledgeTypeClause()
        Convenience method for getting the SQL ORDER BY clause related this sort style.
        Returns:
        a String object.
      • getAcknowledgeType

        public static AcknowledgeType getAcknowledgeType​(java.lang.String ackTypeString)

        getAcknowledgeType

        Parameters:
        ackTypeString - a String object.
        Returns:
        a AcknowledgeType object.