org.codehaus.jackson.smile

枚举 SmileGenerator.Feature

java.lang.Object

java.lang.Enum<SmileGenerator.Feature>

org.codehaus.jackson.smile.SmileGenerator.Feature

所有已实现的接口:

Serializable, Comparable<SmileGenerator.Feature>

封闭类:

SmileGenerator

public static enum SmileGenerator.Feature
extends Enum<SmileGenerator.Feature>

Enumeration that defines all togglable features for Smile generators.

枚举常量概要

枚举常量

枚举常量和说明
CHECK_SHARED_NAMES Whether generator should check if it can "share" field names during generating content or not.
CHECK_SHARED_STRING_VALUES Whether generator should check if it can "share" short (at most 64 bytes encoded) String value during generating content or not.
ENCODE_BINARY_AS_7BIT Whether to use simple 7-bit per byte encoding for binary content when output.
WRITE_END_MARKER Whether write byte marker that signifies end of logical content segment (SmileConstants.BYTE_MARKER_END_OF_CONTENT) when SmileGenerator.close() is called or not.
WRITE_HEADER Whether to write 4-byte header sequence when starting output or not.

字段概要

字段

限定符和类型	字段和说明
protected boolean	_defaultState
protected int	_mask

方法概要

方法

限定符和类型	方法和说明
static int	collectDefaults() Method that calculates bit set (flags) of all features that are enabled by default.
boolean	enabledByDefault()
int	getMask()
static SmileGenerator.Feature	valueOf(String name) 返回带有指定名称的该类型的枚举常量。
static SmileGenerator.Feature[]	values() 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。

从类继承的方法 java.lang.Enum

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

从类继承的方法 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

枚举常量详细资料

WRITE_HEADER

public static final SmileGenerator.Feature WRITE_HEADER

Whether to write 4-byte header sequence when starting output or not. If disabled, no header is written; this may be useful in embedded cases where context is enough to know that content is encoded using this format. Note, however, that omitting header means that default settings for shared names/string values can not be changed.

Default setting is true, meaning that header will be written.

WRITE_END_MARKER

public static final SmileGenerator.Feature WRITE_END_MARKER

Whether write byte marker that signifies end of logical content segment (SmileConstants.BYTE_MARKER_END_OF_CONTENT) when SmileGenerator.close() is called or not. This can be useful when outputting multiple adjacent logical content segments (documents) into single physical output unit (file).

Default setting is false meaning that such marker is not written.

ENCODE_BINARY_AS_7BIT

public static final SmileGenerator.Feature ENCODE_BINARY_AS_7BIT

Whether to use simple 7-bit per byte encoding for binary content when output. This is necessary ensure that byte 0xFF will never be included in content output. For other data types this limitation is handled automatically; but since overhead for binary data (14% size expansion, processing overhead) is non-negligible, it is not enabled by default. If no binary data is output, feature has no effect.

Default setting is true, indicating that binary data is quoted as 7-bit bytes instead of written raw.

CHECK_SHARED_NAMES

public static final SmileGenerator.Feature CHECK_SHARED_NAMES

Whether generator should check if it can "share" field names during generating content or not. If enabled, can replace repeating field names with back references, which are more compact and should faster to decode. Downside is that there is some overhead for writing (need to track existing values, check), as well as decoding.

Since field names tend to repeat quite often, this setting is enabled by default.

CHECK_SHARED_STRING_VALUES

public static final SmileGenerator.Feature CHECK_SHARED_STRING_VALUES

Whether generator should check if it can "share" short (at most 64 bytes encoded) String value during generating content or not. If enabled, can replace repeating Short String values with back references, which are more compact and should faster to decode. Downside is that there is some overhead for writing (need to track existing values, check), as well as decoding.

Since efficiency of this option depends a lot on type of content being produced, this option is disabled by default, and should only be enabled if it is likely that same values repeat relatively often.

字段详细资料

_defaultState

protected final boolean _defaultState

_mask

protected final int _mask

方法详细资料

values

public static SmileGenerator.Feature[] values()

按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:

for (SmileGenerator.Feature c : SmileGenerator.Feature.values())
    System.out.println(c);

valueOf

public static SmileGenerator.Feature valueOf(String name)

返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符完全匹配。(不允许有多余 的空格字符。)

参数:

name - 要返回的枚举常量的名称。

返回:

返回带有指定名称的枚举常量

抛出:

如果该枚举类型没有带有指定名称的常量, - 则抛出 IllegalArgumentException

如果参数为空值, - 则抛出 NullPointerException

collectDefaults

public static int collectDefaults()

Method that calculates bit set (flags) of all features that are enabled by default.

enabledByDefault

public boolean enabledByDefault()

getMask

public int getMask()