Enum DescriptionKind

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

    public enum DescriptionKind
    extends java.lang.Enum<DescriptionKind>
    The kind attribute defines how a description should be used. Only one description element of each kind can be specified. A description element without a kind DEFAULT is used as a default value.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DEFAULT
      Use this DescriptionKind if the description of the application does not specify a specific usage (Default).
      ONE_LINE
      Use this DescriptionKind if the description of the application is going to appear in one row in a list or a table.
      SHORT
      Use this DescriptionKind if the description of the application is going to be displayed in a situation where there is room for a paragraph.
      TOOLTIP
      Use this DescriptionKind if the description of the application is intended to be used as a tooltip.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String value  
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private DescriptionKind​(java.lang.String value)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static DescriptionKind fromString​(java.lang.String name)
      Creates an enum value from the given string
      java.lang.String getValue()
      The attribute value name as used in the JSR-56 specification or the Parser.
      static DescriptionKind valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static DescriptionKind[] 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, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • ONE_LINE

        public static final DescriptionKind ONE_LINE
        Use this DescriptionKind if the description of the application is going to appear in one row in a list or a table.
      • SHORT

        public static final DescriptionKind SHORT
        Use this DescriptionKind if the description of the application is going to be displayed in a situation where there is room for a paragraph.
      • TOOLTIP

        public static final DescriptionKind TOOLTIP
        Use this DescriptionKind if the description of the application is intended to be used as a tooltip.
      • DEFAULT

        public static final DescriptionKind DEFAULT
        Use this DescriptionKind if the description of the application does not specify a specific usage (Default).
    • Field Detail

      • value

        private final java.lang.String value
    • Constructor Detail

      • DescriptionKind

        private DescriptionKind​(java.lang.String value)
    • Method Detail

      • values

        public static DescriptionKind[] 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 (DescriptionKind c : DescriptionKind.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static DescriptionKind 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
      • getValue

        public java.lang.String getValue()
        The attribute value name as used in the JSR-56 specification or the Parser.
        Returns:
        the attribute value name
      • fromString

        public static DescriptionKind fromString​(java.lang.String name)
                                          throws java.lang.IllegalArgumentException
        Creates an enum value from the given string
        Parameters:
        name - the string name
        Returns:
        an enum value for the given string
        Throws:
        java.lang.IllegalArgumentException - of there is no enum value for the given name