com.fasterxml.jackson.dataformat.avro.AvroParser Maven / Gradle / Ivy
package com.fasterxml.jackson.dataformat.avro;
import java.io.*;
import com.fasterxml.jackson.core.*;
import com.fasterxml.jackson.core.base.ParserBase;
import com.fasterxml.jackson.core.io.IOContext;
import com.fasterxml.jackson.core.json.JsonReadContext;
import com.fasterxml.jackson.core.util.ByteArrayBuilder;
import com.fasterxml.jackson.dataformat.avro.deser.AvroReadContext;
import com.fasterxml.jackson.dataformat.avro.deser.MissingReader;
/**
* {@link JsonParser} implementation for decoding Avro content and
* exposing at as a stream of {@link JsonToken}s, to be used
* for data binding.
*/
public abstract class AvroParser extends ParserBase
{
/**
* Enumeration that defines all togglable features for Avro parsers.
*/
public enum Feature
implements FormatFeature // since 2.7
{
/**
* Feature that can be disabled to prevent Avro from buffering any more
* data then absolutely necessary.
* This affects buffering by underlying `SnakeYAML` codec.
*
* Enabled by default to preserve the existing behavior.
*
* @since 2.7
*/
AVRO_BUFFERING(true)
;
final boolean _defaultState;
final int _mask;
/**
* Method that calculates bit set (flags) of all features that
* are enabled by default.
*/
public static int collectDefaults()
{
int flags = 0;
for (Feature f : values()) {
if (f.enabledByDefault()) {
flags |= f.getMask();
}
}
return flags;
}
private Feature(boolean defaultState) {
_defaultState = defaultState;
_mask = (1 << ordinal());
}
@Override
public boolean enabledByDefault() { return _defaultState; }
@Override
public int getMask() { return _mask; }
@Override
public boolean enabledIn(int flags) { return (flags & _mask) != 0; }
}
/*
/**********************************************************************
/* Configuration
/**********************************************************************
*/
/**
* Codec used for data binding when (if) requested.
*/
protected ObjectCodec _objectCodec;
protected AvroSchema _rootSchema;
protected int _formatFeatures;
/*
/**********************************************************************
/* Input sources
/**********************************************************************
*/
final protected InputStream _input;
/*
/**********************************************************************
/* State
/**********************************************************************
*/
protected AvroReadContext _avroContext;
/**
* We need to keep track of text values.
*/
protected String _textValue;
/*
/**********************************************************************
/* Life-cycle
/**********************************************************************
*/
protected AvroParser(IOContext ctxt, int parserFeatures, int avroFeatures,
ObjectCodec codec, InputStream in)
{
super(ctxt, parserFeatures);
_objectCodec = codec;
_formatFeatures = avroFeatures;
_input = in;
_avroContext = MissingReader.instance;
}
protected AvroParser(IOContext ctxt, int parserFeatures, int avroFeatures,
ObjectCodec codec,
byte[] data, int offset, int len)
{
super(ctxt, parserFeatures);
_objectCodec = codec;
_formatFeatures = avroFeatures;
_input = null;
_avroContext = MissingReader.instance;
}
@Override
public ObjectCodec getCodec() {
return _objectCodec;
}
@Override
public void setCodec(ObjectCodec c) {
_objectCodec = c;
}
@Override
public Object getInputSource() {
return _input;
}
// ensure impl defines
@Override
public abstract JsonParser overrideFormatFeatures(int values, int mask);
/*
/**********************************************************
/* Versioned
/**********************************************************
*/
@Override
public Version version() {
return PackageVersion.VERSION;
}
/*
/**********************************************************
/* ParserBase method impls
/**********************************************************
*/
@Override
protected void _finishString() throws IOException {
_reportUnsupportedOperation();
}
@Override
protected void _closeInput() throws IOException {
if (_input != null) {
_input.close();
}
}
/*
/***************************************************
/* Public API, configuration
/***************************************************
*/
/**
* Method for enabling specified Avro feature
* (check {@link Feature} for list of features)
*/
public JsonParser enable(AvroParser.Feature f) {
_formatFeatures |= f.getMask();
return this;
}
/**
* Method for disabling specified Avro feature
* (check {@link Feature} for list of features)
*/
public JsonParser disable(AvroParser.Feature f) {
_formatFeatures &= ~f.getMask();
return this;
}
/**
* Method for enabling or disabling specified Avro feature
* (check {@link Feature} for list of features)
*/
public JsonParser configure(AvroParser.Feature f, boolean state)
{
if (state) {
enable(f);
} else {
disable(f);
}
return this;
}
/**
* Method for checking whether specified Avro {@link Feature}
* is enabled.
*/
public boolean isEnabled(AvroParser.Feature f) {
return (_formatFeatures & f.getMask()) != 0;
}
@Override
public boolean canUseSchema(FormatSchema schema) {
return (schema instanceof AvroSchema);
}
@Override public AvroSchema getSchema() {
return _rootSchema;
}
@Override
public void setSchema(FormatSchema schema)
{
if (_rootSchema == schema) {
return;
}
if (schema instanceof AvroSchema) {
_initSchema((AvroSchema) schema);
} else {
super.setSchema(schema);
}
}
protected abstract void _initSchema(AvroSchema schema);
/*
/**********************************************************
/* Location info
/**********************************************************
*/
@Override
public JsonLocation getTokenLocation()
{
// !!! TODO
return null;
}
@Override
public JsonLocation getCurrentLocation()
{
// !!! TODO
return null;
}
/*
/**********************************************************
/* Parsing
/**********************************************************
*/
@Override
public abstract JsonToken nextToken() throws IOException;
/*
/**********************************************************
/* String value handling
/**********************************************************
*/
// For now we do not store char[] representation...
@Override
public boolean hasTextCharacters() {
return false;
}
@Override
public String getText() throws IOException
{
if (_currToken == JsonToken.VALUE_STRING) {
return _textValue;
}
if (_currToken == JsonToken.FIELD_NAME) {
return _avroContext.getCurrentName();
}
if (_currToken != null) {
if (_currToken.isScalarValue()) {
return _textValue;
}
return _currToken.asString();
}
return null;
}
@Override // since 2.8
public int getText(Writer writer) throws IOException
{
JsonToken t = _currToken;
if (t == JsonToken.VALUE_STRING) {
writer.write(_textValue);
return _textValue.length();
}
if (t == JsonToken.FIELD_NAME) {
String n = _parsingContext.getCurrentName();
writer.write(n);
return n.length();
}
if (t != null) {
if (t.isNumeric()) {
return _textBuffer.contentsToWriter(writer);
}
char[] ch = t.asCharArray();
writer.write(ch);
return ch.length;
}
return 0;
}
@Override
public String getCurrentName() throws IOException {
return _avroContext.getCurrentName();
}
@Override
public void overrideCurrentName(String name)
{
// Simple, but need to look for START_OBJECT/ARRAY's "off-by-one" thing:
JsonReadContext ctxt = _parsingContext;
if (_currToken == JsonToken.START_OBJECT || _currToken == JsonToken.START_ARRAY) {
ctxt = ctxt.getParent();
}
/* 24-Sep-2013, tatu: Unfortunate, but since we did not expose exceptions,
* need to wrap this here
*/
try {
ctxt.setCurrentName(name);
} catch (IOException e) {
throw new IllegalStateException(e);
}
}
@Override
public char[] getTextCharacters() throws IOException {
String text = getText();
return (text == null) ? null : text.toCharArray();
}
@Override
public int getTextLength() throws IOException {
String text = getText();
return (text == null) ? 0 : text.length();
}
@Override
public int getTextOffset() throws IOException {
return 0;
}
/*
/**********************************************************************
/* Binary (base64)
/**********************************************************************
*/
@Override
public Object getEmbeddedObject() throws IOException {
return _binaryValue;
}
@Override
public byte[] getBinaryValue(Base64Variant variant) throws IOException
{
if (_binaryValue == null) {
if (_currToken != JsonToken.VALUE_STRING) {
_reportError("Current token ("+_currToken+") not VALUE_STRING, can not access as binary");
}
@SuppressWarnings("resource")
ByteArrayBuilder builder = _getByteArrayBuilder();
_decodeBase64(getText(), builder, variant);
_binaryValue = builder.toByteArray();
}
return _binaryValue;
}
}