package com.fasterxml.jackson.dataformat.yaml;
import java.io.*;
import java.net.URL;
import java.nio.charset.Charset;
import org.yaml.snakeyaml.DumperOptions;
import com.fasterxml.jackson.core.*;
import com.fasterxml.jackson.core.format.InputAccessor;
import com.fasterxml.jackson.core.format.MatchStrength;
import com.fasterxml.jackson.core.io.IOContext;
public class YAMLFactory extends JsonFactory
{
private static final long serialVersionUID = 1171663157274350349L;
/**
* Name used to identify YAML format.
* (and returned by {@link #getFormatName()}
*/
public final static String FORMAT_NAME_YAML = "YAML";
/**
* Bitfield (set of flags) of all parser features that are enabled
* by default.
*/
protected final static int DEFAULT_YAML_PARSER_FEATURE_FLAGS = YAMLParser.Feature.collectDefaults();
/**
* Bitfield (set of flags) of all generator features that are enabled
* by default.
*/
protected final static int DEFAULT_YAML_GENERATOR_FEATURE_FLAGS = YAMLGenerator.Feature.collectDefaults();
private final static byte UTF8_BOM_1 = (byte) 0xEF;
private final static byte UTF8_BOM_2 = (byte) 0xBB;
private final static byte UTF8_BOM_3 = (byte) 0xBF;
/*
/**********************************************************************
/* Configuration
/**********************************************************************
*/
protected int _yamlParserFeatures = DEFAULT_YAML_PARSER_FEATURE_FLAGS;
protected int _yamlGeneratorFeatures = DEFAULT_YAML_GENERATOR_FEATURE_FLAGS;
/*
/**********************************************************************
/* Factory construction, configuration
/**********************************************************************
*/
protected DumperOptions.Version _version;
/**
* 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.
*/
public YAMLFactory() { this(null); }
public YAMLFactory(ObjectCodec oc)
{
super(oc);
_yamlParserFeatures = DEFAULT_YAML_PARSER_FEATURE_FLAGS;
_yamlGeneratorFeatures = DEFAULT_YAML_GENERATOR_FEATURE_FLAGS;
/* 26-Jul-2013, tatu: Seems like we should force output as 1.1 but
* that adds version declaration which looks ugly...
*/
//_version = DumperOptions.Version.V1_1;
_version = null;
}
/**
* @since 2.2.1
*/
public YAMLFactory(YAMLFactory src, ObjectCodec oc)
{
super(src, oc);
_version = src._version;
_yamlParserFeatures = src._yamlParserFeatures;
_yamlGeneratorFeatures = src._yamlGeneratorFeatures;
}
@Override
public YAMLFactory copy()
{
_checkInvalidCopy(YAMLFactory.class);
return new YAMLFactory(this, null);
}
/*
/**********************************************************
/* Serializable overrides
/**********************************************************
*/
/**
* Method that we need to override to actually make restoration go
* through constructors etc.
* Also: must be overridden by sub-classes as well.
*/
@Override
protected Object readResolve() {
return new YAMLFactory(this, _objectCodec);
}
/*
/**********************************************************
/* Versioned
/**********************************************************
*/
@Override
public Version version() {
return PackageVersion.VERSION;
}
/*
/**********************************************************
/* Capability introspection
/**********************************************************
*/
// No, we can't make use of char[] optimizations
@Override
public boolean canUseCharArrays() { return false; }
/*
/**********************************************************
/* Format detection functionality (since 1.8)
/**********************************************************
*/
@Override
public String getFormatName() {
return FORMAT_NAME_YAML;
}
/**
* Sub-classes need to override this method (as of 1.8)
*/
@Override
public MatchStrength hasFormat(InputAccessor acc) throws IOException
{
/* Actually quite possible to do, thanks to (optional) "---"
* indicator we may be getting...
*/
if (!acc.hasMoreBytes()) {
return MatchStrength.INCONCLUSIVE;
}
byte b = acc.nextByte();
// Very first thing, a UTF-8 BOM?
if (b == UTF8_BOM_1) { // yes, looks like UTF-8 BOM
if (!acc.hasMoreBytes()) {
return MatchStrength.INCONCLUSIVE;
}
if (acc.nextByte() != UTF8_BOM_2) {
return MatchStrength.NO_MATCH;
}
if (!acc.hasMoreBytes()) {
return MatchStrength.INCONCLUSIVE;
}
if (acc.nextByte() != UTF8_BOM_3) {
return MatchStrength.NO_MATCH;
}
if (!acc.hasMoreBytes()) {
return MatchStrength.INCONCLUSIVE;
}
b = acc.nextByte();
}
// as far as I know, leading space is NOT allowed before "---" marker?
if (b == '-' && (acc.hasMoreBytes() && acc.nextByte() == '-')
&& (acc.hasMoreBytes() && acc.nextByte() == '-')) {
return MatchStrength.FULL_MATCH;
}
return MatchStrength.INCONCLUSIVE;
}
/*
/**********************************************************
/* Configuration, parser settings
/**********************************************************
*/
/**
* Method for enabling or disabling specified parser feature
* (check {@link YAMLParser.Feature} for list of features)
*/
public final YAMLFactory configure(YAMLParser.Feature f, boolean state)
{
if (state) {
enable(f);
} else {
disable(f);
}
return this;
}
/**
* Method for enabling specified parser feature
* (check {@link YAMLParser.Feature} for list of features)
*/
public YAMLFactory enable(YAMLParser.Feature f) {
_yamlParserFeatures |= f.getMask();
return this;
}
/**
* Method for disabling specified parser features
* (check {@link YAMLParser.Feature} for list of features)
*/
public YAMLFactory disable(YAMLParser.Feature f) {
_yamlParserFeatures &= ~f.getMask();
return this;
}
/**
* Checked whether specified parser feature is enabled.
*/
public final boolean isEnabled(YAMLParser.Feature f) {
return (_yamlParserFeatures & f.getMask()) != 0;
}
/*
/**********************************************************
/* Configuration, generator settings
/**********************************************************
*/
/**
* Method for enabling or disabling specified generator feature
* (check {@link YAMLGenerator.Feature} for list of features)
*/
public final YAMLFactory configure(YAMLGenerator.Feature f, boolean state) {
if (state) {
enable(f);
} else {
disable(f);
}
return this;
}
/**
* Method for enabling specified generator features
* (check {@link YAMLGenerator.Feature} for list of features)
*/
public YAMLFactory enable(YAMLGenerator.Feature f) {
_yamlGeneratorFeatures |= f.getMask();
return this;
}
/**
* Method for disabling specified generator feature
* (check {@link YAMLGenerator.Feature} for list of features)
*/
public YAMLFactory disable(YAMLGenerator.Feature f) {
_yamlGeneratorFeatures &= ~f.getMask();
return this;
}
/**
* Check whether specified generator feature is enabled.
*/
public final boolean isEnabled(YAMLGenerator.Feature f) {
return (_yamlGeneratorFeatures & f.getMask()) != 0;
}
/*
/**********************************************************
/* Overridden parser factory methods (for 2.1)
/**********************************************************
*/
@Override
public YAMLParser createParser(String content) throws IOException {
return createParser(new StringReader(content));
}
@SuppressWarnings("resource")
@Override
public YAMLParser createParser(File f) throws IOException
{
IOContext ctxt = _createContext(f, true);
InputStream in = new FileInputStream(f);
// [JACKSON-512]: allow wrapping with InputDecorator
if (_inputDecorator != null) {
in = _inputDecorator.decorate(ctxt, in);
}
return _createParser(in, ctxt);
}
@SuppressWarnings("resource")
@Override
public YAMLParser createParser(URL url) throws IOException
{
IOContext ctxt = _createContext(url, true);
InputStream in = _optimizedStreamFromURL(url);
// [JACKSON-512]: allow wrapping with InputDecorator
if (_inputDecorator != null) {
in = _inputDecorator.decorate(ctxt, in);
}
return _createParser(in, ctxt);
}
@SuppressWarnings("resource")
@Override
public YAMLParser createParser(InputStream in) throws IOException
{
IOContext ctxt = _createContext(in, false);
// [JACKSON-512]: allow wrapping with InputDecorator
if (_inputDecorator != null) {
in = _inputDecorator.decorate(ctxt, in);
}
return _createParser(in, ctxt);
}
@SuppressWarnings("resource")
@Override
public YAMLParser createParser(Reader r) throws IOException
{
IOContext ctxt = _createContext(r, false);
if (_inputDecorator != null) {
r = _inputDecorator.decorate(ctxt, r);
}
return _createParser(r, ctxt);
}
@Override // since 2.4
public YAMLParser createParser(char[] data) throws IOException {
return createParser(new CharArrayReader(data, 0, data.length));
}
@Override // since 2.4
public YAMLParser createParser(char[] data, int offset, int len) throws IOException {
return createParser(new CharArrayReader(data, offset, len));
}
@SuppressWarnings("resource")
@Override
public YAMLParser createParser(byte[] data) throws IOException
{
IOContext ctxt = _createContext(data, true);
// [JACKSON-512]: allow wrapping with InputDecorator
if (_inputDecorator != null) {
InputStream in = _inputDecorator.decorate(ctxt, data, 0, data.length);
if (in != null) {
return _createParser(in, ctxt);
}
}
return _createParser(data, 0, data.length, ctxt);
}
@SuppressWarnings("resource")
@Override
public YAMLParser createParser(byte[] data, int offset, int len) throws IOException
{
IOContext ctxt = _createContext(data, true);
// [JACKSON-512]: allow wrapping with InputDecorator
if (_inputDecorator != null) {
InputStream in = _inputDecorator.decorate(ctxt, data, offset, len);
if (in != null) {
return _createParser(in, ctxt);
}
}
return _createParser(data, offset, len, ctxt);
}
/*
/**********************************************************
/* Overridden generator factory methods (2.1)
/**********************************************************
*/
@SuppressWarnings("resource")
@Override
public YAMLGenerator createGenerator(OutputStream out, JsonEncoding enc) throws IOException
{
// false -> we won't manage the stream unless explicitly directed to
IOContext ctxt = _createContext(out, false);
// [JACKSON-512]: allow wrapping with _outputDecorator
if (_outputDecorator != null) {
out = _outputDecorator.decorate(ctxt, out);
}
return _createGenerator(_createWriter(out, JsonEncoding.UTF8, ctxt), ctxt);
}
@SuppressWarnings("resource")
@Override
public YAMLGenerator createGenerator(OutputStream out) throws IOException
{
// false -> we won't manage the stream unless explicitly directed to
IOContext ctxt = _createContext(out, false);
// [JACKSON-512]: allow wrapping with _outputDecorator
if (_outputDecorator != null) {
out = _outputDecorator.decorate(ctxt, out);
}
return _createGenerator(_createWriter(out, JsonEncoding.UTF8, ctxt), ctxt);
}
@SuppressWarnings("resource")
@Override
public YAMLGenerator createGenerator(Writer out) throws IOException
{
IOContext ctxt = _createContext(out, false);
// [JACKSON-512]: allow wrapping with _outputDecorator
if (_outputDecorator != null) {
out = _outputDecorator.decorate(ctxt, out);
}
return _createGenerator(out, ctxt);
}
/*
/******************************************************
/* Overridden internal factory methods
/******************************************************
*/
//protected IOContext _createContext(Object srcRef, boolean resourceManaged)
@Override
protected YAMLParser _createParser(InputStream in, IOContext ctxt) throws IOException {
return new YAMLParser(ctxt, _getBufferRecycler(), _parserFeatures, _yamlParserFeatures,
_objectCodec, _createReader(in, null, ctxt));
}
@Override
protected YAMLParser _createParser(Reader r, IOContext ctxt) throws IOException {
return new YAMLParser(ctxt, _getBufferRecycler(), _parserFeatures, _yamlParserFeatures,
_objectCodec, r);
}
// since 2.4
@Override
protected YAMLParser _createParser(char[] data, int offset, int len, IOContext ctxt,
boolean recyclable) throws IOException {
return new YAMLParser(ctxt, _getBufferRecycler(), _parserFeatures, _yamlParserFeatures,
_objectCodec, new CharArrayReader(data, offset, len));
}
@Override
protected YAMLParser _createParser(byte[] data, int offset, int len, IOContext ctxt) throws IOException {
return new YAMLParser(ctxt, _getBufferRecycler(), _parserFeatures, _yamlParserFeatures,
_objectCodec, _createReader(data, offset, len, null, ctxt));
}
@Override
protected YAMLGenerator _createGenerator(Writer out, IOContext ctxt) throws IOException {
int feats = _yamlGeneratorFeatures;
YAMLGenerator gen = new YAMLGenerator(ctxt, _generatorFeatures, feats,
_objectCodec, out, _version);
// any other initializations? No?
return gen;
}
@Override
protected Writer _createWriter(OutputStream out, JsonEncoding enc, IOContext ctxt) throws IOException {
if (enc == JsonEncoding.UTF8) {
return new UTF8Writer(out);
}
return new OutputStreamWriter(out, enc.getJavaName());
}
/*
/**********************************************************
/* Internal methods
/**********************************************************
*/
protected final Charset UTF8 = Charset.forName("UTF-8");
protected Reader _createReader(InputStream in, JsonEncoding enc, IOContext ctxt) throws IOException
{
if (enc == null) {
enc = JsonEncoding.UTF8;
}
// default to UTF-8 if encoding missing
if (enc == JsonEncoding.UTF8) {
boolean autoClose = ctxt.isResourceManaged() || isEnabled(JsonParser.Feature.AUTO_CLOSE_SOURCE);
return new UTF8Reader(in, autoClose);
// return new InputStreamReader(in, UTF8);
}
return new InputStreamReader(in, enc.getJavaName());
}
protected Reader _createReader(byte[] data, int offset, int len,
JsonEncoding enc, IOContext ctxt) throws IOException
{
if (enc == null) {
enc = JsonEncoding.UTF8;
}
// default to UTF-8 if encoding missing
if (enc == null || enc == JsonEncoding.UTF8) {
return new UTF8Reader(data, offset, len, true);
}
ByteArrayInputStream in = new ByteArrayInputStream(data, offset, len);
return new InputStreamReader(in, enc.getJavaName());
}
}