Top Fields Constructors Methods
com.fasterxml.jackson.dataformat.javaprop

public abstract Class JavaPropsGenerator

extends GeneratorBase
Class Inheritance
Known Direct Subclasses
com.fasterxml.jackson.dataformat.javaprop.impl.PropertiesBackedGenerator, com.fasterxml.jackson.dataformat.javaprop.impl.WriterBackedGenerator
Imports
java.io.*, java.math.BigDecimal, .BigInteger, java.util.Arrays, com.fasterxml.jackson.core.*, com.fasterxml.jackson.core.base.GeneratorBase, com.fasterxml.jackson.core.io.IOContext, com.fasterxml.jackson.core.json.JsonWriteContext, com.fasterxml.jackson.core.util.JacksonFeatureSet, com.fasterxml.jackson.dataformat.javaprop.io.JPropWriteContext, com.fasterxml.jackson.dataformat.javaprop.util.Markers

Field Summary

Modifier and TypeField and Description
protected final StringBuilder
protected boolean
protected int
protected JPropWriteContext
_jpropContext

Current context, in form we can use it (GeneratorBase has untyped reference; left as null)

protected JavaPropsSchema
_schema

Definition of columns being written, if available.

protected final StreamWriteConstraints
protected static final JsonWriteContext
BOGUS_WRITE_CONTEXT

Since our context object does NOT implement standard write context, need to do something like use a placeholder...

private static final JavaPropsSchema
protected static final int
Inherited from com.fasterxml.jackson.core.base.GeneratorBase:
_cfgNumbersAsStrings_closed_features_ioContext_objectCodec_writeContextDERIVED_FEATURES_MASKMAX_BIG_DECIMAL_SCALESURR1_FIRSTSURR1_LASTSURR2_FIRSTSURR2_LASTWRITE_BINARYWRITE_BOOLEANWRITE_NULLWRITE_NUMBERWRITE_RAWWRITE_STRING

Constructor Summary

AccessConstructor and Description
public
JavaPropsGenerator(IOContext ctxt, int stdFeatures, ObjectCodec codec)

Method Summary

Modifier and TypeMethod and Description
protected abstract void
protected void
_verifyValueWrite(String
Additional message used for generating exception message if value output is NOT legal in current generator output state.
typeMsg
)

Implements abstract com.fasterxml.jackson.core.base.GeneratorBase._verifyValueWrite.

Method called before trying to write a value (scalar or structured), to verify that this is legal in current output state, as well as to output separators if and as necessary.

protected abstract void
protected abstract void
_writeEscapedEntry(char[] text, int offset, int len)

protected abstract void
_writeRaw(char c)

protected abstract void
protected abstract void
protected abstract void
_writeRaw(char[] text, int offset, int len)

protected abstract void
public void
assignCurrentValue(Object
Current value to assign for the current context of this generator
v
)

Overrides com.fasterxml.jackson.core.base.GeneratorBase.assignCurrentValue.

Helper method, usually equivalent to: getOutputContext().setCurrentValue(v);

public boolean
canOmitFields()

Overrides com.fasterxml.jackson.core.JsonGenerator.canOmitFields.

Introspection method to call to check whether it is ok to omit writing of Object fields or not.

public boolean
canUseSchema(FormatSchema
Schema to check
schema
)

Overrides com.fasterxml.jackson.core.JsonGenerator.canUseSchema.

Method that can be used to verify that given schema can be used with this generator (using setSchema).

public boolean
canWriteBinaryNatively()

Overrides com.fasterxml.jackson.core.JsonGenerator.canWriteBinaryNatively.

Introspection method that may be called to see if the underlying data format supports "native" binary data; that is, an efficient output of binary content without encoding.

public boolean
canWriteFormattedNumbers()

Overrides com.fasterxml.jackson.core.JsonGenerator.canWriteFormattedNumbers.

Introspection method to call to check whether it is possible to write numbers using writeNumber(java.lang.String) using possible custom format, or not.

public boolean
canWriteObjectId()

Overrides com.fasterxml.jackson.core.JsonGenerator.canWriteObjectId.

Introspection method that may be called to see if the underlying data format supports some kind of Object Ids natively (many do not; for example, JSON doesn't).

public boolean
canWriteTypeId()

Overrides com.fasterxml.jackson.core.JsonGenerator.canWriteTypeId.

Introspection method that may be called to see if the underlying data format supports some kind of Type Ids natively (many do not; for example, JSON doesn't).

public Object
currentValue()

Overrides com.fasterxml.jackson.core.base.GeneratorBase.currentValue.

Helper method, usually equivalent to: getOutputContext().getCurrentValue();

Note that "current value" is NOT populated (or used) by Streaming parser or generators; it is only used by higher-level data-binding functionality.

public Object
getCurrentValue()

Overrides com.fasterxml.jackson.core.JsonGenerator.getCurrentValue.

Alias for currentValue(), to be deprecated in later Jackson 2.x versions (and removed from Jackson 3.0).

public JsonStreamContext
getOutputContext()

Overrides com.fasterxml.jackson.core.base.GeneratorBase.getOutputContext.

Note

type was co-variant until Jackson 2.7; reverted back to base type in 2.8 to allow for overriding by subtypes that use custom context type.

public FormatSchema
getSchema()

Overrides com.fasterxml.jackson.core.JsonGenerator.getSchema.

Method for accessing Schema that this generator uses, if any; null if none.

public JacksonFeatureSet<StreamWriteCapability>
getWriteCapabilities()

Overrides com.fasterxml.jackson.core.JsonGenerator.getWriteCapabilities.

Accessor for getting metadata on capabilities of this generator, based on underlying data format being read (directly or indirectly).

public void
setCurrentValue(Object
Current value to assign for the current context of this generator
v
)

Overrides com.fasterxml.jackson.core.JsonGenerator.setCurrentValue.

Alias for assignCurrentValue, to be deprecated in later Jackson 2.x versions (and removed from Jackson 3.0).

public JsonGenerator
setPrettyPrinter(PrettyPrinter
PrettyPrinter to assign, if any; null if none
pp
)

Overrides com.fasterxml.jackson.core.JsonGenerator.setPrettyPrinter.

Method for setting a custom pretty printer, which is usually used to add indentation for improved human readability.

public void
setSchema(FormatSchema
Schema to use
schema
)

Overrides com.fasterxml.jackson.core.JsonGenerator.setSchema.

Method to call to make this generator use specified schema.

public StreamWriteConstraints
streamWriteConstraints()

Overrides com.fasterxml.jackson.core.JsonGenerator.streamWriteConstraints.

Get the constraints to apply when performing streaming writes.

public JsonGenerator
useDefaultPrettyPrinter()

Overrides com.fasterxml.jackson.core.base.GeneratorBase.useDefaultPrettyPrinter.

Convenience method for enabling pretty-printing using the default pretty printer (com.fasterxml.jackson.core.util.DefaultPrettyPrinter).

public Version
version()

Overrides com.fasterxml.jackson.core.base.GeneratorBase.version.

Implements com.fasterxml.jackson.core.Versioned.version.

Implemented with standard version number detection algorithm, typically using a simple generated class, with information extracted from Maven project file during build.

public void
writeBinary(Base64Variant
Base64 variant to use: defines details such as whether padding is used (and if so, using which character); what is the maximum line length before adding linefeed, and also the underlying alphabet to use.
b64variant
,
byte[]
Buffer that contains binary data to write
data
,
int
Offset in data of the first byte of data to write
offset
,
int
Length of data to write
len
)

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeBinary.

Method that will output given chunk of binary data as base64 encoded, as a complete String value (surrounded by double quotes).

public void
writeBoolean(boolean
Boolean value to write
state
)

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeBoolean.

Method for outputting literal JSON boolean value (one of Strings 'true' and 'false').

public void
writeEndArray()

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeEndArray.

Method for writing closing marker of a JSON Array value (character ']'; plus possible white space decoration if pretty-printing is enabled).

public void
writeEndObject()

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeEndObject.

Method for writing closing marker of an Object value (character '}'; plus possible white space decoration if pretty-printing is enabled).

public void
writeFieldName(String
Field name to write
name
)

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeFieldName.

Method for writing a field name (JSON String surrounded by double quotes: syntactically identical to a JSON String value), possibly decorated by white space if pretty-printing is enabled.

public void
writeNull()

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeNull.

Method for outputting literal JSON null value.

public void
writeNumber(int
Number value to write
i
)

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeNumber.

Method for outputting given value as JSON number.

public void
writeNumber(long
Number value to write
l
)

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeNumber.

Method for outputting given value as JSON number.

public void
writeNumber(BigInteger
Number value to write
v
)

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeNumber.

Method for outputting given value as JSON number.

public void
writeNumber(double
Number value to write
d
)

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeNumber.

Method for outputting indicate JSON numeric value.

public void
writeNumber(float
Number value to write
f
)

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeNumber.

Method for outputting indicate JSON numeric value.

public void
writeNumber(BigDecimal
Number value to write
dec
)

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeNumber.

Method for outputting indicate JSON numeric value.

public void
writeNumber(String
Textual (possibly formatted) number representation to write
encodedValue
)

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeNumber.

Write method that can be used for custom numeric types that can not be (easily?) converted to "standard" Java number types.

public void
writeRaw(String
Textual contents to include as-is in output.
text
)

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeRaw.

Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).

public void
writeRaw(String
String that has contents to include as-is in output
text
,
int
Offset within text of the first character to output
offset
,
int
Length of content (from text, starting at offset offset) to output
len
)

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeRaw.

Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).

public void
writeRaw(char[]
Buffer that has contents to include as-is in output
text
,
int
Offset within text of the first character to output
offset
,
int
Length of content (from text, starting at offset offset) to output
len
)

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeRaw.

Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).

public void
writeRaw(char
Character to included in output
c
)

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeRaw.

Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).

public void
writeRaw(SerializableString
Pre-encoded textual contents to included in output
text
)

Overrides com.fasterxml.jackson.core.JsonGenerator.writeRaw.

Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).

public void
writeRawUTF8String(byte[]
Buffer that contains String value to write
text
,
int
Offset in buffer of the first byte of String value to write
offset
,
int
Length of the String value (in characters) to write
len
)

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeRawUTF8String.

Method similar to writeString(String) but that takes as its input a UTF-8 encoded String that is to be output as-is, without additional escaping (type of which depends on data format; backslashes for JSON).

public void
writeStartArray()

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeStartArray.

Method for writing starting marker of a Array value (for JSON this is character '['; plus possible white space decoration if pretty-printing is enabled).

public void
writeStartObject()

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeStartObject.

Method for writing starting marker of an Object value (character '{'; plus possible white space decoration if pretty-printing is enabled).

public void
writeString(String
Text value to write
text
)

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeString.

Method for outputting a String value.

public void
writeString(char[]
Buffer that contains String value to write
text
,
int
Offset in buffer of the first character of String value to write
offset
,
int
Length of the String value (in characters) to write
len
)

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeString.

Method for outputting a String value.

public void
writeUTF8String(byte[]
Buffer that contains String value to write
text
,
int
Offset in buffer of the first byte of String value to write
offset
,
int
Length of the String value (in characters) to write
len
)

Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeUTF8String.

Method similar to writeString(String) but that takes as its input a UTF-8 encoded String which has not been escaped using whatever escaping scheme data format requires (for JSON that is backslash-escaping for control characters and double-quotes; for other formats something else).

Inherited from com.fasterxml.jackson.core.base.GeneratorBase:
_asString_checkRangeBoundsForByteArray_checkRangeBoundsForCharArray_checkRangeBoundsForString_checkStdFeatureChanges_constructDefaultPrettyPrinter_decodeSurrogate_releaseBuffersclosedisableenableflushgetCodecgetCurrentValuegetFeatureMaskisClosedisEnabledoverrideStdFeaturessetCodecsetCurrentValuesetFeatureMaskwriteBinarywriteFieldNamewriteObjectwriteRawValuewriteRawValuewriteRawValuewriteRawValuewriteStartObjectwriteStringwriteTree