|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.jackson.JsonFactory
org.codehaus.jackson.smile.SmileFactory
public class SmileFactory
Factory used for constructing SmileParser
and SmileGenerator
instances; both of which handle
Smile encoded data.
Extends JsonFactory
mostly so that users can actually use it in place
of regular non-Smile factory instances.
Note on using non-byte-based sources/targets (char based, like
Reader
and Writer
): these can not be
used for Smile-format documents, and thus will either downgrade to
textual JSON (when parsing), or throw exception (when trying to create
generator).
Field Summary | |
---|---|
protected boolean |
_cfgDelegateToTextual
Whether non-supported methods (ones trying to output using char-based targets like Writer , for example)
should be delegated to regular Jackson JSON processing
(if set to true); or throw UnsupportedOperationException
(if set to false) |
protected int |
_smileGeneratorFeatures
|
protected int |
_smileParserFeatures
|
static String |
FORMAT_NAME_SMILE
Name used to identify Smile format. |
Fields inherited from class org.codehaus.jackson.JsonFactory |
---|
_characterEscapes, _generatorFeatures, _inputDecorator, _objectCodec, _outputDecorator, _parserFeatures, _recyclerRef, _rootByteSymbols, _rootCharSymbols, FORMAT_NAME_JSON |
Constructor Summary | |
---|---|
SmileFactory()
Default constructor used to create factory instances. |
|
SmileFactory(ObjectCodec oc)
|
Method Summary | |
---|---|
protected SmileGenerator |
_createJsonGenerator(OutputStream out,
IOContext ctxt)
|
protected JsonGenerator |
_createJsonGenerator(Writer out,
IOContext ctxt)
Overridable factory method that actually instantiates desired generator. |
protected SmileParser |
_createJsonParser(byte[] data,
int offset,
int len,
IOContext ctxt)
Overridable factory method that actually instantiates desired parser. |
protected SmileParser |
_createJsonParser(InputStream in,
IOContext ctxt)
Overridable factory method that actually instantiates desired parser. |
protected JsonParser |
_createJsonParser(Reader r,
IOContext ctxt)
Overridable factory method that actually instantiates desired parser. |
protected Writer |
_createWriter(OutputStream out,
JsonEncoding enc,
IOContext ctxt)
|
SmileFactory |
configure(SmileGenerator.Feature f,
boolean state)
Method for enabling or disabling specified generator feature (check JsonGenerator.Feature for list of features) |
SmileFactory |
configure(SmileParser.Feature f,
boolean state)
Method for enabling or disabling specified parser feature (check SmileParser.Feature for list of features) |
SmileGenerator |
createJsonGenerator(OutputStream out)
Since Smile format always uses UTF-8 internally, no encoding need to be passed to this method. |
SmileGenerator |
createJsonGenerator(OutputStream out,
JsonEncoding enc)
note: co-variant return type |
SmileParser |
createJsonParser(byte[] data)
Method for constructing parser for parsing the contents of given byte array. |
SmileParser |
createJsonParser(byte[] data,
int offset,
int len)
Method for constructing parser for parsing the contents of given byte array. |
SmileParser |
createJsonParser(File f)
Method for constructing JSON parser instance to parse contents of specified file. |
SmileParser |
createJsonParser(InputStream in)
Method for constructing JSON parser instance to parse the contents accessed via specified input stream. |
SmileParser |
createJsonParser(URL url)
Method for constructing JSON parser instance to parse contents of resource reference by given URL. |
void |
delegateToTextual(boolean state)
|
SmileFactory |
disable(SmileGenerator.Feature f)
Method for disabling specified generator feature (check JsonGenerator.Feature for list of features) |
SmileFactory |
disable(SmileParser.Feature f)
Method for disabling specified parser features (check SmileParser.Feature for list of features) |
SmileFactory |
enable(SmileGenerator.Feature f)
Method for enabling specified generator features (check JsonGenerator.Feature for list of features) |
SmileFactory |
enable(SmileParser.Feature f)
Method for enabling specified parser feature (check SmileParser.Feature for list of features) |
String |
getFormatName()
Method that returns short textual id identifying format this factory supports. |
MatchStrength |
hasFormat(InputAccessor acc)
Sub-classes need to override this method (as of 1.8) |
boolean |
isEnabled(SmileGenerator.Feature f)
Check whether specified generator feature is enabled. |
boolean |
isEnabled(SmileParser.Feature f)
Checked whether specified parser feature is enabled. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String FORMAT_NAME_SMILE
getFormatName()
protected boolean _cfgDelegateToTextual
Writer
, for example)
should be delegated to regular Jackson JSON processing
(if set to true); or throw UnsupportedOperationException
(if set to false)
protected int _smileParserFeatures
protected int _smileGeneratorFeatures
Constructor Detail |
---|
public SmileFactory()
public SmileFactory(ObjectCodec oc)
Method Detail |
---|
public void delegateToTextual(boolean state)
public String getFormatName()
JsonFactory
Note: sub-classes should override this method; default implementation will return null for all sub-classes
getFormatName
in class JsonFactory
public MatchStrength hasFormat(InputAccessor acc) throws IOException
hasFormat
in class JsonFactory
IOException
public final SmileFactory configure(SmileParser.Feature f, boolean state)
SmileParser.Feature
for list of features)
public SmileFactory enable(SmileParser.Feature f)
SmileParser.Feature
for list of features)
public SmileFactory disable(SmileParser.Feature f)
SmileParser.Feature
for list of features)
public final boolean isEnabled(SmileParser.Feature f)
public final SmileFactory configure(SmileGenerator.Feature f, boolean state)
JsonGenerator.Feature
for list of features)
public SmileFactory enable(SmileGenerator.Feature f)
JsonGenerator.Feature
for list of features)
public SmileFactory disable(SmileGenerator.Feature f)
JsonGenerator.Feature
for list of features)
public final boolean isEnabled(SmileGenerator.Feature f)
public SmileParser createJsonParser(File f) throws IOException, JsonParseException
JsonFactory
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.
createJsonParser
in class JsonFactory
f
- File that contains JSON content to parse
IOException
JsonParseException
public SmileParser createJsonParser(URL url) throws IOException, JsonParseException
JsonFactory
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.
createJsonParser
in class JsonFactory
url
- URL pointing to resource that contains JSON content to parse
IOException
JsonParseException
public SmileParser createJsonParser(InputStream in) throws IOException, JsonParseException
JsonFactory
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) JsonParser.Feature.AUTO_CLOSE_SOURCE
is enabled.
Note: no encoding argument is taken since it can always be auto-detected as suggested by Json RFC.
createJsonParser
in class JsonFactory
in
- InputStream to use for reading JSON content to parse
IOException
JsonParseException
public SmileParser createJsonParser(byte[] data) throws IOException, JsonParseException
JsonFactory
createJsonParser
in class JsonFactory
IOException
JsonParseException
public SmileParser createJsonParser(byte[] data, int offset, int len) throws IOException, JsonParseException
JsonFactory
createJsonParser
in class JsonFactory
data
- Buffer that contains data to parseoffset
- Offset of the first data byte within bufferlen
- Length of contents to parse within buffer
IOException
JsonParseException
public SmileGenerator createJsonGenerator(OutputStream out, JsonEncoding enc) throws IOException
note: co-variant return type
createJsonGenerator
in class JsonFactory
out
- OutputStream to use for writing JSON contentenc
- Character encoding to use
IOException
public SmileGenerator createJsonGenerator(OutputStream out) throws IOException
createJsonGenerator
in class JsonFactory
IOException
protected SmileParser _createJsonParser(InputStream in, IOContext ctxt) throws IOException, JsonParseException
_createJsonParser
in class JsonFactory
IOException
JsonParseException
protected JsonParser _createJsonParser(Reader r, IOContext ctxt) throws IOException, JsonParseException
_createJsonParser
in class JsonFactory
IOException
JsonParseException
protected SmileParser _createJsonParser(byte[] data, int offset, int len, IOContext ctxt) throws IOException, JsonParseException
_createJsonParser
in class JsonFactory
IOException
JsonParseException
protected JsonGenerator _createJsonGenerator(Writer out, IOContext ctxt) throws IOException
_createJsonGenerator
in class JsonFactory
IOException
protected Writer _createWriter(OutputStream out, JsonEncoding enc, IOContext ctxt) throws IOException
_createWriter
in class JsonFactory
IOException
protected SmileGenerator _createJsonGenerator(OutputStream out, IOContext ctxt) throws IOException
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |