Module org.refcodes.data

Package org.refcodes.data

Enum Encoding

java.lang.Object

java.lang.Enum<Encoding>

org.refcodes.data.Encoding

All Implemented Interfaces:

Serializable, Comparable<String>, org.refcodes.mixin.CodeAccessor<String>

public enum Encoding
extends Enum<Encoding>
implements org.refcodes.mixin.CodeAccessor<String>

The Encoding define values representing an encoding which are to be passed as argument to according methods.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.CodeAccessor

org.refcodes.mixin.CodeAccessor.CodeBuilder<T extends Object,B extends org.refcodes.mixin.CodeAccessor.CodeBuilder<T,B>>, org.refcodes.mixin.CodeAccessor.CodeMutator<T extends Object>, org.refcodes.mixin.CodeAccessor.CodeProperty<T extends Object>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ISO_8859_1	This encoding is especially useful when having to ensure a 1-to-1 mapping between bytes and characters.
MD5	MD5 hash encoding.
UTF_8	Encoding identifying UTF-8 when working with String objects.

Method Summary

Modifier and Type	Method	Description
String	getCode()
static Encoding	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Encoding[]	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

UTF_8

public static final Encoding UTF_8

Encoding identifying UTF-8 when working with String objects.

ISO_8859_1

public static final Encoding ISO_8859_1

This encoding is especially useful when having to ensure a 1-to-1 mapping between bytes and characters.

MD5

public static final Encoding MD5

MD5 hash encoding.

Method Detail

values

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

Returns:

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

valueOf

public static Encoding valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getCode

public String getCode()

Specified by:

getCode in interface org.refcodes.mixin.CodeAccessor<String>