public final Enum SmileWriteFeature

Whether generator should check if it can "share" property names during generating content or not. If enabled, can replace repeating property 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 property names tend to repeat quite often, this setting is enabled by default.

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.

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. This setting is enabled by default, however, overhead for binary data (14% size expansion, processing overhead) is non-negligible. 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.

Feature that determines if an invalid surrogate encoding found in the incoming String should fail with an exception or silently be output as the Unicode 'REPLACEMENT CHARACTER' (U+FFFD) or not; if not, an exception will be thrown to indicate invalid content.

Default value is false (for backwards compatibility) meaning that an invalid surrogate will result in exception (StreamWriteException).

Since

2.13

Whether write byte marker that signifies end of logical content segment (SmileConstants#BYTE_MARKER_END_OF_CONTENT) when SmileParser#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.

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.