org.assistments.util

Enum IdConversions.EncodingVersions

java.lang.Object

java.lang.Enum<IdConversions.EncodingVersions>

org.assistments.util.IdConversions.EncodingVersions

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IdConversions.EncodingVersions>

Enclosing class:

IdConversions

public static enum IdConversions.EncodingVersions
extends java.lang.Enum<IdConversions.EncodingVersions>

The list of supported encoding format versions. Each version specifies:

• an encoding algorithm (embedded in the IdConversions.encodeContentId(SupportedDataTypes, String, int) method)
• the character set used in the encoding, and
• the characters not used in the encoding

Enum Constant Summary

Enum Constants

Enum Constant and Description
A

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCharSet() Returns the char set used in this format.
static java.lang.String	getCharSet(IdConversions.EncodingVersions encodingVersion) Returns the char set used to encode the specified version.
static java.lang.String	getCharSet(java.lang.String encodingVersion) Returns the supported character set for specified encoding version.
java.lang.String	getInvalidCharSet() Returns the char set not used in this format.
static java.lang.String	getInvalidCharSet(IdConversions.EncodingVersions encodingVersion) Returns the char set not used to encode the specified version.
static java.lang.String	getInvalidCharSet(java.lang.String encodingVersion) Returns the char set not used to encode the specified version.
static IdConversions.EncodingVersions	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IdConversions.EncodingVersions[]	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

A

public static final IdConversions.EncodingVersions A

Method Detail

values

public static IdConversions.EncodingVersions[] 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 (IdConversions.EncodingVersions c : IdConversions.EncodingVersions.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IdConversions.EncodingVersions 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

getCharSet

public java.lang.String getCharSet()

Returns the char set used in this format.

getInvalidCharSet

public java.lang.String getInvalidCharSet()

Returns the char set not used in this format.

getCharSet

public static java.lang.String getCharSet(IdConversions.EncodingVersions encodingVersion)

Returns the char set used to encode the specified version.

Parameters:

encodingVersion - Encoding version

getCharSet

public static java.lang.String getCharSet(java.lang.String encodingVersion)

Returns the supported character set for specified encoding version.

Parameters:

encodingVersion - String representation of the encoding version

Returns:

getInvalidCharSet

public static java.lang.String getInvalidCharSet(IdConversions.EncodingVersions encodingVersion)

Returns the char set not used to encode the specified version.

Parameters:

encodingVersion - Encoding version

getInvalidCharSet

public static java.lang.String getInvalidCharSet(java.lang.String encodingVersion)

Returns the char set not used to encode the specified version.

Parameters:

encodingVersion - String representation of the encoding version