Package org.dellroad.stuff.io

Enum Class BOM

java.lang.Object

java.lang.Enum<BOM>

org.dellroad.stuff.io.BOM

All Implemented Interfaces:

Serializable, Comparable<BOM>, Constable

public enum BOM
extends Enum<BOM>

Catalog of common byte order marks.

See Also:

• Byte order mark

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GB18030
UTF_16BE
UTF_16LE
UTF_32BE
UTF_32LE
UTF_8

Method Summary

Modifier and Type	Method	Description
Charset	getCharset()	Get the character encoding that this BOM indicates.
byte[]	getSignature()	Get the byte signature for this instance.
static BOM	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BOM[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UTF_8

public static final BOM UTF_8

UTF_16BE

public static final BOM UTF_16BE

UTF_16LE

public static final BOM UTF_16LE

UTF_32BE

public static final BOM UTF_32BE

UTF_32LE

public static final BOM UTF_32LE

GB18030

public static final BOM GB18030

Method Details

values

public static BOM[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static BOM valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getSignature

public byte[] getSignature()

Get the byte signature for this instance.

Returns:

this BOM's byte signature (modifications to the returned array do not effect this instance)

getCharset

public Charset getCharset()

Get the character encoding that this BOM indicates.

Returns:

this BOM's implied character encoding