io.github.matteobertozzi.yajbe.YajbeFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jackson-dataformat-yajbe Show documentation
YAJBE is a compact binary data format built to be a drop-in replacement for JSON (JavaScript Object Notation).
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.github.matteobertozzi.yajbe;

import java.io.InputStream;
import java.io.OutputStream;
import java.io.Reader;
import java.io.Writer;

import com.fasterxml.jackson.core.JsonFactory;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.io.IOContext;

import io.github.matteobertozzi.yajbe.YajbeEnumMapping.YajbeEnumMappingConfig;

/**
 * Factory used for constructing {@link YajbeParser} and {@link YajbeGenerator}
 * instances; both of which handle
 * YAJBE
 * encoded data.
 * 
 * Extends {@link JsonFactory} mostly so that users can actually use it in place
 * of regular JSON factory instances.
 * 
 * Note on using non-byte-based sources/targets (char based, like
 * {@link java.io.Reader} and {@link java.io.Writer}): these can not be
 * used; attempt will throw exception.
 */
public class YajbeFactory extends JsonFactory {
  private static final long serialVersionUID = 1; // 2.6

  /** the enum mapping configuration that will be passed to the YajbeGenerator */
  private final YajbeEnumMappingConfig enumConfig;

  /**
   * Creates a new YajbeFactory without enum mapping
   */
  public YajbeFactory() {
    super();
    this.enumConfig = null;
  }

  /**
   * Creates a new YajbeFactory with the specified enum mapping config
   * @param enumConfig the enum-mapping configuration
   */
  public YajbeFactory(final YajbeEnumMappingConfig enumConfig) {
    this.enumConfig = enumConfig;
  }


  @Override public String getFormatName() { return "YAJBE"; }

  @Override public boolean requiresPropertyOrdering() { return false; }
  @Override public boolean canHandleBinaryNatively() { return true; }
  @Override public boolean canUseCharArrays() { return false; }

  @Override
  protected YajbeParser _createParser(final InputStream in, final IOContext ctxt) {
    return new YajbeParser(ctxt, _parserFeatures, _objectCodec, YajbeReader.fromStream(in));
  }

  @Override
  protected JsonParser _createParser(final Reader r, final IOContext ctxt) {
    throw new UnsupportedOperationException();
  }

  @Override
  protected JsonParser _createParser(final char[] data, final int offset, final int len, final IOContext ctxt,
                                     final boolean recyclable) {
    throw new UnsupportedOperationException();
  }

  @Override
  protected YajbeParser _createParser(final byte[] data, final int offset, final int len, final IOContext ctxt) {
    return new YajbeParser(ctxt, _parserFeatures, _objectCodec, YajbeReader.fromBytes(data, offset, len));
  }

  @Override
  protected YajbeGenerator _createGenerator(final Writer out, final IOContext ctxt) {
    throw new UnsupportedOperationException();
  }

  @Override
  protected YajbeGenerator _createUTF8Generator(final OutputStream out, final IOContext ctxt) {
    return new YajbeGenerator(ctxt, _generatorFeatures, _objectCodec, out, enumConfig);
  }
}