org.dromara.hutool.core.io

Class ByteOrderMark

java.lang.Object

org.dromara.hutool.core.io.ByteOrderMark

All Implemented Interfaces:

Serializable, Comparable<ByteOrderMark>, Predicate<byte[]>

public class ByteOrderMark
extends Object
implements Predicate<byte[]>, Comparable<ByteOrderMark>, Serializable

Byte Order Mark (BOM) 头描述
BOM定义：http://www.unicode.org/unicode/faq/utf_bom.html

• EF BB BF = UTF-8
• FE FF = UTF-16BE, big-endian
• FF FE = UTF-16LE, little-endian
• 00 00 FE FF = UTF-32BE, big-endian
• FF FE 00 00 = UTF-32LE, little-endian

来自：Apache-commons-io

Author:

Apache-commons-io

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ByteOrderMark[]	ALL 预定义的所有BOM信息
static ByteOrderMark	UTF_16BE UTF-16BE BOM (Big-Endian).
static ByteOrderMark	UTF_16LE UTF-16LE BOM (Little-Endian).
static ByteOrderMark	UTF_32BE UTF-32BE BOM (Big-Endian).
static ByteOrderMark	UTF_32LE UTF-32LE BOM (Little-Endian).
static ByteOrderMark	UTF_8 UTF-8 BOM.

Constructor Summary

Constructors

Constructor and Description
ByteOrderMark(String charsetName, byte... bytes) 构造

Method Summary

Modifier and Type	Method and Description
int	compareTo(ByteOrderMark o)
boolean	equals(Object obj)
int	get(int pos) 获取指定位置的byte值
byte[]	getBytes() Gets a copy of the BOM's bytes.
String	getCharsetName() 获取BOM头定义的编码名称.
int	hashCode()
int	length() 获取BOM头byte数
boolean	test(byte[] headBytes) 是否匹配头部BOM信息 当提供的长度小于BOM需要检查的长度时，返回{code false}
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Field Detail

UTF_8

public static final ByteOrderMark UTF_8

UTF-8 BOM.

UTF_16BE

public static final ByteOrderMark UTF_16BE

UTF-16BE BOM (Big-Endian).

UTF_16LE

public static final ByteOrderMark UTF_16LE

UTF-16LE BOM (Little-Endian).

UTF_32BE

public static final ByteOrderMark UTF_32BE

UTF-32BE BOM (Big-Endian).

UTF_32LE

public static final ByteOrderMark UTF_32LE

UTF-32LE BOM (Little-Endian).

ALL

public static final ByteOrderMark[] ALL

预定义的所有BOM信息

Constructor Detail

ByteOrderMark

public ByteOrderMark(String charsetName,
                     byte... bytes)

构造

Parameters:

charsetName - BOM定义的编码名称

bytes - BOM bytes

Throws:

IllegalArgumentException - 编码名称为空或者bytes为空

Method Detail

getCharsetName

public String getCharsetName()

获取BOM头定义的编码名称.

Returns:

编码名称

length

public int length()

获取BOM头byte数

Returns:

BOM头byte数

get

public int get(int pos)

获取指定位置的byte值

Parameters:

pos - The position

Returns:

The specified byte

getBytes

public byte[] getBytes()

Gets a copy of the BOM's bytes.

Returns:

a copy of the BOM's bytes

test

public boolean test(byte[] headBytes)

是否匹配头部BOM信息
当提供的长度小于BOM需要检查的长度时，返回{code false}

Specified by:

test in interface Predicate<byte[]>

Parameters:

headBytes - 头部bytes

Returns:

是否匹配头部BOM信息

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(ByteOrderMark o)

Specified by:

compareTo in interface Comparable<ByteOrderMark>