Jackson 3.0.1 · tools.jackson.dataformat.csv.CsvWriteFeature

Field Summary

Modifier and Type	Field and Description
private final boolean	_defaultState
private final int	_mask
public static final CsvWriteFeature	ALWAYS_QUOTE_EMPTY_STRINGS Feature that determines whether values written as empty Strings (from `java.lang.String` valued POJO properties) should be forced to be quoted.
public static final CsvWriteFeature	ALWAYS_QUOTE_NUMBERS Feature that determines whether values written as Nymbers (from `java.lang.Number` valued POJO properties) should be forced to be quoted, regardless of whether they actually need this.
public static final CsvWriteFeature	ALWAYS_QUOTE_STRINGS Feature that determines whether values written as Strings (from `java.lang.String` valued POJO properties) should be forced to be quoted, regardless of whether they actually need this.
public static final CsvWriteFeature	ESCAPE_CONTROL_CHARS_WITH_ESCAPE_CHAR Feature that determines whether control characters (non-printable) are escaped using the configured escape character.
public static final CsvWriteFeature	ESCAPE_QUOTE_CHAR_WITH_ESCAPE_CHAR Feature that determines whether quote characters within quoted String values are escaped using configured escape character, instead of being "doubled up" (that is: a quote character is written twice in a row).
public static final CsvWriteFeature	OMIT_MISSING_TAIL_COLUMNS Feature that determines whether columns without matching value may be omitted, when they are the last values of the row.
public static final CsvWriteFeature	STRICT_CHECK_FOR_QUOTING Feature that determines how much work is done before determining that a column value requires quoting: when set as `true`, full check is made to only use quoting when it is strictly necessary; but when `false`, a faster but more conservative check is made, and possibly quoting is used for values that might not need it.
public static final CsvWriteFeature	WRITE_LINEFEED_AFTER_LAST_ROW Feature that determines whether a line-feed will be written at the end of content, after the last row of output.

Constructor Summary

Access	Constructor and Description
private	CsvWriteFeature(boolean defaultState)

Method Summary

Modifier and Type	Method and Description
public static int	collectDefaults() Method that calculates bit set (flags) of all features that are enabled by default.
public boolean	enabledByDefault() Implements tools.jackson.core.util.JacksonFeature.enabledByDefault. Accessor for checking whether this feature is enabled by default.
public boolean	enabledIn(int flags) Implements tools.jackson.core.util.JacksonFeature.enabledIn. Convenience method for checking whether feature is enabled in given bitmask.
public int	getMask() Implements tools.jackson.core.util.JacksonFeature.getMask. Returns bit mask for this feature instance; must be a single bit, that is of form `1 << N`.
public static CsvWriteFeature	valueOf(String name)
public static CsvWriteFeature[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

_defaultState	back to summary
private final boolean _defaultState

_mask	back to summary
private final int _mask

ALWAYS_QUOTE_EMPTY_STRINGS	back to summary
public static final CsvWriteFeature ALWAYS_QUOTE_EMPTY_STRINGS Feature that determines whether values written as empty Strings (from `java.lang.String` valued POJO properties) should be forced to be quoted.

ALWAYS_QUOTE_NUMBERS	back to summary
public static final CsvWriteFeature ALWAYS_QUOTE_NUMBERS Feature that determines whether values written as Nymbers (from `java.lang.Number` valued POJO properties) should be forced to be quoted, regardless of whether they actually need this.

ALWAYS_QUOTE_STRINGS back to summary

ALWAYS_QUOTE_STRINGS	back to summary
public static final CsvWriteFeature ALWAYS_QUOTE_STRINGS Feature that determines whether values written as Strings (from `java.lang.String` valued POJO properties) should be forced to be quoted, regardless of whether they actually need this. Note that this feature has precedence over `STRICT_CHECK_FOR_QUOTING`, when both would be applicable. Note that this setting does NOT affect quoting of typed values like `Number`s or `Boolean`s.

public static final CsvWriteFeature ALWAYS_QUOTE_STRINGS

Feature that determines whether values written as Strings (from java.lang.String valued POJO properties) should be forced to be quoted, regardless of whether they actually need this. Note that this feature has precedence over STRICT_CHECK_FOR_QUOTING, when both would be applicable. Note that this setting does NOT affect quoting of typed values like Numbers or Booleans.

ESCAPE_CONTROL_CHARS_WITH_ESCAPE_CHAR	back to summary
public static final CsvWriteFeature ESCAPE_CONTROL_CHARS_WITH_ESCAPE_CHAR Feature that determines whether control characters (non-printable) are escaped using the configured escape character. This feature allows LF and CR characters to be output as \n and \r instead of being echoed out. This is a compatibility feature for some parsers that can not read such output back in. Default value is false so that control characters are echoed out (backwards compatible).

ESCAPE_CONTROL_CHARS_WITH_ESCAPE_CHAR

back to summary

public static final CsvWriteFeature ESCAPE_CONTROL_CHARS_WITH_ESCAPE_CHAR

Feature that determines whether control characters (non-printable) are escaped using the configured escape character. This feature allows LF and CR characters to be output as

\n

and

\r

instead of being echoed out. This is a compatibility feature for some parsers that can not read such output back in.

Default value is false so that control characters are echoed out (backwards compatible).

ESCAPE_QUOTE_CHAR_WITH_ESCAPE_CHAR	back to summary
public static final CsvWriteFeature ESCAPE_QUOTE_CHAR_WITH_ESCAPE_CHAR Feature that determines whether quote characters within quoted String values are escaped using configured escape character, instead of being "doubled up" (that is: a quote character is written twice in a row). Default value is false so that quotes are doubled as necessary, not escaped.

ESCAPE_QUOTE_CHAR_WITH_ESCAPE_CHAR

back to summary

public static final CsvWriteFeature ESCAPE_QUOTE_CHAR_WITH_ESCAPE_CHAR

Feature that determines whether quote characters within quoted String values are escaped using configured escape character, instead of being "doubled up" (that is: a quote character is written twice in a row).

Default value is false so that quotes are doubled as necessary, not escaped.

OMIT_MISSING_TAIL_COLUMNS	back to summary
public static final CsvWriteFeature OMIT_MISSING_TAIL_COLUMNS Feature that determines whether columns without matching value may be omitted, when they are the last values of the row. If `true`, values and separators between values may be omitted, to slightly reduce length of the row; if `false`, separators need to stay in place and values are indicated by empty Strings.

STRICT_CHECK_FOR_QUOTING back to summary

STRICT_CHECK_FOR_QUOTING	back to summary
public static final CsvWriteFeature STRICT_CHECK_FOR_QUOTING Feature that determines how much work is done before determining that a column value requires quoting: when set as `true`, full check is made to only use quoting when it is strictly necessary; but when `false`, a faster but more conservative check is made, and possibly quoting is used for values that might not need it. Trade-offs is basically between optimal/minimal quoting (true), and faster handling (false). Faster check involves only checking first N characters of value, as well as possible looser checks. Note, however, that regardless setting, all values that need to be quoted will be: it is just that when set to `false`, other values may also be quoted (to avoid having to do more expensive checks). Default value is `false` for "loose" (approximate, conservative) checking.

public static final CsvWriteFeature STRICT_CHECK_FOR_QUOTING

Feature that determines how much work is done before determining that a column value requires quoting: when set as true, full check is made to only use quoting when it is strictly necessary; but when false, a faster but more conservative check is made, and possibly quoting is used for values that might not need it. Trade-offs is basically between optimal/minimal quoting (true), and faster handling (false). Faster check involves only checking first N characters of value, as well as possible looser checks.

Note, however, that regardless setting, all values that need to be quoted will be: it is just that when set to false, other values may also be quoted (to avoid having to do more expensive checks).

Default value is false for "loose" (approximate, conservative) checking.

WRITE_LINEFEED_AFTER_LAST_ROW back to summary

WRITE_LINEFEED_AFTER_LAST_ROW	back to summary
public static final CsvWriteFeature WRITE_LINEFEED_AFTER_LAST_ROW Feature that determines whether a line-feed will be written at the end of content, after the last row of output. Note When disabling this feature it is important that `CsvGenerator#flush()` is NOT called before `CsvGenerator#close()` is called; the current implementation relies on ability to essentially remove the last linefeed that was appended in the output buffer. Default value is `true` so all rows, including the last, are terminated by a line feed.

public static final CsvWriteFeature WRITE_LINEFEED_AFTER_LAST_ROW

Feature that determines whether a line-feed will be written at the end of content, after the last row of output.

Note

When disabling this feature it is important that CsvGenerator#flush() is NOT called before CsvGenerator#close() is called; the current implementation relies on ability to essentially remove the last linefeed that was appended in the output buffer.

Default value is true so all rows, including the last, are terminated by a line feed.

Constructor Detail

CsvWriteFeature	back to summary
private CsvWriteFeature(boolean defaultState)

Method Detail

collectDefaults	back to summary
public static int collectDefaults() Method that calculates bit set (flags) of all features that are enabled by default.

enabledByDefault	back to summary
public boolean enabledByDefault() Implements tools.jackson.core.util.JacksonFeature.enabledByDefault. Doc from tools.jackson.core.util.JacksonFeature.enabledByDefault. Accessor for checking whether this feature is enabled by default. Annotations @Override

enabledByDefault

back to summary

public boolean enabledByDefault()

Implements tools.jackson.core.util.JacksonFeature.enabledByDefault.

Doc from tools.jackson.core.util.JacksonFeature.enabledByDefault.

Accessor for checking whether this feature is enabled by default.

Annotations

@Override

enabledIn	back to summary
public boolean enabledIn(int flags) Implements tools.jackson.core.util.JacksonFeature.enabledIn. Doc from tools.jackson.core.util.JacksonFeature.enabledIn. Convenience method for checking whether feature is enabled in given bitmask. Annotations @Override

enabledIn

back to summary

public boolean enabledIn(int flags)

Implements tools.jackson.core.util.JacksonFeature.enabledIn.

Doc from tools.jackson.core.util.JacksonFeature.enabledIn.

Convenience method for checking whether feature is enabled in given bitmask.

Annotations

@Override

getMask back to summary

getMask	back to summary
public int getMask() Implements tools.jackson.core.util.JacksonFeature.getMask. Doc from tools.jackson.core.util.JacksonFeature.getMask. Returns bit mask for this feature instance; must be a single bit, that is of form `1 << N`. Annotations @Override

public int getMask()

Implements tools.jackson.core.util.JacksonFeature.getMask.

Doc from tools.jackson.core.util.JacksonFeature.getMask.

Returns bit mask for this feature instance; must be a single bit, that is of form 1 << N.

Annotations

@Override

valueOf	back to summary
public static CsvWriteFeature valueOf(String name)

values	back to summary
public static CsvWriteFeature[] values()

public final Enum CsvWriteFeature

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail