Class DefaultPrettyPrinter
- java.lang.Object
-
- org.codehaus.jackson.util.DefaultPrettyPrinter
-
- All Implemented Interfaces:
PrettyPrinter
- Direct Known Subclasses:
DefaultPrettyPrinter
public class DefaultPrettyPrinter extends Object implements PrettyPrinter
DefaultPrettyPrinter
implementation that uses 2-space indentation with platform-default linefeeds. Usually this class is not instantiated directly, but instead methodJsonGenerator.useDefaultPrettyPrinter()
is used, which will use an instance of this class for operation.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DefaultPrettyPrinter.FixedSpaceIndenter
This is a very simple indenter that only every adds a single space for indentation.static class
DefaultPrettyPrinter.Lf2SpacesIndenter
Default linefeed-based indenter uses system-specific linefeeds and 2 spaces for indentation per level.static class
DefaultPrettyPrinter.NopIndenter
Dummy implementation that adds no indentation whatsoever
-
Field Summary
Fields Modifier and Type Field Description protected Indenter
_arrayIndenter
By default, let's use only spaces to separate array values.protected int
_nesting
Number of open levels of nesting.protected Indenter
_objectIndenter
By default, let's use linefeed-adding indenter for separate object entries.protected boolean
_spacesInObjectEntries
By default we will add spaces around colons used to separate object fields and values.
-
Constructor Summary
Constructors Constructor Description DefaultPrettyPrinter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
beforeArrayValues(JsonGenerator jg)
Method called after array start marker has been output, and right before the first value is to be output.void
beforeObjectEntries(JsonGenerator jg)
Method called after object start marker has been output, and right before the field name of the first entry is to be output.void
indentArraysWith(Indenter i)
void
indentObjectsWith(Indenter i)
void
spacesInObjectEntries(boolean b)
void
writeArrayValueSeparator(JsonGenerator jg)
Method called after an array value has been completely output, and before another value is to be output.void
writeEndArray(JsonGenerator jg, int nrOfValues)
Method called after an Array value has been completely output (minus closing bracket).void
writeEndObject(JsonGenerator jg, int nrOfEntries)
Method called after an Object value has been completely output (minus closing curly bracket).void
writeObjectEntrySeparator(JsonGenerator jg)
Method called after an object entry (field:value) has been completely output, and before another value is to be output.void
writeObjectFieldValueSeparator(JsonGenerator jg)
Method called after an object field has been output, but before the value is output.void
writeRootValueSeparator(JsonGenerator jg)
Method called after a root-level value has been completely output, and before another value is to be output.void
writeStartArray(JsonGenerator jg)
Method called when an Array value is to be output, before any member/child values are output.void
writeStartObject(JsonGenerator jg)
Method called when an Object value is to be output, before any fields are output.
-
-
-
Field Detail
-
_arrayIndenter
protected Indenter _arrayIndenter
By default, let's use only spaces to separate array values.
-
_objectIndenter
protected Indenter _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)
-
_spacesInObjectEntries
protected boolean _spacesInObjectEntries
By default we will add spaces around colons used to separate object fields and values. If disabled, will not use spaces around colon.
-
_nesting
protected int _nesting
Number of open levels of nesting. Used to determine amount of indentation to use.
-
-
Method Detail
-
indentArraysWith
public void indentArraysWith(Indenter i)
-
indentObjectsWith
public void indentObjectsWith(Indenter i)
-
spacesInObjectEntries
public void spacesInObjectEntries(boolean b)
-
writeRootValueSeparator
public void writeRootValueSeparator(JsonGenerator jg) throws IOException, JsonGenerationException
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
- Throws:
IOException
JsonGenerationException
-
writeStartObject
public void writeStartObject(JsonGenerator jg) throws IOException, JsonGenerationException
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
- Throws:
IOException
JsonGenerationException
-
beforeObjectEntries
public void beforeObjectEntries(JsonGenerator jg) throws IOException, JsonGenerationException
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
- Throws:
IOException
JsonGenerationException
-
writeObjectFieldValueSeparator
public void writeObjectFieldValueSeparator(JsonGenerator jg) throws IOException, JsonGenerationException
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
- Throws:
IOException
JsonGenerationException
-
writeObjectEntrySeparator
public void writeObjectEntrySeparator(JsonGenerator jg) throws IOException, JsonGenerationException
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
- Throws:
IOException
JsonGenerationException
-
writeEndObject
public void writeEndObject(JsonGenerator jg, int nrOfEntries) throws IOException, JsonGenerationException
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
nrOfEntries
- Number of direct members of the array that have been output- Throws:
IOException
JsonGenerationException
-
writeStartArray
public void writeStartArray(JsonGenerator jg) throws IOException, JsonGenerationException
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
- Throws:
IOException
JsonGenerationException
-
beforeArrayValues
public void beforeArrayValues(JsonGenerator jg) throws IOException, JsonGenerationException
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
- Throws:
IOException
JsonGenerationException
-
writeArrayValueSeparator
public void writeArrayValueSeparator(JsonGenerator jg) throws IOException, JsonGenerationException
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
- Throws:
IOException
JsonGenerationException
-
writeEndArray
public void writeEndArray(JsonGenerator jg, int nrOfValues) throws IOException, JsonGenerationException
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
nrOfValues
- Number of direct members of the array that have been output- Throws:
IOException
JsonGenerationException
-
-