JsonFactory (hotwheel-json 5.6.9 API)

java.lang.Object
- org.hotwheel.json.impl.jackson.JsonFactory

所有已实现的接口:

Versioned
```
public class JsonFactory
extends Object
implements Versioned
```
The main factory class of Jackson package, used to configure and construct reader (aka parser, JacksonParser) and writer (aka generator, JsonGenerator) instances.
Factory instances are thread-safe and reusable after configuration (if any). Typically applications and services use only a single globally shared factory instance, unless they need differently configured factories. Factory reuse is important if efficiency matters; most recycling of expensive construct is done on per-factory basis.
Creation of a factory instance is a light-weight operation, and since there is no need for pluggable alternative implementations (as there is no "standard" JSON processor API to implement), the default constructor is used for constructing factory instances.

作者:

Tatu Saloranta

嵌套类概要

嵌套类
限定符和类型类和说明

static class JsonFactory.Feature
Enumeration that defines all on/off features that can only be changed for JsonFactory.

嵌套类
限定符和类型	类和说明
`static class`	`JsonFactory.Feature` Enumeration that defines all on/off features that can only be changed for `JsonFactory`.

字段概要

字段
限定符和类型字段和说明

static String FORMAT_NAME_JSON
Name used to identify JSON format (and returned by getFormatName()

字段
限定符和类型	字段和说明
`static String`	`FORMAT_NAME_JSON` Name used to identify JSON format (and returned by `getFormatName()`

构造器概要

构造器
构造器和说明

JsonFactory()
Default constructor used to create factory instances.

JsonFactory(ObjectCodec oc)

构造器
构造器和说明
`JsonFactory()` Default constructor used to create factory instances.
`JsonFactory(ObjectCodec oc)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`BufferRecycler`	`_getBufferRecycler()` Method used by factory to create buffer recycler instances for parsers and generators.
`JsonFactory`	`configure(JacksonParser.Feature f, boolean state)` Method for enabling or disabling specified parser feature (check `JacksonParser.Feature` for list of features)
`JsonFactory`	`configure(JsonFactory.Feature f, boolean state)` Method for enabling or disabling specified parser feature (check `JacksonParser.Feature` for list of features)
`JsonFactory`	`configure(JsonGenerator.Feature f, boolean state)` Method for enabling or disabling specified generator feature (check `JsonGenerator.Feature` for list of features)
`JsonGenerator`	`createJsonGenerator(File f, JsonEncoding enc)` Method for constructing JSON generator for writing JSON content to specified file, overwriting contents it might have (or creating it if such file does not yet exist).
`JsonGenerator`	`createJsonGenerator(OutputStream out)` Convenience method for constructing generator that uses default encoding of the format (UTF-8 for JSON and most other data formats).
`JsonGenerator`	`createJsonGenerator(OutputStream out, JsonEncoding enc)` Method for constructing JSON generator for writing JSON content using specified output stream.
`JsonGenerator`	`createJsonGenerator(Writer out)` Method for constructing JSON generator for writing JSON content using specified Writer.
`JacksonParser`	`createJsonParser(byte[] data)` Method for constructing parser for parsing the contents of given byte array.
`JacksonParser`	`createJsonParser(byte[] data, int offset, int len)` Method for constructing parser for parsing the contents of given byte array.
`JacksonParser`	`createJsonParser(File f)` Method for constructing JSON parser instance to parse contents of specified file.
`JacksonParser`	`createJsonParser(InputStream in)` Method for constructing JSON parser instance to parse the contents accessed via specified input stream.
`JacksonParser`	`createJsonParser(Reader r)` Method for constructing parser for parsing the contents accessed via specified Reader.
`JacksonParser`	`createJsonParser(String content)` Method for constructing parser for parsing contents of given String.
`JacksonParser`	`createJsonParser(URL url)` Method for constructing JSON parser instance to parse contents of resource reference by given URL.
`JsonFactory`	`disable(JacksonParser.Feature f)` Method for disabling specified parser features (check `JacksonParser.Feature` for list of features)
`JsonFactory`	`disable(JsonFactory.Feature f)` Method for disabling specified parser features (check `JsonFactory.Feature` for list of features)
`JsonFactory`	`disable(JsonGenerator.Feature f)` Method for disabling specified generator feature (check `JsonGenerator.Feature` for list of features)
`JsonFactory`	`enable(JacksonParser.Feature f)` Method for enabling specified parser feature (check `JacksonParser.Feature` for list of features)
`JsonFactory`	`enable(JsonFactory.Feature f)` Method for enabling specified parser feature (check `JsonFactory.Feature` for list of features)
`JsonFactory`	`enable(JsonGenerator.Feature f)` Method for enabling specified generator features (check `JsonGenerator.Feature` for list of features)
`CharacterEscapes`	`getCharacterEscapes()` Method for accessing custom escapes factory uses for `JsonGenerator`s it creates.
`ObjectCodec`	`getCodec()`
`String`	`getFormatName()` Method that returns short textual id identifying format this factory supports.
`InputDecorator`	`getInputDecorator()` Method for getting currently configured input decorator (if any; there is no default decorator).
`OutputDecorator`	`getOutputDecorator()` Method for getting currently configured output decorator (if any; there is no default decorator).
`MatchStrength`	`hasFormat(InputAccessor acc)`
`boolean`	`isEnabled(JacksonParser.Feature f)` Checked whether specified parser feature is enabled.
`boolean`	`isEnabled(JsonFactory.Feature f)` Checked whether specified parser feature is enabled.
`boolean`	`isEnabled(JsonGenerator.Feature f)` Check whether specified generator feature is enabled.
`JsonFactory`	`setCharacterEscapes(CharacterEscapes esc)` Method for defining custom escapes factory uses for `JsonGenerator` s it creates.
`JsonFactory`	`setCodec(ObjectCodec oc)` Method for associating a `ObjectCodec` (typically a `com.fasterxml.jackson.databind.ObjectMapper`) with this factory (and more importantly, parsers and generators it constructs).
`JsonFactory`	`setInputDecorator(InputDecorator d)` Method for overriding currently configured input decorator
`JsonFactory`	`setOutputDecorator(OutputDecorator d)` Method for overriding currently configured output decorator
`Version`	`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).

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - FORMAT_NAME_JSON
```
public static final String FORMAT_NAME_JSON
```
    Name used to identify JSON format (and returned by getFormatName()
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - JsonFactory
```
public JsonFactory()
```
    Default constructor used to create factory instances. Creation of a factory instance is a light-weight operation, but it is still a good idea to reuse limited number of factory instances (and quite often just a single instance): factories are used as context for storing some reused processing objects (such as symbol tables parsers use) and this reuse only works within context of a single factory instance.
  - JsonFactory
```
public JsonFactory(ObjectCodec oc)
```
- 方法详细资料
  - getFormatName
```
public String 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
  - hasFormat
```
public MatchStrength hasFormat(InputAccessor acc)
                        throws IOException
```
    抛出:
    
    IOException
  - version
```
public Version version()
```
    从接口复制的说明: Versioned
    
    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).
    
    指定者:
    
    version 在接口中 Versioned
  - configure
```
public final JsonFactory configure(JsonFactory.Feature f,
                                   boolean state)
```
    Method for enabling or disabling specified parser feature (check JacksonParser.Feature for list of features)
  - enable
```
public JsonFactory enable(JsonFactory.Feature f)
```
    Method for enabling specified parser feature (check JsonFactory.Feature for list of features)
  - disable
```
public JsonFactory disable(JsonFactory.Feature f)
```
    Method for disabling specified parser features (check JsonFactory.Feature for list of features)
  - isEnabled
```
public final boolean isEnabled(JsonFactory.Feature f)
```
    Checked whether specified parser feature is enabled.
  - configure
```
public final JsonFactory configure(JacksonParser.Feature f,
                                   boolean state)
```
    Method for enabling or disabling specified parser feature (check JacksonParser.Feature for list of features)
  - enable
```
public JsonFactory enable(JacksonParser.Feature f)
```
    Method for enabling specified parser feature (check JacksonParser.Feature for list of features)
  - disable
```
public JsonFactory disable(JacksonParser.Feature f)
```
    Method for disabling specified parser features (check JacksonParser.Feature for list of features)
  - isEnabled
```
public final boolean isEnabled(JacksonParser.Feature f)
```
    Checked whether specified parser feature is enabled.
  - getInputDecorator
```
public InputDecorator getInputDecorator()
```
    Method for getting currently configured input decorator (if any; there is no default decorator).
  - setInputDecorator
```
public JsonFactory setInputDecorator(InputDecorator d)
```
    Method for overriding currently configured input decorator
  - configure
```
public final JsonFactory configure(JsonGenerator.Feature f,
                                   boolean state)
```
    Method for enabling or disabling specified generator feature (check JsonGenerator.Feature for list of features)
  - enable
```
public JsonFactory enable(JsonGenerator.Feature f)
```
    Method for enabling specified generator features (check JsonGenerator.Feature for list of features)
  - disable
```
public JsonFactory disable(JsonGenerator.Feature f)
```
    Method for disabling specified generator feature (check JsonGenerator.Feature for list of features)
  - isEnabled
```
public final boolean isEnabled(JsonGenerator.Feature f)
```
    Check whether specified generator feature is enabled.
  - getCharacterEscapes
```
public CharacterEscapes getCharacterEscapes()
```
    Method for accessing custom escapes factory uses for JsonGenerators it creates.
  - setCharacterEscapes
```
public JsonFactory setCharacterEscapes(CharacterEscapes esc)
```
    Method for defining custom escapes factory uses for JsonGenerator s it creates.
  - getOutputDecorator
```
public OutputDecorator getOutputDecorator()
```
    Method for getting currently configured output decorator (if any; there is no default decorator).
  - setOutputDecorator
```
public JsonFactory setOutputDecorator(OutputDecorator d)
```
    Method for overriding currently configured output decorator
  - getCodec
```
public ObjectCodec getCodec()
```
  - setCodec
```
public JsonFactory setCodec(ObjectCodec oc)
```
    Method for associating a ObjectCodec (typically a com.fasterxml.jackson.databind.ObjectMapper) with this factory (and more importantly, parsers and generators it constructs). This is needed to use data-binding methods of JacksonParser and JsonGenerator instances.
  - createJsonParser
```
public JacksonParser createJsonParser(File f)
                               throws IOException,
                                      JsonParseException
```
    Method for constructing JSON parser instance to parse contents of specified file. Encoding is auto-detected from contents according to JSON specification recommended mechanism.
    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.
    
    参数:
    
    f - File that contains JSON content to parse
    
    抛出:
    
    IOException
    
    JsonParseException
  - createJsonParser
```
public JacksonParser createJsonParser(URL url)
                               throws IOException,
                                      JsonParseException
```
    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.
    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.
    
    参数:
    
    url - URL pointing to resource that contains JSON content to parse
    
    抛出:
    
    IOException
    
    JsonParseException
  - createJsonParser
```
public JacksonParser createJsonParser(InputStream in)
                               throws IOException,
                                      JsonParseException
```
    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) JacksonParser.Feature.AUTO_CLOSE_SOURCE is enabled.
    Note: no encoding argument is taken since it can always be auto-detected as suggested by Json RFC.
    
    参数:
    
    in - InputStream to use for reading JSON content to parse
    
    抛出:
    
    IOException
    
    JsonParseException
  - createJsonParser
```
public JacksonParser createJsonParser(Reader r)
                               throws IOException,
                                      JsonParseException
```
    Method for constructing parser for parsing the contents accessed via specified Reader.
    The read 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) JacksonParser.Feature.AUTO_CLOSE_SOURCE is enabled.
    
    参数:
    
    r - Reader to use for reading JSON content to parse
    
    抛出:
    
    IOException
    
    JsonParseException
  - createJsonParser
```
public JacksonParser createJsonParser(byte[] data)
                               throws IOException,
                                      JsonParseException
```
    Method for constructing parser for parsing the contents of given byte array.
    
    抛出:
    
    IOException
    
    JsonParseException
  - createJsonParser
```
public JacksonParser createJsonParser(byte[] data,
                                      int offset,
                                      int len)
                               throws IOException,
                                      JsonParseException
```
    Method for constructing parser for parsing the contents of given byte array.
    
    参数:
    
    data - Buffer that contains data to parse
    
    offset - Offset of the first data byte within buffer
    
    len - Length of contents to parse within buffer
    
    抛出:
    
    IOException
    
    JsonParseException
  - createJsonParser
```
public JacksonParser createJsonParser(String content)
                               throws IOException,
                                      JsonParseException
```
    Method for constructing parser for parsing contents of given String.
    
    抛出:
    
    IOException
    
    JsonParseException
  - createJsonGenerator
```
public JsonGenerator createJsonGenerator(OutputStream out,
                                         JsonEncoding enc)
                                  throws IOException
```
    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, 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.
    
    参数:
    
    out - OutputStream to use for writing JSON content
    
    enc - Character encoding to use
    
    抛出:
    
    IOException
  - createJsonGenerator
```
public JsonGenerator createJsonGenerator(Writer out)
                                  throws IOException
```
    Method for constructing JSON generator for writing JSON content using specified Writer.
    Underlying stream is NOT owned by the generator constructed, so that generator will NOT close the Reader when JsonGenerator.close() is called (unless auto-closing feature, JsonGenerator.Feature.AUTO_CLOSE_TARGET is enabled). Using application needs to close it explicitly.
    
    参数:
    
    out - Writer to use for writing JSON content
    
    抛出:
    
    IOException
  - createJsonGenerator
```
public JsonGenerator createJsonGenerator(OutputStream out)
                                  throws IOException
```
    Convenience method for constructing generator that uses default encoding of the format (UTF-8 for JSON and most other data formats).
    Note: there are formats that use fixed encoding (like most binary data formats).
    
    抛出:
    
    IOException
  - createJsonGenerator
```
public JsonGenerator createJsonGenerator(File f,
                                         JsonEncoding enc)
                                  throws IOException
```
    Method for constructing JSON generator for writing JSON content to specified file, overwriting contents it might have (or creating it if such file does not yet exist). Encoding to use must be specified, and needs to be one of available types (as per JSON specification).
    Underlying stream is owned by the generator constructed, i.e. generator will handle closing of file when JsonGenerator.close() is called.
    
    参数:
    
    f - File to write contents to
    
    enc - Character encoding to use
    
    抛出:
    
    IOException
  - _getBufferRecycler
```
public BufferRecycler _getBufferRecycler()
```
    Method used by factory to create buffer recycler instances for parsers and generators.
    Note: only public to give access for ObjectMapper

类 JsonFactory

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

FORMAT_NAME_JSON

构造器详细资料

JsonFactory

JsonFactory

方法详细资料

getFormatName

hasFormat

version

configure

enable

disable

isEnabled

configure

enable

disable

isEnabled

getInputDecorator

setInputDecorator

configure

enable

disable

isEnabled

getCharacterEscapes

setCharacterEscapes

getOutputDecorator

setOutputDecorator

getCodec

setCodec

createJsonParser

createJsonParser

createJsonParser

createJsonParser

createJsonParser

createJsonParser

createJsonParser

createJsonGenerator

createJsonGenerator

createJsonGenerator

createJsonGenerator

_getBufferRecycler