Package org.apache.commons.io
Class ByteOrderMark
java.lang.Object
org.apache.commons.io.ByteOrderMark
- All Implemented Interfaces:
Serializable
Byte Order Mark (BOM) representation - see
BOMInputStream
.-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ByteOrderMark
UTF-16BE BOM (Big-Endian).static final ByteOrderMark
UTF-16LE BOM (Little-Endian).static final ByteOrderMark
UTF-32BE BOM (Big-Endian).static final ByteOrderMark
UTF-32LE BOM (Little-Endian).static final ByteOrderMark
UTF-8 BOM.static final char
Unicode BOM character; external form depends on the encoding. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Indicates if this BOM's bytes equals another.int
get
(int pos) Gets the byte at the specified position.byte[]
getBytes()
Gets a copy of the BOM's bytes.Gets the name of theCharset
the BOM represents.int
hashCode()
Computes the hashcode for this BOM.int
length()
Gets the length of the BOM's bytes.toString()
Converts this instance to a String representation of the BOM.
-
Field Details
-
UTF_8
UTF-8 BOM. -
UTF_16BE
UTF-16BE BOM (Big-Endian). -
UTF_16LE
UTF-16LE BOM (Little-Endian). -
UTF_32BE
UTF-32BE BOM (Big-Endian).- Since:
- 2.2
-
UTF_32LE
UTF-32LE BOM (Little-Endian).- Since:
- 2.2
-
UTF_BOM
Unicode BOM character; external form depends on the encoding.- Since:
- 2.5
- See Also:
-
-
Constructor Details
-
ByteOrderMark
Constructs a new BOM.- Parameters:
charsetName
- The name of the charset the BOM representsbytes
- The BOM's bytes- Throws:
IllegalArgumentException
- if the charsetName is null or zero lengthIllegalArgumentException
- if the bytes are null or zero length
-
-
Method Details
-
getCharsetName
Gets the name of theCharset
the BOM represents.- Returns:
- the character set name
-
length
Gets the length of the BOM's bytes.- Returns:
- the length of the BOM's bytes
-
get
Gets the byte at the specified position.- Parameters:
pos
- The position- Returns:
- The specified byte
-
getBytes
Gets a copy of the BOM's bytes.- Returns:
- a copy of the BOM's bytes
-
equals
Indicates if this BOM's bytes equals another. -
hashCode
Computes the hashcode for this BOM. -
toString
Converts this instance to a String representation of the BOM.
-