Top Description Inners Fields Constructors Methods
com.fasterxml.jackson.core.util

public Class Separators

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
java.io.Serializable, java.util.Objects
Value class used with some com.fasterxml.jackson.core.PrettyPrinter implements
Since
2.9
See Also
com.fasterxml.jackson.core.util.DefaultPrettyPrinter, com.fasterxml.jackson.core.util.MinimalPrettyPrinter

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
Separators.Spacing

Define the spacing around elements like commas and colons.

Field Summary

Modifier and TypeField and Description
private final String
arrayEmptySeparator

private final char
arrayValueSeparator

private final Separators.Spacing
arrayValueSpacing

public static final String
DEFAULT_ARRAY_EMPTY_SEPARATOR

String to use in empty Array to separate start and end markers.

public static final String
DEFAULT_OBJECT_EMPTY_SEPARATOR

String to use in empty Object to separate start and end markers.

public static final String
DEFAULT_ROOT_VALUE_SEPARATOR

Constant that specifies default "root-level" separator to use between root values: a single space character.

private final String
objectEmptySeparator

private final char
objectEntrySeparator

private final Separators.Spacing
objectEntrySpacing

private final char
objectFieldValueSeparator

private final Separators.Spacing
objectFieldValueSpacing

private final String
rootSeparator

private static final long
serialVersionUID

Constructor Summary

AccessConstructor and Description
public
Separators()

Constructor for creating an instance with default settings for all separators.

public
Separators(char objectFieldValueSeparator, char objectEntrySeparator, char arrayValueSeparator)

Create an instance with the specified separator characters.

public
Separators(String rootSeparator, char objectFieldValueSeparator, Separators.Spacing objectFieldValueSpacing, char objectEntrySeparator, Separators.Spacing objectEntrySpacing, char arrayValueSeparator, Separators.Spacing arrayValueSpacing)
Deprecated Since 2.17 use new canonical constructor

Create an instance with the specified separator characters and spaces around those characters.

public
Separators(String rootSeparator, char objectFieldValueSeparator, Separators.Spacing objectFieldValueSpacing, char objectEntrySeparator, Separators.Spacing objectEntrySpacing, String objectEmptySeparator, char arrayValueSeparator, Separators.Spacing arrayValueSpacing, String arrayEmptySeparator)

Canonical constructor for creating an instance with the specified separator characters and spaces around those characters.

Method Summary

Modifier and TypeMethod and Description
public static Separators
createDefaultInstance()

public String

Returns:

String to use in empty Array
getArrayEmptySeparator()

public char
getArrayValueSeparator()

public Separators.Spacing

Returns:

Spacing to use between Array values
getArrayValueSpacing()

public String

Returns:

String to use in empty Object
getObjectEmptySeparator()

public char
getObjectEntrySeparator()

public Separators.Spacing

Returns:

Spacing to use for Object entries
getObjectEntrySpacing()

public char
getObjectFieldValueSeparator()

public Separators.Spacing

Returns:

Spacing to use for Object fields
getObjectFieldValueSpacing()

public String

Returns:

String used as Root value separator
getRootSeparator()

public Separators

Returns:

This instance (for call chaining)
withArrayEmptySeparator(String sep)

public Separators
withArrayValueSeparator(char sep)

public Separators

Returns:

This instance (for call chaining)
withArrayValueSpacing(Separators.Spacing spacing)

public Separators

Returns:

This instance (for call chaining)
withObjectEmptySeparator(String sep)

public Separators
withObjectEntrySeparator(char sep)

public Separators

Returns:

This instance (for call chaining)
withObjectEntrySpacing(Separators.Spacing spacing)

public Separators
withObjectFieldValueSeparator(char sep)

public Separators

Returns:

This instance (for call chaining)
withObjectFieldValueSpacing(Separators.Spacing spacing)

public Separators
withRootSeparator(String sep)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

arrayEmptySeparatorback to summary
private final String arrayEmptySeparator
arrayValueSeparatorback to summary
private final char arrayValueSeparator
arrayValueSpacingback to summary
private final Separators.Spacing arrayValueSpacing
DEFAULT_ARRAY_EMPTY_SEPARATORback to summary
public static final String DEFAULT_ARRAY_EMPTY_SEPARATOR

String to use in empty Array to separate start and end markers. Default is single space, resulting in output of [ ].

Since
2.17
DEFAULT_OBJECT_EMPTY_SEPARATORback to summary
public static final String DEFAULT_OBJECT_EMPTY_SEPARATOR

String to use in empty Object to separate start and end markers. Default is single space, resulting in output of { }.

Since
2.17
DEFAULT_ROOT_VALUE_SEPARATORback to summary
public static final String DEFAULT_ROOT_VALUE_SEPARATOR

Constant that specifies default "root-level" separator to use between root values: a single space character.

Since
2.16
objectEmptySeparatorback to summary
private final String objectEmptySeparator
objectEntrySeparatorback to summary
private final char objectEntrySeparator
objectEntrySpacingback to summary
private final Separators.Spacing objectEntrySpacing
objectFieldValueSeparatorback to summary
private final char objectFieldValueSeparator
objectFieldValueSpacingback to summary
private final Separators.Spacing objectFieldValueSpacing
rootSeparatorback to summary
private final String rootSeparator
serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

Separatorsback to summary
public Separators()

Constructor for creating an instance with default settings for all separators.

Separatorsback to summary
public Separators(char objectFieldValueSeparator, char objectEntrySeparator, char arrayValueSeparator)

Create an instance with the specified separator characters. There will be spaces before and after the objectFieldValueSeparator and none around the other two.

Separatorsback to summary
public Separators(String rootSeparator, char objectFieldValueSeparator, Separators.Spacing objectFieldValueSpacing, char objectEntrySeparator, Separators.Spacing objectEntrySpacing, char arrayValueSeparator, Separators.Spacing arrayValueSpacing)

Deprecated

Since 2.17 use new canonical constructor

Create an instance with the specified separator characters and spaces around those characters.

Annotations
@Deprecated
Since
2.16
Separatorsback to summary
public Separators(String rootSeparator, char objectFieldValueSeparator, Separators.Spacing objectFieldValueSpacing, char objectEntrySeparator, Separators.Spacing objectEntrySpacing, String objectEmptySeparator, char arrayValueSeparator, Separators.Spacing arrayValueSpacing, String arrayEmptySeparator)

Canonical constructor for creating an instance with the specified separator characters and spaces around those characters.

Since
2.17

Method Detail

createDefaultInstanceback to summary
public static Separators createDefaultInstance()
getArrayEmptySeparatorback to summary
public String getArrayEmptySeparator()
Returns:String

String to use in empty Array

Since
2.17
getArrayValueSeparatorback to summary
public char getArrayValueSeparator()
getArrayValueSpacingback to summary
public Separators.Spacing getArrayValueSpacing()
Returns:Separators.Spacing

Spacing to use between Array values

Since
2.16
getObjectEmptySeparatorback to summary
public String getObjectEmptySeparator()
Returns:String

String to use in empty Object

Since
2.17
getObjectEntrySeparatorback to summary
public char getObjectEntrySeparator()
getObjectEntrySpacingback to summary
public Separators.Spacing getObjectEntrySpacing()
Returns:Separators.Spacing

Spacing to use for Object entries

Since
2.16
getObjectFieldValueSeparatorback to summary
public char getObjectFieldValueSeparator()
getObjectFieldValueSpacingback to summary
public Separators.Spacing getObjectFieldValueSpacing()
Returns:Separators.Spacing

Spacing to use for Object fields

Since
2.16
getRootSeparatorback to summary
public String getRootSeparator()
Returns:String

String used as Root value separator

Since
2.16
withArrayEmptySeparatorback to summary
public Separators withArrayEmptySeparator(String sep)
Returns:Separators

This instance (for call chaining)

Since
2.17
withArrayValueSeparatorback to summary
public Separators withArrayValueSeparator(char sep)
withArrayValueSpacingback to summary
public Separators withArrayValueSpacing(Separators.Spacing spacing)
Returns:Separators

This instance (for call chaining)

Since
2.16
withObjectEmptySeparatorback to summary
public Separators withObjectEmptySeparator(String sep)
Returns:Separators

This instance (for call chaining)

Since
2.17
withObjectEntrySeparatorback to summary
public Separators withObjectEntrySeparator(char sep)
withObjectEntrySpacingback to summary
public Separators withObjectEntrySpacing(Separators.Spacing spacing)
Returns:Separators

This instance (for call chaining)

Since
2.16
withObjectFieldValueSeparatorback to summary
public Separators withObjectFieldValueSeparator(char sep)
withObjectFieldValueSpacingback to summary
public Separators withObjectFieldValueSpacing(Separators.Spacing spacing)
Returns:Separators

This instance (for call chaining)

Since
2.16
withRootSeparatorback to summary
public Separators withRootSeparator(String sep)
com.fasterxml.jackson.core.util back to summary

public final Enum Separators.Spacing

extends Enum<Separators.Spacing>
Class Inheritance
Define the spacing around elements like commas and colons.
Since
2.16

Field Summary

Modifier and TypeField and Description
public static final Separators.Spacing
AFTER

public static final Separators.Spacing
BEFORE

public static final Separators.Spacing
BOTH

public static final Separators.Spacing
NONE

private final String
spacesAfter

private final String
spacesBefore

Constructor Summary

AccessConstructor and Description
private
Spacing(String spacesBefore, String spacesAfter)

Method Summary

Modifier and TypeMethod and Description
public String
apply(char separator)

public String
spacesAfter()

public String
spacesBefore()

public static Separators.Spacing
valueOf(String name)

public static Separators.Spacing[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

AFTERback to summary
public static final Separators.Spacing AFTER
BEFOREback to summary
public static final Separators.Spacing BEFORE
BOTHback to summary
public static final Separators.Spacing BOTH
NONEback to summary
public static final Separators.Spacing NONE
spacesAfterback to summary
private final String spacesAfter
spacesBeforeback to summary
private final String spacesBefore

Constructor Detail

Spacingback to summary
private Spacing(String spacesBefore, String spacesAfter)

Method Detail

applyback to summary
public String apply(char separator)
spacesAfterback to summary
public String spacesAfter()
spacesBeforeback to summary
public String spacesBefore()
valueOfback to summary
public static Separators.Spacing valueOf(String name)
valuesback to summary
public static Separators.Spacing[] values()