Class DefaultPrettyPrinter
- All Implemented Interfaces:
PrettyPrinter
,Instantiatable<DefaultPrettyPrinter>
,Serializable
PrettyPrinter
implementation that uses 2-space
indentation with platform-default linefeeds.
Usually this class is not instantiated directly, but instead
method JsonGenerator.useDefaultPrettyPrinter()
is
used, which will use an instance of this class for operation.
If you override this class, take note of Instantiatable
,
as subclasses will still create an instance of DefaultPrettyPrinter.- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
This is a very simple indenter that only adds a single space for indentation.static interface
Interface that defines objects that can produce indentation used to separate object entries and array values.static class
Dummy implementation that adds no indentation whatsoever -
Field Summary
Modifier and TypeFieldDescriptionprotected DefaultPrettyPrinter.Indenter
By default, let's use only spaces to separate array values.protected int
Number of open levels of nesting.protected String
protected DefaultPrettyPrinter.Indenter
By default, let's use linefeed-adding indenter for separate object entries.protected final SerializableString
String printed between root-level values, if any.protected Separators
protected boolean
By default we will add spaces around colons used to separate object fields and values.static final SerializedString
Constant that specifies default "root-level" separator to use between root values: a single space character.Fields inherited from interface edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.PrettyPrinter
DEFAULT_SEPARATORS
-
Constructor Summary
ConstructorDescriptionDefaultPrettyPrinter
(SerializableString rootSeparator) Constructor that specifies separator String to use between root values; if null, no separator is printed.DefaultPrettyPrinter
(DefaultPrettyPrinter base, SerializableString rootSeparator) DefaultPrettyPrinter
(String rootSeparator) Constructor that specifies separator String to use between root values; if null, no separator is printed. -
Method Summary
Modifier and TypeMethodDescriptionprotected DefaultPrettyPrinter
_withSpaces
(boolean state) void
Method called after array start marker has been output, and right before the first value is to be output.void
Method called after object start marker has been output, and right before the field name of the first entry is to be output.Method called to ensure that we have a non-blueprint object to use; it is either this object (if stateless), or a newly created object with separate state.void
void
"Mutant factory" method that will return a pretty printer instance that does not use spaces inside object entries; if 'this' instance already does this, it is returned; if not, a new instance will be constructed and returned.withRootSeparator
(SerializableString rootSeparator) withRootSeparator
(String rootSeparator) withSeparators
(Separators separators) Method for configuring separators for this pretty-printer to use"Mutant factory" method that will return a pretty printer instance that does use spaces inside object entries; if 'this' instance already does this, it is returned; if not, a new instance will be constructed and returned.void
Method called after an array value has been completely output, and before another value is to be output.void
writeEndArray
(JsonGenerator g, int nrOfValues) Method called after an Array value has been completely output (minus closing bracket).void
writeEndObject
(JsonGenerator g, int nrOfEntries) Method called after an Object value has been completely output (minus closing curly bracket).void
Method called after an object entry (field:value) has been completely output, and before another value is to be output.void
Method called after an object field has been output, but before the value is output.void
Method called after a root-level value has been completely output, and before another value is to be output.void
Method called when an Array value is to be output, before any member/child values are output.void
Method called when an Object value is to be output, before any fields are output.
-
Field Details
-
DEFAULT_ROOT_VALUE_SEPARATOR
Constant that specifies default "root-level" separator to use between root values: a single space character.- Since:
- 2.1
-
_arrayIndenter
By default, let's use only spaces to separate array values. -
_objectIndenter
By default, let's use linefeed-adding indenter for separate object entries. We'll further configure indenter to use system-specific linefeeds, and 2 spaces per level (as opposed to, say, single tabs) -
_rootSeparator
String printed between root-level values, if any. -
_spacesInObjectEntries
protected boolean _spacesInObjectEntriesBy default we will add spaces around colons used to separate object fields and values. If disabled, will not use spaces around colon. -
_nesting
protected transient int _nestingNumber of open levels of nesting. Used to determine amount of indentation to use. -
_separators
- Since:
- 2.9
-
_objectFieldValueSeparatorWithSpaces
- Since:
- 2.9
-
-
Constructor Details
-
DefaultPrettyPrinter
public DefaultPrettyPrinter() -
DefaultPrettyPrinter
Constructor that specifies separator String to use between root values; if null, no separator is printed.Note: simply constructs a
SerializedString
out of parameter, callsDefaultPrettyPrinter(SerializableString)
- Parameters:
rootSeparator
- String to use as root value separator
-
DefaultPrettyPrinter
Constructor that specifies separator String to use between root values; if null, no separator is printed.- Parameters:
rootSeparator
- String to use as root value separator
-
DefaultPrettyPrinter
-
DefaultPrettyPrinter
-
-
Method Details
-
withRootSeparator
-
withRootSeparator
- Parameters:
rootSeparator
- Root-level value separator to use- Returns:
- This pretty-printer instance (for call chaining)
- Since:
- 2.6
-
indentArraysWith
-
indentObjectsWith
-
withArrayIndenter
-
withObjectIndenter
-
withSpacesInObjectEntries
"Mutant factory" method that will return a pretty printer instance that does use spaces inside object entries; if 'this' instance already does this, it is returned; if not, a new instance will be constructed and returned.- Returns:
- This pretty-printer instance (for call chaining)
- Since:
- 2.3
-
withoutSpacesInObjectEntries
"Mutant factory" method that will return a pretty printer instance that does not use spaces inside object entries; if 'this' instance already does this, it is returned; if not, a new instance will be constructed and returned.- Returns:
- This pretty-printer instance (for call chaining)
- Since:
- 2.3
-
_withSpaces
-
withSeparators
Method for configuring separators for this pretty-printer to use- Parameters:
separators
- Separator definitions to use- Returns:
- This pretty-printer instance (for call chaining)
- Since:
- 2.9
-
createInstance
Description copied from interface:Instantiatable
Method called to ensure that we have a non-blueprint object to use; it is either this object (if stateless), or a newly created object with separate state.- Specified by:
createInstance
in interfaceInstantiatable<DefaultPrettyPrinter>
- Returns:
- Actual instance to use
-
writeRootValueSeparator
Description copied from interface:PrettyPrinter
Method called after a root-level value has been completely output, and before another value is to be output.Default handling (without pretty-printing) will output a space, to allow values to be parsed correctly. Pretty-printer is to output some other suitable and nice-looking separator (tab(s), space(s), linefeed(s) or any combination thereof).
- Specified by:
writeRootValueSeparator
in interfacePrettyPrinter
- Parameters:
g
- Generator used for output- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeStartObject
Description copied from interface:PrettyPrinter
Method called when an Object value is to be output, before any fields are output.Default handling (without pretty-printing) will output the opening curly bracket. Pretty-printer is to output a curly bracket as well, but can surround that with other (white-space) decoration.
- Specified by:
writeStartObject
in interfacePrettyPrinter
- Parameters:
g
- Generator used for output- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
beforeObjectEntries
Description copied from interface:PrettyPrinter
Method called after object start marker has been output, and right before the field name of the first entry is to be output. It is not called for objects without entries.Default handling does not output anything, but pretty-printer is free to add any white space decoration.
- Specified by:
beforeObjectEntries
in interfacePrettyPrinter
- Parameters:
g
- Generator used for output- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeObjectFieldValueSeparator
Method called after an object field has been output, but before the value is output.Default handling (without pretty-printing) will output a single colon to separate the two. Pretty-printer is to output a colon as well, but can surround that with other (white-space) decoration.
- Specified by:
writeObjectFieldValueSeparator
in interfacePrettyPrinter
- Parameters:
g
- Generator used for output- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeObjectEntrySeparator
Method called after an object entry (field:value) has been completely output, and before another value is to be output.Default handling (without pretty-printing) will output a single comma to separate the two. Pretty-printer is to output a comma as well, but can surround that with other (white-space) decoration.
- Specified by:
writeObjectEntrySeparator
in interfacePrettyPrinter
- Parameters:
g
- Generator used for output- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeEndObject
Description copied from interface:PrettyPrinter
Method called after an Object value has been completely output (minus closing curly bracket).Default handling (without pretty-printing) will output the closing curly bracket. Pretty-printer is to output a curly bracket as well, but can surround that with other (white-space) decoration.
- Specified by:
writeEndObject
in interfacePrettyPrinter
- Parameters:
g
- Generator used for outputnrOfEntries
- Number of direct members of the Object that have been output- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeStartArray
Description copied from interface:PrettyPrinter
Method called when an Array value is to be output, before any member/child values are output.Default handling (without pretty-printing) will output the opening bracket. Pretty-printer is to output a bracket as well, but can surround that with other (white-space) decoration.
- Specified by:
writeStartArray
in interfacePrettyPrinter
- Parameters:
g
- Generator used for output- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
beforeArrayValues
Description copied from interface:PrettyPrinter
Method called after array start marker has been output, and right before the first value is to be output. It is not called for arrays with no values.Default handling does not output anything, but pretty-printer is free to add any white space decoration.
- Specified by:
beforeArrayValues
in interfacePrettyPrinter
- Parameters:
g
- Generator used for output- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeArrayValueSeparator
Method called after an array value has been completely output, and before another value is to be output.Default handling (without pretty-printing) will output a single comma to separate the two. Pretty-printer is to output a comma as well, but can surround that with other (white-space) decoration.
- Specified by:
writeArrayValueSeparator
in interfacePrettyPrinter
- Parameters:
g
- Generator used for output- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-
writeEndArray
Description copied from interface:PrettyPrinter
Method called after an Array value has been completely output (minus closing bracket).Default handling (without pretty-printing) will output the closing bracket. Pretty-printer is to output a bracket as well, but can surround that with other (white-space) decoration.
- Specified by:
writeEndArray
in interfacePrettyPrinter
- Parameters:
g
- Generator used for outputnrOfValues
- Number of direct members of the array that have been output- Throws:
IOException
- if there is either an underlying I/O problem or encoding issue at format layer
-