Top Fields Constructors Methods
tools.jackson.dataformat.javaprop

public Class JavaPropsFactory

extends TextualTSFactory
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Annotations
@SuppressWarnings:resource
Imports
java.io.*, java.util.*, tools.jackson.core.*, tools.jackson.core.base.TextualTSFactory, tools.jackson.core.exc.StreamReadException, tools.jackson.core.io.IOContext, tools.jackson.dataformat.javaprop.impl.PropertiesBackedGenerator, .WriterBackedGenerator, tools.jackson.dataformat.javaprop.io.Latin1Reader

Field Summary

Modifier and TypeField and Description
protected static final String
CHARSET_ID_LATIN1

pack-priv static final JavaPropsSchema
EMPTY_SCHEMA

public static final String
FORMAT_NAME_JAVA_PROPERTIES

private static final long
serialVersionUID

Hides tools.jackson.core.base.TextualTSFactory.serialVersionUID.

Constructor Summary

AccessConstructor and Description
public
JavaPropsFactory()

protected
JavaPropsFactory(JavaPropsFactory src)

protected
JavaPropsFactory(JavaPropsFactoryBuilder b)

Constructors used by JavaPropsFactoryBuilder for instantiation.

Method Summary

Modifier and TypeMethod and Description
protected JsonGenerator
_createGenerator(ObjectWriteContext writeCtxt, IOContext ioCtxt, Writer out)

Implements abstract tools.jackson.core.base.TextualTSFactory._createGenerator.

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

protected JsonParser
_createParser(ObjectReadContext readCtxt, IOContext ioCtxt, InputStream in)

Implements abstract tools.jackson.core.base.TextualTSFactory._createParser.

protected JsonParser
_createParser(ObjectReadContext readCtxt, IOContext ioCtxt, Reader r)

Implements abstract tools.jackson.core.base.TextualTSFactory._createParser.

protected JsonParser
_createParser(ObjectReadContext readCtxt, IOContext ioCtxt, char[] data, int offset, int len, boolean recyclable)

Implements abstract tools.jackson.core.base.TextualTSFactory._createParser.

protected JsonParser
_createParser(ObjectReadContext readCtxt, IOContext ioCtxt, byte[] data, int offset, int len)

Implements abstract tools.jackson.core.base.TextualTSFactory._createParser.

protected JsonParser
_createParser(ObjectReadContext readCtxt, IOContext ctxt, DataInput input)

Implements abstract tools.jackson.core.base.TextualTSFactory._createParser.

protected JsonGenerator
_createUTF8Generator(ObjectWriteContext writeCtxt, IOContext ioCtxt, OutputStream out)

Implements abstract tools.jackson.core.base.TextualTSFactory._createUTF8Generator.

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

protected Writer
_createWriter(IOContext ctioCtxtxt, OutputStream out, JsonEncoding enc)

Overrides tools.jackson.core.base.TextualTSFactory._createWriter.

private final JavaPropsSchema
_getSchema(ObjectReadContext readCtxt)

private final JavaPropsSchema
_getSchema(ObjectWriteContext ctxt)

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()

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

public boolean
canParseAsync()

Implements abstract tools.jackson.core.TokenStreamFactory.canParseAsync.

Introspection method that can be used to check whether this factory can create non-blocking parsers: parsers that do not use blocking I/O abstractions but instead use a tools.jackson.core.async.NonBlockingInputFeeder.

public boolean
canUseCharArrays()

Overrides tools.jackson.core.base.TextualTSFactory.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)

Implements abstract tools.jackson.core.TokenStreamFactory.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()

Implements abstract tools.jackson.core.TokenStreamFactory.copy.

Method similar to snapshot(), but one that forces creation of actual new copy that does NOT share any state, even non-visible to calling code, such as symbol table reuse.

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

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

public JavaPropsParser
createParser(ObjectReadContext readCtxt, JavaPropsSchema schema, Map<?, ?> content)

Convenience method to allow feeding a pre-parsed Properties (or, generally java.util.Map) instance as input.

public String
getFormatName()

Implements abstract tools.jackson.core.TokenStreamFactory.getFormatName.

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

public int
getFormatReadFeatures()

Overrides tools.jackson.core.TokenStreamFactory.getFormatReadFeatures.

public Class<? extends FormatFeature>
getFormatReadFeatureType()

Overrides tools.jackson.core.TokenStreamFactory.getFormatReadFeatureType.

Method for accessing kind of FormatFeature that a parser JsonParser produced by this factory would accept, if any; null returned if none.

public int
getFormatWriteFeatures()

Overrides tools.jackson.core.TokenStreamFactory.getFormatWriteFeatures.

public Class<? extends FormatFeature>
getFormatWriteFeatureType()

Overrides tools.jackson.core.TokenStreamFactory.getFormatWriteFeatureType.

Method for accessing kind of FormatFeature that a parser JsonGenerator produced by this factory would accept, if any; null returned if none.

public JavaPropsFactoryBuilder
rebuild()

Implements abstract tools.jackson.core.TokenStreamFactory.rebuild.

Method that can be used to create differently configured stream factories: it will create and return a Builder instance with exact settings of this stream factory.

public boolean
requiresPropertyOrdering()

Overrides tools.jackson.core.TokenStreamFactory.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 TokenStreamFactory
snapshot()

Implements abstract tools.jackson.core.TokenStreamFactory.snapshot.

Implements tools.jackson.core.util.Snapshottable.snapshot.

Instances are immutable so just return `this`

public Version
version()

Implements abstract tools.jackson.core.TokenStreamFactory.version.

Implements tools.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 tools.jackson.core.base.TextualTSFactory:
_createContentReference_createContentReferencecanHandleBinaryNativelycreateGeneratorcreateGeneratorcreateGeneratorcreateGeneratorcreateParsercreateParsercreateParsercreateParsercreateParsercreateParsercreateParsercreateParser

Field Detail

CHARSET_ID_LATIN1back to summary
protected static final String CHARSET_ID_LATIN1
EMPTY_SCHEMAback to summary
pack-priv static final JavaPropsSchema EMPTY_SCHEMA
FORMAT_NAME_JAVA_PROPERTIESback to summary
public static final String FORMAT_NAME_JAVA_PROPERTIES
serialVersionUIDback to summary
private static final long serialVersionUID

Hides tools.jackson.core.base.TextualTSFactory.serialVersionUID.

Constructor Detail

JavaPropsFactoryback to summary
public JavaPropsFactory()
JavaPropsFactoryback to summary
protected JavaPropsFactory(JavaPropsFactory src)
JavaPropsFactoryback to summary
protected JavaPropsFactory(JavaPropsFactoryBuilder b)

Constructors used by JavaPropsFactoryBuilder for instantiation.

Since
3.0

Method Detail

_createGeneratorback to summary
protected JsonGenerator _createGenerator(ObjectWriteContext writeCtxt, IOContext ioCtxt, Writer out)

Implements abstract tools.jackson.core.base.TextualTSFactory._createGenerator.

Doc from tools.jackson.core.base.TextualTSFactory._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.

Annotations
@Override
_createParserback to summary
protected JsonParser _createParser(ObjectReadContext readCtxt, IOContext ioCtxt, InputStream in)

Implements abstract tools.jackson.core.base.TextualTSFactory._createParser.

Annotations
@Override
_createParserback to summary
protected JsonParser _createParser(ObjectReadContext readCtxt, IOContext ioCtxt, Reader r)

Implements abstract tools.jackson.core.base.TextualTSFactory._createParser.

Annotations
@Override
_createParserback to summary
protected JsonParser _createParser(ObjectReadContext readCtxt, IOContext ioCtxt, char[] data, int offset, int len, boolean recyclable)

Implements abstract tools.jackson.core.base.TextualTSFactory._createParser.

Annotations
@Override
_createParserback to summary
protected JsonParser _createParser(ObjectReadContext readCtxt, IOContext ioCtxt, byte[] data, int offset, int len)

Implements abstract tools.jackson.core.base.TextualTSFactory._createParser.

Annotations
@Override
_createParserback to summary
protected JsonParser _createParser(ObjectReadContext readCtxt, IOContext ctxt, DataInput input)

Implements abstract tools.jackson.core.base.TextualTSFactory._createParser.

Annotations
@Override
_createUTF8Generatorback to summary
protected JsonGenerator _createUTF8Generator(ObjectWriteContext writeCtxt, IOContext ioCtxt, OutputStream out)

Implements abstract tools.jackson.core.base.TextualTSFactory._createUTF8Generator.

Doc from tools.jackson.core.base.TextualTSFactory._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.

Annotations
@Override
_createWriterback to summary
protected Writer _createWriter(IOContext ctioCtxtxt, OutputStream out, JsonEncoding enc)

Overrides tools.jackson.core.base.TextualTSFactory._createWriter.

Annotations
@Override
_getSchemaback to summary
private final JavaPropsSchema _getSchema(ObjectReadContext readCtxt)
_getSchemaback to summary
private final JavaPropsSchema _getSchema(ObjectWriteContext ctxt)
_loadPropertiesback to summary
protected Properties _loadProperties(InputStream in, IOContext ctxt)
_loadPropertiesback to summary
protected Properties _loadProperties(Reader r0, IOContext ctxt)
_reportReadExceptionback to summary
protected <T> T _reportReadException(String msg, Exception rootCause)
builderback to summary
public static JavaPropsFactoryBuilder builder()

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

canParseAsyncback to summary
public boolean canParseAsync()

Implements abstract tools.jackson.core.TokenStreamFactory.canParseAsync.

Doc from tools.jackson.core.TokenStreamFactory.canParseAsync.

Introspection method that can be used to check whether this factory can create non-blocking parsers: parsers that do not use blocking I/O abstractions but instead use a tools.jackson.core.async.NonBlockingInputFeeder.

Annotations
@Override
canUseCharArraysback to summary
public boolean canUseCharArrays()

Overrides tools.jackson.core.base.TextualTSFactory.canUseCharArrays.

Doc from tools.jackson.core.base.TextualTSFactory.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.

Default implementation simply returns true

Annotations
@Override
canUseSchemaback to summary
public boolean canUseSchema(FormatSchema schema)

Implements abstract tools.jackson.core.TokenStreamFactory.canUseSchema.

Doc from tools.jackson.core.TokenStreamFactory.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.

Annotations
@Override
copyback to summary
public JavaPropsFactory copy()

Implements abstract tools.jackson.core.TokenStreamFactory.copy.

Doc from tools.jackson.core.TokenStreamFactory.copy.

Method similar to snapshot(), but one that forces creation of actual new copy that does NOT share any state, even non-visible to calling code, such as symbol table reuse.

Implementation should be functionally equivalent to: 

    factoryInstance.rebuild().build();
Annotations
@Override
createGeneratorback to summary
public JavaPropsGenerator createGenerator(ObjectWriteContext writeCtxt, JavaPropsSchema schema, Map<?, ?> target)

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

createParserback to summary
public JavaPropsParser createParser(ObjectReadContext readCtxt, JavaPropsSchema schema, Map<?, ?> content)

Convenience method to allow feeding a pre-parsed Properties (or, generally java.util.Map) instance as input.

getFormatNameback to summary
public String getFormatName()

Implements abstract tools.jackson.core.TokenStreamFactory.getFormatName.

Doc from tools.jackson.core.TokenStreamFactory.getFormatName.

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

Annotations
@Override
getFormatReadFeaturesback to summary
public int getFormatReadFeatures()

Overrides tools.jackson.core.TokenStreamFactory.getFormatReadFeatures.

Annotations
@Override
getFormatReadFeatureTypeback to summary
public Class<? extends FormatFeature> getFormatReadFeatureType()

Overrides tools.jackson.core.TokenStreamFactory.getFormatReadFeatureType.

Doc from tools.jackson.core.TokenStreamFactory.getFormatReadFeatureType.

Method for accessing kind of FormatFeature that a parser JsonParser produced by this factory would accept, if any; null returned if none.

Annotations
@Override
getFormatWriteFeaturesback to summary
public int getFormatWriteFeatures()

Overrides tools.jackson.core.TokenStreamFactory.getFormatWriteFeatures.

Annotations
@Override
getFormatWriteFeatureTypeback to summary
public Class<? extends FormatFeature> getFormatWriteFeatureType()

Overrides tools.jackson.core.TokenStreamFactory.getFormatWriteFeatureType.

Doc from tools.jackson.core.TokenStreamFactory.getFormatWriteFeatureType.

Method for accessing kind of FormatFeature that a parser JsonGenerator produced by this factory would accept, if any; null returned if none.

Annotations
@Override
rebuildback to summary
public JavaPropsFactoryBuilder rebuild()

Implements abstract tools.jackson.core.TokenStreamFactory.rebuild.

Doc from tools.jackson.core.TokenStreamFactory.rebuild.

Method that can be used to create differently configured stream factories: it will create and return a Builder instance with exact settings of this stream factory.

Annotations
@Override
requiresPropertyOrderingback to summary
public boolean requiresPropertyOrdering()

Overrides tools.jackson.core.TokenStreamFactory.requiresPropertyOrdering.

Doc from tools.jackson.core.TokenStreamFactory.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.

Annotations
@Override
snapshotback to summary
public TokenStreamFactory snapshot()

Implements abstract tools.jackson.core.TokenStreamFactory.snapshot.

Implements tools.jackson.core.util.Snapshottable.snapshot.

Instances are immutable so just return `this`

Annotations
@Override
versionback to summary
public Version version()

Implements abstract tools.jackson.core.TokenStreamFactory.version.

Implements tools.jackson.core.Versioned.version.

Doc from tools.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).

Annotations
@Override