Jackson 2.18.2 · com.fasterxml.jackson.dataformat.javaprop.JavaPropsFactory

Modifier and Type	Field and Description
protected static final String	CHARSET_ID_LATIN1
public static final String	FORMAT_NAME_JAVA_PROPERTIES
private static final long	serialVersionUID Hides com.fasterxml.jackson.core.JsonFactory.serialVersionUID.

Access	Constructor and Description
public	JavaPropsFactory()
public	JavaPropsFactory(ObjectCodec codec)
protected	JavaPropsFactory(JavaPropsFactory src, ObjectCodec oc)
protected	JavaPropsFactory(JavaPropsFactoryBuilder b) Constructors used by `JavaPropsFactoryBuilder` for instantiation.

Method Summary

Modifier and Type	Method and Description
protected JsonGenerator	_createGenerator(Writer Writer underlying writer to write generated content to out, IOContext I/O context to use ctxt) Overrides com.fasterxml.jackson.core.JsonFactory._createGenerator. Overridable factory method that actually instantiates generator for given `Writer` and context object.
private final JsonGenerator	_createJavaPropsGenerator(IOContext ctxt, int stdFeat, ObjectCodec codec, OutputStream out)
protected JsonParser	_createParser(InputStream InputStream to use for reading content to parse in, IOContext I/O context to use for parsing ctxt) Overrides com.fasterxml.jackson.core.JsonFactory._createParser. Overridable factory method that actually instantiates desired parser given `InputStream` and context object.
protected JsonParser	_createParser(Reader Reader to use for reading content to parse r, IOContext I/O context to use for parsing ctxt) Overrides com.fasterxml.jackson.core.JsonFactory._createParser. Overridable factory method that actually instantiates parser using given `Reader` object for reading content.
protected JsonParser	_createParser(char[] Buffer that contains content to parse data, int Offset to the first character of data to parse offset, int Number of characters within buffer to parse len, IOContext I/O context to use for parsing ctxt, boolean Whether input buffer is recycled by the factory recyclable) Overrides com.fasterxml.jackson.core.JsonFactory._createParser. Overridable factory method that actually instantiates parser using given `char[]` object for accessing content.
protected JsonParser	_createParser(byte[] Buffer that contains content to parse data, int Offset to the first character of data to parse offset, int Number of characters within buffer to parse len, IOContext I/O context to use for parsing ctxt) Overrides com.fasterxml.jackson.core.JsonFactory._createParser. Overridable factory method that actually instantiates parser using given `Reader` object for reading content passed as raw byte array.
protected JsonGenerator	_createUTF8Generator(OutputStream OutputStream underlying writer to write generated content to out, IOContext I/O context to use ctxt) Overrides com.fasterxml.jackson.core.JsonFactory._createUTF8Generator. Overridable factory method that actually instantiates generator for given `OutputStream` and context object, using UTF-8 encoding.
protected Writer	_createWriter(OutputStream out, JsonEncoding enc, IOContext ctxt) Overrides com.fasterxml.jackson.core.JsonFactory._createWriter.
protected Properties	_loadProperties(InputStream in, IOContext ctxt)
protected Properties	_loadProperties(Reader r0, IOContext ctxt)
protected <T> T	_reportReadException(String msg, Exception rootCause)
public static JavaPropsFactoryBuilder	builder() Hides com.fasterxml.jackson.core.JsonFactory.builder. Main factory method to use for constructing `JavaPropsFactory` instances with different configuration.
public boolean	canHandleBinaryNatively() Overrides com.fasterxml.jackson.core.JsonFactory.canHandleBinaryNatively. Introspection method that higher-level functionality may call to see whether underlying data format can read and write binary data natively; that is, embeded it as-is without using encodings such as Base64.
public boolean	canUseCharArrays() Overrides com.fasterxml.jackson.core.JsonFactory.canUseCharArrays. Introspection method that can be used by base factory to check whether access using `char[]` is something that actual parser implementations can take advantage of, over having to use `java.io.Reader`.
public boolean	canUseSchema(FormatSchema Schema instance to check schema) Overrides com.fasterxml.jackson.core.JsonFactory.canUseSchema. Method that can be used to quickly check whether given schema is something that parsers and/or generators constructed by this factory could use.
public JavaPropsFactory	copy() Overrides com.fasterxml.jackson.core.JsonFactory.copy. Method for constructing a new `JsonFactory` that has the same settings as this instance, but is otherwise independent (i.e. nothing is actually shared, symbol tables are separate).
public JavaPropsGenerator	createGenerator(Properties props) Deprecated
public JavaPropsGenerator	createGenerator(Map<?, ?> target, JavaPropsSchema schema) Convenience method to allow using a pre-constructed `Map` instance as output target, so that serialized property values are added.
public JsonGenerator	createGenerator(OutputStream OutputStream to use for writing JSON content out, JsonEncoding Character encoding to use enc) Overrides com.fasterxml.jackson.core.JsonFactory.createGenerator. Method for constructing JSON generator for writing JSON content using specified output stream.
public JsonGenerator	createGenerator(OutputStream out) Overrides com.fasterxml.jackson.core.JsonFactory.createGenerator. Method for constructing `JsonGenerator` for generating CBOR-encoded output.
public JavaPropsParser	createParser(Map<?, ?> content) Convenience method to allow feeding a pre-parsed `Properties` instance as input.
public JavaPropsParser	createParser(Properties props) Deprecated
public JsonParser	createParser(File File that contains JSON content to parse f) Overrides com.fasterxml.jackson.core.JsonFactory.createParser. Method for constructing JSON parser instance to parse contents of specified file.
public JsonParser	createParser(URL URL pointing to resource that contains JSON content to parse url) Overrides com.fasterxml.jackson.core.JsonFactory.createParser. Method for constructing JSON parser instance to parse contents of resource reference by given URL.
public JsonParser	createParser(InputStream InputStream to use for reading JSON content to parse in) Overrides com.fasterxml.jackson.core.JsonFactory.createParser. Method for constructing JSON parser instance to parse the contents accessed via specified input stream.
public JsonParser	createParser(byte[] data) Overrides com.fasterxml.jackson.core.JsonFactory.createParser. Method for constructing parser for parsing the contents of given byte array.
public JsonParser	createParser(byte[] Buffer that contains data to parse data, int Offset of the first data byte within buffer offset, int Length of contents to parse within buffer len) Overrides com.fasterxml.jackson.core.JsonFactory.createParser. Method for constructing parser for parsing the contents of given byte array.
public String	getFormatName() Overrides com.fasterxml.jackson.core.JsonFactory.getFormatName. Method that returns short textual id identifying format this factory supports.
public MatchStrength	hasFormat(InputAccessor acc) Overrides com.fasterxml.jackson.core.JsonFactory.hasFormat. Sub-classes need to override this method
public JavaPropsFactoryBuilder	rebuild() Overrides com.fasterxml.jackson.core.JsonFactory.rebuild. Method that allows construction of differently configured factory, starting with settings of this factory.
public boolean	requiresPropertyOrdering() Overrides com.fasterxml.jackson.core.JsonFactory.requiresPropertyOrdering. Introspection method that higher-level functionality may call to see whether underlying data format requires a stable ordering of object properties or not.
public Version	version() Overrides com.fasterxml.jackson.core.JsonFactory.version. Implements com.fasterxml.jackson.core.Versioned.version. Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (see `Version` for details).

Inherited from com.fasterxml.jackson.core.JsonFactory:: _checkInvalidCopy _copy _createContentReference _createContentReference _createContext _createContext _createNonBlockingContext _createParser _decorate _decorate _decorate _decorate _decorate _decorate _getBufferRecycler _getRecyclerPool canParseAsync configure configure configure createGenerator createGenerator createGenerator createGenerator createJsonGenerator createJsonGenerator createJsonGenerator createJsonParser createJsonParser createJsonParser createJsonParser createJsonParser createJsonParser createJsonParser createNonBlockingByteArrayParser createNonBlockingByteBufferParser createParser createParser createParser createParser createParser disable disable disable enable enable enable getCharacterEscapes getCodec getFactoryFeatures getFormatGeneratorFeatures getFormatParserFeatures getFormatReadFeatureType getFormatWriteFeatureType getGeneratorFeatures getInputDecorator getOutputDecorator getParserFeatures getRootValueSeparator hasJSONFormat isEnabled isEnabled isEnabled isEnabled isEnabled readResolve requiresCustomCodec setCharacterEscapes setCodec setErrorReportConfiguration setInputDecorator setOutputDecorator setRecyclerPool setRootValueSeparator setStreamReadConstraints setStreamWriteConstraints streamReadConstraints streamWriteConstraints

CHARSET_ID_LATIN1	back to summary
protected static final String CHARSET_ID_LATIN1

FORMAT_NAME_JAVA_PROPERTIES	back to summary
public static final String FORMAT_NAME_JAVA_PROPERTIES

serialVersionUID	back to summary
private static final long serialVersionUID Hides com.fasterxml.jackson.core.JsonFactory.serialVersionUID.

JavaPropsFactory	back to summary
public JavaPropsFactory()

JavaPropsFactory	back to summary
public JavaPropsFactory(ObjectCodec codec)

JavaPropsFactory	back to summary
protected JavaPropsFactory(JavaPropsFactory src, ObjectCodec oc)

JavaPropsFactory	back to summary
protected JavaPropsFactory(JavaPropsFactoryBuilder b) Constructors used by `JavaPropsFactoryBuilder` for instantiation. Since 2.9

Method Detail

_createGenerator back to summary

_createGenerator	back to summary
protected JsonGenerator _createGenerator(Writer out, IOContext ctxt) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory._createGenerator. Doc from com.fasterxml.jackson.core.JsonFactory._createGenerator. Overridable factory method that actually instantiates generator for given `Writer` and context object. This method is specifically designed to remain compatible between minor versions so that sub-classes can count on it being called as expected. That is, it is part of official interface from sub-class perspective, although not a public method available to users of factory implementations. Parameters out:Writer Writer underlying writer to write generated content to ctxt:IOContext I/O context to use Returns:JsonGenerator This factory instance (to allow call chaining) Annotations @Override Exceptions IOException: if parser initialization fails due to I/O (write) problem

protected JsonGenerator _createGenerator(Writer out, IOContext ctxt) throws IOException

Overrides com.fasterxml.jackson.core.JsonFactory._createGenerator.

Doc from com.fasterxml.jackson.core.JsonFactory._createGenerator.

Overridable factory method that actually instantiates generator for given Writer and context object.

This method is specifically designed to remain compatible between minor versions so that sub-classes can count on it being called as expected. That is, it is part of official interface from sub-class perspective, although not a public method available to users of factory implementations.

Parameters

out:Writer: Writer underlying writer to write generated content to
ctxt:IOContext: I/O context to use

Returns:JsonGenerator

This factory instance (to allow call chaining)

Annotations

@Override

Exceptions

IOException:: if parser initialization fails due to I/O (write) problem

_createJavaPropsGenerator	back to summary
private final JsonGenerator _createJavaPropsGenerator(IOContext ctxt, int stdFeat, ObjectCodec codec, OutputStream out) throws IOException

_createParser back to summary

_createParser	back to summary
protected JsonParser _createParser(InputStream in, IOContext ctxt) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory._createParser. Doc from com.fasterxml.jackson.core.JsonFactory._createParser. Overridable factory method that actually instantiates desired parser given `InputStream` and context object. This method is specifically designed to remain compatible between minor versions so that sub-classes can count on it being called as expected. That is, it is part of official interface from sub-class perspective, although not a public method available to users of factory implementations. Parameters in:InputStream InputStream to use for reading content to parse ctxt:IOContext I/O context to use for parsing Returns:JsonParser Parser constructed Annotations @Override Exceptions IOException: if parser initialization fails due to I/O (read) problem

protected JsonParser _createParser(InputStream in, IOContext ctxt) throws IOException

Overrides com.fasterxml.jackson.core.JsonFactory._createParser.

Doc from com.fasterxml.jackson.core.JsonFactory._createParser.

Overridable factory method that actually instantiates desired parser given InputStream and context object.

Parameters

in:InputStream: InputStream to use for reading content to parse
ctxt:IOContext: I/O context to use for parsing

Returns:JsonParser

Parser constructed

Annotations

@Override

Exceptions

IOException:: if parser initialization fails due to I/O (read) problem

_createParser back to summary

_createParser	back to summary
protected JsonParser _createParser(Reader r, IOContext ctxt) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory._createParser. Doc from com.fasterxml.jackson.core.JsonFactory._createParser. Overridable factory method that actually instantiates parser using given `Reader` object for reading content. This method is specifically designed to remain compatible between minor versions so that sub-classes can count on it being called as expected. That is, it is part of official interface from sub-class perspective, although not a public method available to users of factory implementations. Parameters r:Reader Reader to use for reading content to parse ctxt:IOContext I/O context to use for parsing Returns:JsonParser Actual parser to use Annotations @Override Exceptions IOException: if parser initialization fails due to I/O (read) problem

protected JsonParser _createParser(Reader r, IOContext ctxt) throws IOException

Overrides com.fasterxml.jackson.core.JsonFactory._createParser.

Doc from com.fasterxml.jackson.core.JsonFactory._createParser.

Overridable factory method that actually instantiates parser using given Reader object for reading content.

Parameters

r:Reader: Reader to use for reading content to parse
ctxt:IOContext: I/O context to use for parsing

Returns:JsonParser

Actual parser to use

Annotations

@Override

Exceptions

IOException:: if parser initialization fails due to I/O (read) problem

_createParser back to summary

_createParser	back to summary
protected JsonParser _createParser(char[] data, int offset, int len, IOContext ctxt, boolean recyclable) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory._createParser. Doc from com.fasterxml.jackson.core.JsonFactory._createParser. Overridable factory method that actually instantiates parser using given `char[]` object for accessing content. Parameters data:char[] Buffer that contains content to parse offset:int Offset to the first character of data to parse len:int Number of characters within buffer to parse ctxt:IOContext I/O context to use for parsing recyclable:boolean Whether input buffer is recycled by the factory Returns:JsonParser Actual parser to use Annotations @Override Exceptions IOException: if parser initialization fails due to I/O (read) problem

protected JsonParser _createParser(char[] data, int offset, int len, IOContext ctxt, boolean recyclable) throws IOException

Overrides com.fasterxml.jackson.core.JsonFactory._createParser.

Doc from com.fasterxml.jackson.core.JsonFactory._createParser.

Overridable factory method that actually instantiates parser using given char[] object for accessing content.

Parameters

data:char[]: Buffer that contains content to parse
offset:int: Offset to the first character of data to parse
len:int: Number of characters within buffer to parse
ctxt:IOContext: I/O context to use for parsing
recyclable:boolean: Whether input buffer is recycled by the factory

Returns:JsonParser

Actual parser to use

Annotations

@Override

Exceptions

IOException:: if parser initialization fails due to I/O (read) problem

_createParser back to summary

_createParser	back to summary
protected JsonParser _createParser(byte[] data, int offset, int len, IOContext ctxt) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory._createParser. Doc from com.fasterxml.jackson.core.JsonFactory._createParser. Overridable factory method that actually instantiates parser using given `Reader` object for reading content passed as raw byte array. This method is specifically designed to remain compatible between minor versions so that sub-classes can count on it being called as expected. That is, it is part of official interface from sub-class perspective, although not a public method available to users of factory implementations. Parameters data:byte[] Buffer that contains content to parse offset:int Offset to the first character of data to parse len:int Number of characters within buffer to parse ctxt:IOContext I/O context to use for parsing Returns:JsonParser Actual parser to use Annotations @Override Exceptions IOException: if parser initialization fails due to I/O (read) problem

protected JsonParser _createParser(byte[] data, int offset, int len, IOContext ctxt) throws IOException

Overrides com.fasterxml.jackson.core.JsonFactory._createParser.

Doc from com.fasterxml.jackson.core.JsonFactory._createParser.

Overridable factory method that actually instantiates parser using given Reader object for reading content passed as raw byte array.

Parameters

data:byte[]: Buffer that contains content to parse
offset:int: Offset to the first character of data to parse
len:int: Number of characters within buffer to parse
ctxt:IOContext: I/O context to use for parsing

Returns:JsonParser

Actual parser to use

Annotations

@Override

Exceptions

IOException:: if parser initialization fails due to I/O (read) problem

_createUTF8Generator back to summary

_createUTF8Generator	back to summary
protected JsonGenerator _createUTF8Generator(OutputStream out, IOContext ctxt) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory._createUTF8Generator. Doc from com.fasterxml.jackson.core.JsonFactory._createUTF8Generator. Overridable factory method that actually instantiates generator for given `OutputStream` and context object, using UTF-8 encoding. This method is specifically designed to remain compatible between minor versions so that sub-classes can count on it being called as expected. That is, it is part of official interface from sub-class perspective, although not a public method available to users of factory implementations. Parameters out:OutputStream OutputStream underlying writer to write generated content to ctxt:IOContext I/O context to use Returns:JsonGenerator This factory instance (to allow call chaining) Annotations @Override Exceptions IOException: if parser initialization fails due to I/O (write) problem

protected JsonGenerator _createUTF8Generator(OutputStream out, IOContext ctxt) throws IOException

Overrides com.fasterxml.jackson.core.JsonFactory._createUTF8Generator.

Doc from com.fasterxml.jackson.core.JsonFactory._createUTF8Generator.

Overridable factory method that actually instantiates generator for given OutputStream and context object, using UTF-8 encoding.

Parameters

out:OutputStream: OutputStream underlying writer to write generated content to
ctxt:IOContext: I/O context to use

Returns:JsonGenerator

This factory instance (to allow call chaining)

Annotations

@Override

Exceptions

IOException:: if parser initialization fails due to I/O (write) problem

_createWriter	back to summary
protected Writer _createWriter(OutputStream out, JsonEncoding enc, IOContext ctxt) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory._createWriter. Annotations @Override

_createWriter

back to summary

protected Writer _createWriter(OutputStream out, JsonEncoding enc, IOContext ctxt) throws IOException

Overrides com.fasterxml.jackson.core.JsonFactory._createWriter.

Annotations

@Override

_loadProperties	back to summary
protected Properties _loadProperties(InputStream in, IOContext ctxt) throws IOException

_loadProperties	back to summary
protected Properties _loadProperties(Reader r0, IOContext ctxt) throws IOException

_reportReadException	back to summary
protected <T> T _reportReadException(String msg, Exception rootCause) throws IOException

builder back to summary

builder	back to summary
public static JavaPropsFactoryBuilder builder() Hides com.fasterxml.jackson.core.JsonFactory.builder. Main factory method to use for constructing `JavaPropsFactory` instances with different configuration. Returns:JavaPropsFactoryBuilder Doc from com.fasterxml.jackson.core.JsonFactory.builder. Builder instance to use

public static JavaPropsFactoryBuilder builder()

Hides com.fasterxml.jackson.core.JsonFactory.builder.

Main factory method to use for constructing JavaPropsFactory instances with different configuration.

Returns:JavaPropsFactoryBuilder

Doc from com.fasterxml.jackson.core.JsonFactory.builder.

Builder instance to use

canHandleBinaryNatively back to summary

canHandleBinaryNatively	back to summary
public boolean canHandleBinaryNatively() Overrides com.fasterxml.jackson.core.JsonFactory.canHandleBinaryNatively. Doc from com.fasterxml.jackson.core.JsonFactory.canHandleBinaryNatively. Introspection method that higher-level functionality may call to see whether underlying data format can read and write binary data natively; that is, embeded it as-is without using encodings such as Base64. Default implementation returns `false` as JSON does not support native access: all binary content must use Base64 encoding. Most binary formats (like Smile and Avro) support native binary content. Returns:boolean Whether format supported by this factory supports native binary content Annotations @Override

public boolean canHandleBinaryNatively()

Overrides com.fasterxml.jackson.core.JsonFactory.canHandleBinaryNatively.

Doc from com.fasterxml.jackson.core.JsonFactory.canHandleBinaryNatively.

Introspection method that higher-level functionality may call to see whether underlying data format can read and write binary data natively; that is, embeded it as-is without using encodings such as Base64.

Default implementation returns false as JSON does not support native access: all binary content must use Base64 encoding. Most binary formats (like Smile and Avro) support native binary content.

Returns:boolean

Whether format supported by this factory supports native binary content

Annotations

@Override

canUseCharArrays back to summary

canUseCharArrays	back to summary
public boolean canUseCharArrays() Overrides com.fasterxml.jackson.core.JsonFactory.canUseCharArrays. Doc from com.fasterxml.jackson.core.JsonFactory.canUseCharArrays. Introspection method that can be used by base factory to check whether access using `char[]` is something that actual parser implementations can take advantage of, over having to use `java.io.Reader`. Sub-types are expected to override definition; default implementation (suitable for JSON) alleges that optimization are possible; and thereby is likely to try to access `java.lang.String` content by first copying it into recyclable intermediate buffer. Returns:boolean Whether access to decoded textual content can be efficiently accessed using parser method `getTextCharacters()`. Annotations @Override

public boolean canUseCharArrays()

Overrides com.fasterxml.jackson.core.JsonFactory.canUseCharArrays.

Doc from com.fasterxml.jackson.core.JsonFactory.canUseCharArrays.

Introspection method that can be used by base factory to check whether access using char[] is something that actual parser implementations can take advantage of, over having to use java.io.Reader. Sub-types are expected to override definition; default implementation (suitable for JSON) alleges that optimization are possible; and thereby is likely to try to access java.lang.String content by first copying it into recyclable intermediate buffer.

Returns:boolean

Whether access to decoded textual content can be efficiently accessed using parser method getTextCharacters().

Annotations

@Override

canUseSchema	back to summary
public boolean canUseSchema(FormatSchema schema) Overrides com.fasterxml.jackson.core.JsonFactory.canUseSchema. Doc from com.fasterxml.jackson.core.JsonFactory.canUseSchema. Method that can be used to quickly check whether given schema is something that parsers and/or generators constructed by this factory could use. Note that this means possible use, at the level of data format (i.e. schema is for same data format as parsers and generators this factory constructs); individual schema instances may have further usage restrictions. Parameters schema:FormatSchema Schema instance to check Returns:boolean Whether parsers and generators constructed by this factory can use specified format schema instance Annotations @Override

canUseSchema

back to summary

public boolean canUseSchema(FormatSchema schema)

Overrides com.fasterxml.jackson.core.JsonFactory.canUseSchema.

Doc from com.fasterxml.jackson.core.JsonFactory.canUseSchema.

Method that can be used to quickly check whether given schema is something that parsers and/or generators constructed by this factory could use. Note that this means possible use, at the level of data format (i.e. schema is for same data format as parsers and generators this factory constructs); individual schema instances may have further usage restrictions.

Parameters

schema:FormatSchema: Schema instance to check

Returns:boolean

Whether parsers and generators constructed by this factory can use specified format schema instance

Annotations

@Override

copy back to summary

copy	back to summary
public JavaPropsFactory copy() Overrides com.fasterxml.jackson.core.JsonFactory.copy. Doc from com.fasterxml.jackson.core.JsonFactory.copy. Method for constructing a new `JsonFactory` that has the same settings as this instance, but is otherwise independent (i.e. nothing is actually shared, symbol tables are separate). Note that `ObjectCodec` reference is not copied but is set to null; caller typically needs to set it after calling this method. Reason for this is that the codec is used for callbacks, and assumption is that there is strict 1-to-1 mapping between codec, factory. Caller has to, then, explicitly set codec after making the copy. Returns:JavaPropsFactory Copy of this factory instance Annotations @Override

public JavaPropsFactory copy()

Overrides com.fasterxml.jackson.core.JsonFactory.copy.

Doc from com.fasterxml.jackson.core.JsonFactory.copy.

Method for constructing a new JsonFactory that has the same settings as this instance, but is otherwise independent (i.e. nothing is actually shared, symbol tables are separate). Note that ObjectCodec reference is not copied but is set to null; caller typically needs to set it after calling this method. Reason for this is that the codec is used for callbacks, and assumption is that there is strict 1-to-1 mapping between codec, factory. Caller has to, then, explicitly set codec after making the copy.

Returns:JavaPropsFactory

Copy of this factory instance

Annotations

@Override

createGenerator	back to summary
public JavaPropsGenerator createGenerator(Properties props) Deprecated Annotations @Deprecated

createGenerator back to summary

createGenerator	back to summary
public JavaPropsGenerator createGenerator(Map<?, ?> target, JavaPropsSchema schema) Convenience method to allow using a pre-constructed `Map` instance as output target, so that serialized property values are added. Since 2.10

public JavaPropsGenerator createGenerator(Map<?, ?> target, JavaPropsSchema schema)

Convenience method to allow using a pre-constructed Map instance as output target, so that serialized property values are added.

Since: 2.10

createGenerator back to summary

createGenerator	back to summary
public JsonGenerator createGenerator(OutputStream out, JsonEncoding enc) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory.createGenerator. Doc from com.fasterxml.jackson.core.JsonFactory.createGenerator. Method for constructing JSON generator for writing JSON content using specified output stream. Encoding to use must be specified, and needs to be one of available types (as per JSON specification). Underlying stream is NOT owned by the generator constructed, so that generator will NOT close the output stream when `JsonGenerator#close` is called (unless auto-closing feature, `com.fasterxml.jackson.core.JsonGenerator.Feature#AUTO_CLOSE_TARGET` is enabled). Using application needs to close it explicitly if this is the case. Note there are formats that use fixed encoding (like most binary data formats) and that ignore passed in encoding. Parameters out:OutputStream OutputStream to use for writing JSON content enc:JsonEncoding Character encoding to use Annotations @Override

public JsonGenerator createGenerator(OutputStream out, JsonEncoding enc) throws IOException

Overrides com.fasterxml.jackson.core.JsonFactory.createGenerator.

Doc from com.fasterxml.jackson.core.JsonFactory.createGenerator.

Method for constructing JSON generator for writing JSON content using specified output stream. Encoding to use must be specified, and needs to be one of available types (as per JSON specification).

Underlying stream is NOT owned by the generator constructed, so that generator will NOT close the output stream when JsonGenerator#close is called (unless auto-closing feature, com.fasterxml.jackson.core.JsonGenerator.Feature#AUTO_CLOSE_TARGET is enabled). Using application needs to close it explicitly if this is the case.

Note

there are formats that use fixed encoding (like most binary data formats) and that ignore passed in encoding.

Parameters

out:OutputStream: OutputStream to use for writing JSON content
enc:JsonEncoding: Character encoding to use

Annotations

@Override

createGenerator back to summary

createGenerator	back to summary
public JsonGenerator createGenerator(OutputStream out) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory.createGenerator. Method for constructing `JsonGenerator` for generating CBOR-encoded output. Since CBOR format always uses UTF-8 internally, no encoding need to be passed to this method. Annotations @Override

public JsonGenerator createGenerator(OutputStream out) throws IOException

Overrides com.fasterxml.jackson.core.JsonFactory.createGenerator.

Method for constructing JsonGenerator for generating CBOR-encoded output.

Since CBOR format always uses UTF-8 internally, no encoding need to be passed to this method.

Annotations

@Override

createParser back to summary

createParser	back to summary
public JavaPropsParser createParser(Map<?, ?> content) Convenience method to allow feeding a pre-parsed `Properties` instance as input. Since 2.10

public JavaPropsParser createParser(Map<?, ?> content)

Convenience method to allow feeding a pre-parsed Properties instance as input.

Since: 2.10

createParser	back to summary
public JavaPropsParser createParser(Properties props) Deprecated Annotations @Deprecated

createParser back to summary

createParser	back to summary
public JsonParser createParser(File f) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory.createParser. Doc from com.fasterxml.jackson.core.JsonFactory.createParser. Method for constructing JSON parser instance to parse contents of specified file. Encoding is auto-detected from contents according to JSON specification recommended mechanism. Json specification supports only UTF-8, UTF-16 and UTF-32 as valid encodings, so auto-detection implemented only for this charsets. For other charsets use `createParser(java.io.Reader)`. Underlying input stream (needed for reading contents) will be owned (and managed, i.e. closed as need be) by the parser, since caller has no access to it. Parameters f:File File that contains JSON content to parse Annotations @Override

public JsonParser createParser(File f) throws IOException

Overrides com.fasterxml.jackson.core.JsonFactory.createParser.

Doc from com.fasterxml.jackson.core.JsonFactory.createParser.

Method for constructing JSON parser instance to parse contents of specified file.

Encoding is auto-detected from contents according to JSON specification recommended mechanism. Json specification supports only UTF-8, UTF-16 and UTF-32 as valid encodings, so auto-detection implemented only for this charsets. For other charsets use createParser(java.io.Reader).

Underlying input stream (needed for reading contents) will be owned (and managed, i.e. closed as need be) by the parser, since caller has no access to it.

Parameters

f:File: File that contains JSON content to parse

Annotations

@Override

createParser back to summary

createParser	back to summary
public JsonParser createParser(URL url) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory.createParser. Doc from com.fasterxml.jackson.core.JsonFactory.createParser. Method for constructing JSON parser instance to parse contents of resource reference by given URL. Encoding is auto-detected from contents according to JSON specification recommended mechanism. Json specification supports only UTF-8, UTF-16 and UTF-32 as valid encodings, so auto-detection implemented only for this charsets. For other charsets use `createParser(java.io.Reader)`. Underlying input stream (needed for reading contents) will be owned (and managed, i.e. closed as need be) by the parser, since caller has no access to it. Parameters url:URL URL pointing to resource that contains JSON content to parse Annotations @Override

public JsonParser createParser(URL url) throws IOException

Overrides com.fasterxml.jackson.core.JsonFactory.createParser.

Doc from com.fasterxml.jackson.core.JsonFactory.createParser.

Method for constructing JSON parser instance to parse contents of resource reference by given URL.

Underlying input stream (needed for reading contents) will be owned (and managed, i.e. closed as need be) by the parser, since caller has no access to it.

Parameters

url:URL: URL pointing to resource that contains JSON content to parse

Annotations

@Override

createParser back to summary

createParser	back to summary
public JsonParser createParser(InputStream in) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory.createParser. Doc from com.fasterxml.jackson.core.JsonFactory.createParser. Method for constructing JSON parser instance to parse the contents accessed via specified input stream. The input stream will not be owned by the parser, it will still be managed (i.e. closed if end-of-stream is reacher, or parser close method called) if (and only if) `com.fasterxml.jackson.core.StreamReadFeature#AUTO_CLOSE_SOURCE` is enabled. Note no encoding argument is taken since it can always be auto-detected as suggested by JSON RFC. Json specification supports only UTF-8, UTF-16 and UTF-32 as valid encodings, so auto-detection implemented only for this charsets. For other charsets use `createParser(java.io.Reader)`. Parameters in:InputStream InputStream to use for reading JSON content to parse Annotations @Override

public JsonParser createParser(InputStream in) throws IOException

Overrides com.fasterxml.jackson.core.JsonFactory.createParser.

Doc from com.fasterxml.jackson.core.JsonFactory.createParser.

Method for constructing JSON parser instance to parse the contents accessed via specified input stream.

The input stream will not be owned by the parser, it will still be managed (i.e. closed if end-of-stream is reacher, or parser close method called) if (and only if) com.fasterxml.jackson.core.StreamReadFeature#AUTO_CLOSE_SOURCE is enabled.

Note

no encoding argument is taken since it can always be auto-detected as suggested by JSON RFC. Json specification supports only UTF-8, UTF-16 and UTF-32 as valid encodings, so auto-detection implemented only for this charsets. For other charsets use createParser(java.io.Reader).

Parameters

in:InputStream: InputStream to use for reading JSON content to parse

Annotations

@Override

createParser	back to summary
public JsonParser createParser(byte[] data) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory.createParser. Doc from com.fasterxml.jackson.core.JsonFactory.createParser. Method for constructing parser for parsing the contents of given byte array. Annotations @Override

createParser

back to summary

public JsonParser createParser(byte[] data) throws IOException

Overrides com.fasterxml.jackson.core.JsonFactory.createParser.

Doc from com.fasterxml.jackson.core.JsonFactory.createParser.

Method for constructing parser for parsing the contents of given byte array.

Annotations

@Override

createParser	back to summary
public JsonParser createParser(byte[] data, int offset, int len) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory.createParser. Doc from com.fasterxml.jackson.core.JsonFactory.createParser. Method for constructing parser for parsing the contents of given byte array. Parameters data:byte[] Buffer that contains data to parse offset:int Offset of the first data byte within buffer len:int Length of contents to parse within buffer Annotations @Override

createParser

back to summary

public JsonParser createParser(byte[] data, int offset, int len) throws IOException

Overrides com.fasterxml.jackson.core.JsonFactory.createParser.

Doc from com.fasterxml.jackson.core.JsonFactory.createParser.

Method for constructing parser for parsing the contents of given byte array.

Parameters

data:byte[]: Buffer that contains data to parse
offset:int: Offset of the first data byte within buffer
len:int: Length of contents to parse within buffer

Annotations

@Override

getFormatName	back to summary
public String getFormatName() Overrides com.fasterxml.jackson.core.JsonFactory.getFormatName. Doc from com.fasterxml.jackson.core.JsonFactory.getFormatName. Method that returns short textual id identifying format this factory supports. Note sub-classes should override this method; default implementation will return null for all sub-classes Returns:String Name of the format handled by parsers, generators this factory creates Annotations @Override

getFormatName

back to summary

public String getFormatName()

Overrides com.fasterxml.jackson.core.JsonFactory.getFormatName.

Doc from com.fasterxml.jackson.core.JsonFactory.getFormatName.

Method that returns short textual id identifying format this factory supports.

Note

sub-classes should override this method; default implementation will return null for all sub-classes

Returns:String

Name of the format handled by parsers, generators this factory creates

Annotations

@Override

hasFormat	back to summary
public MatchStrength hasFormat(InputAccessor acc) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory.hasFormat. Sub-classes need to override this method Annotations @Override

hasFormat

back to summary

public MatchStrength hasFormat(InputAccessor acc) throws IOException

Overrides com.fasterxml.jackson.core.JsonFactory.hasFormat.

Sub-classes need to override this method

Annotations

@Override

rebuild	back to summary
public JavaPropsFactoryBuilder rebuild() Overrides com.fasterxml.jackson.core.JsonFactory.rebuild. Doc from com.fasterxml.jackson.core.JsonFactory.rebuild. Method that allows construction of differently configured factory, starting with settings of this factory. Returns:JavaPropsFactoryBuilder Builder instance to use Annotations @Override

rebuild

back to summary

public JavaPropsFactoryBuilder rebuild()

Overrides com.fasterxml.jackson.core.JsonFactory.rebuild.

Doc from com.fasterxml.jackson.core.JsonFactory.rebuild.

Method that allows construction of differently configured factory, starting with settings of this factory.

Returns:JavaPropsFactoryBuilder

Builder instance to use

Annotations

@Override

requiresPropertyOrdering back to summary

requiresPropertyOrdering	back to summary
public boolean requiresPropertyOrdering() Overrides com.fasterxml.jackson.core.JsonFactory.requiresPropertyOrdering. Doc from com.fasterxml.jackson.core.JsonFactory.requiresPropertyOrdering. Introspection method that higher-level functionality may call to see whether underlying data format requires a stable ordering of object properties or not. This is usually used for determining whether to force a stable ordering (like alphabetic ordering by name) if no ordering if explicitly specified. Default implementation returns `false` as JSON does NOT require stable ordering. Formats that require ordering include positional textual formats like `CSV`, and schema-based binary formats like `Avro`. Returns:boolean Whether format supported by this factory requires Object properties to be ordered. Annotations @Override

public boolean requiresPropertyOrdering()

Overrides com.fasterxml.jackson.core.JsonFactory.requiresPropertyOrdering.

Doc from com.fasterxml.jackson.core.JsonFactory.requiresPropertyOrdering.

Introspection method that higher-level functionality may call to see whether underlying data format requires a stable ordering of object properties or not. This is usually used for determining whether to force a stable ordering (like alphabetic ordering by name) if no ordering if explicitly specified.

Default implementation returns false as JSON does NOT require stable ordering. Formats that require ordering include positional textual formats like CSV, and schema-based binary formats like Avro.

Returns:boolean

Whether format supported by this factory requires Object properties to be ordered.

Annotations

@Override

version back to summary

version	back to summary
public Version version() Overrides com.fasterxml.jackson.core.JsonFactory.version. Implements com.fasterxml.jackson.core.Versioned.version. Doc from com.fasterxml.jackson.core.Versioned.version. Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (see `Version` for details). Returns:Version Version of the component Annotations @Override

public Version version()

Overrides com.fasterxml.jackson.core.JsonFactory.version.

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

Doc from com.fasterxml.jackson.core.Versioned.version.

Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (see Version for details).

Returns:Version

Version of the component

Annotations

@Override

public Class JavaPropsFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail