Package com.gengoai.io

Enum CommonBOM

java.lang.Object

java.lang.Enum<CommonBOM>

com.gengoai.io.CommonBOM

All Implemented Interfaces:

Serializable, Comparable<CommonBOM>

public enum CommonBOM
extends Enum<CommonBOM>

Enumeration of common Unicode Byte Order Marks

Author:

David B. Bracewell

Enum Constant Summary

Enum Constants

Enum Constant	Description
UTF_16BE	The UTF_16BE BOM.
UTF_16LE	The UTF_16LE BOM.
UTF_32BE	The UTF_32BE BOM.
UTF_32LE	The UTF_32LE BOM.
UTF_8	The UTF_8 BOM

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_BOM_SIZE	The constant MAX_BOM_SIZE.

Method Summary

Modifier and Type	Method	Description
Charset	getCharset()	The charset associated with the bom
int	length()	The number of byhtes in the bom
boolean	matches(byte[] rhs)	Determines if the BOM is at the beginning of a given byte array.
static CommonBOM	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CommonBOM[]	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 CommonBOM UTF_8

The UTF_8 BOM

UTF_16BE

public static final CommonBOM UTF_16BE

The UTF_16BE BOM.

UTF_16LE

public static final CommonBOM UTF_16LE

The UTF_16LE BOM.

UTF_32BE

public static final CommonBOM UTF_32BE

The UTF_32BE BOM.

UTF_32LE

public static final CommonBOM UTF_32LE

The UTF_32LE BOM.

Field Detail

MAX_BOM_SIZE

public static final int MAX_BOM_SIZE

The constant MAX_BOM_SIZE.

Method Detail

values

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

Returns:

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

valueOf

public static CommonBOM 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

length

public int length()

The number of byhtes in the bom

Returns:

The BOM length

getCharset

public Charset getCharset()

The charset associated with the bom

Returns:

The associated Charset

matches

public boolean matches(byte[] rhs)

Determines if the BOM is at the beginning of a given byte array.

Parameters:

rhs - The byte array to compare against

Returns:

True if the BOM is present, false otherwise