Enum APIParameterListType

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

    public enum APIParameterListType
    extends java.lang.Enum<APIParameterListType>
    implements java.io.Serializable
    An APIParameterListType defines which parameter list relationship to use when attaching an APIParameterList to an operation.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Return the default description for the key pattern for this enum instance.
      java.lang.String getName()
      Return the default name for this enum instance.
      java.lang.String getOpenTypeRelationshipName()
      Return the Open Metadata Type Name used on the relationship that links the APIParameterList to an APIOperation.
      int getOrdinal()
      Return the code for this enum instance
      java.lang.String toString()
      Standard toString method.
      static APIParameterListType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static APIParameterListType[] 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 APIParameterListType[] 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 (APIParameterListType c : APIParameterListType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static APIParameterListType 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
      • getOrdinal

        public int getOrdinal()
        Return the code for this enum instance
        Returns:
        int key pattern code
      • getName

        public java.lang.String getName()
        Return the default name for this enum instance.
        Returns:
        String default name
      • getDescription

        public java.lang.String getDescription()
        Return the default description for the key pattern for this enum instance.
        Returns:
        String default description
      • getOpenTypeRelationshipName

        public java.lang.String getOpenTypeRelationshipName()
        Return the Open Metadata Type Name used on the relationship that links the APIParameterList to an APIOperation.
        Returns:
        strinng type name
      • toString

        public java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class java.lang.Enum<APIParameterListType>
        Returns:
        print out of variables in a JSON-style