Package org.apache.james.mime4j.codec
Enum EncoderUtil.Usage
- java.lang.Object
-
- java.lang.Enum<EncoderUtil.Usage>
-
- org.apache.james.mime4j.codec.EncoderUtil.Usage
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<EncoderUtil.Usage>
- Enclosing class:
- EncoderUtil
public static enum EncoderUtil.Usage extends java.lang.Enum<EncoderUtil.Usage>
Indicates the intended usage of an encoded word.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description TEXT_TOKEN
Encoded word is used to replace a 'text' token in any Subject or Comments header field.WORD_ENTITY
Encoded word is used to replace a 'word' entity within a 'phrase', for example, one that precedes an address in a From, To, or Cc header.
-
Constructor Summary
Constructors Modifier Constructor Description private
Usage()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static EncoderUtil.Usage
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static EncoderUtil.Usage[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
TEXT_TOKEN
public static final EncoderUtil.Usage TEXT_TOKEN
Encoded word is used to replace a 'text' token in any Subject or Comments header field.
-
WORD_ENTITY
public static final EncoderUtil.Usage WORD_ENTITY
Encoded word is used to replace a 'word' entity within a 'phrase', for example, one that precedes an address in a From, To, or Cc header.
-
-
Method Detail
-
values
public static EncoderUtil.Usage[] 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 (EncoderUtil.Usage c : EncoderUtil.Usage.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static EncoderUtil.Usage 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 namejava.lang.NullPointerException
- if the argument is null
-
-