com.google.api.client.json.JsonGenerator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-client Show documentation
Google API Client Library for Java. Supports Java 5 (or higher) desktop (SE) and web (EE), Android, and Google App Engine.
There is a newer version: 1.4.1-beta
Show newest version
/*
 * Copyright (c) 2010 Google Inc.
 *
 * Licensed 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 com.google.api.client.json;

import com.google.api.client.util.ClassInfo;
import com.google.api.client.util.DataUtil;
import com.google.api.client.util.DateTime;

import java.io.IOException;
import java.lang.reflect.Field;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.util.List;
import java.util.Map;

/**
 * Abstract low-level JSON serializer.
 *
 * @since 1.3
 * @author Yaniv Inbar
 */
public abstract class JsonGenerator {

  /** Returns the JSON factory from which this generator was created. */
  public abstract JsonFactory getFactory();

  /**
   * Flushes any buffered content to the underlying output stream or writer.
   *
   * @throws IOException if failed
   */
  public abstract void flush() throws IOException;

  /**
   * Closes the serializer and the underlying output stream or writer, and releases any memory
   * associated with it.
   *
   * @throws IOException if failed
   */
  public abstract void close() throws IOException;

  /**
   * Writes a JSON start array character '['.
   *
   * @throws IOException if failed
   */
  public abstract void writeStartArray() throws IOException;

  /**
   * Writes a JSON end array character ']'.
   *
   * @throws IOException if failed
   */
  public abstract void writeEndArray() throws IOException;

  /**
   * Writes a JSON start object character '{'.
   *
   * @throws IOException if failed
   */
  public abstract void writeStartObject() throws IOException;

  /**
   * Writes a JSON end object character '}'.
   *
   * @throws IOException if failed
   */
  public abstract void writeEndObject() throws IOException;

  /**
   * Writes a JSON quoted field name.
   *
   * @throws IOException if failed
   */
  public abstract void writeFieldName(String name) throws IOException;

  /**
   * Writes a literal JSON null value.
   *
   * @throws IOException if failed
   */
  public abstract void writeNull() throws IOException;

  /**
   * Writes a JSON quoted string value.
   *
   * @throws IOException if failed
   */
  public abstract void writeString(String value) throws IOException;

  /**
   * Writes a literal JSON boolean value ('true' or 'false').
   *
   * @throws IOException if failed
   */
  public abstract void writeBoolean(boolean state) throws IOException;

  /**
   * Writes a JSON int value.
   *
   * @throws IOException if failed
   */
  public abstract void writeNumber(int v) throws IOException;

  /**
   * Writes a JSON long value.
   *
   * @throws IOException if failed
   */
  public abstract void writeNumber(long v) throws IOException;

  /**
   * Writes a JSON big integer value.
   *
   * @throws IOException if failed
   */
  public abstract void writeNumber(BigInteger v) throws IOException;

  /**
   * Writes a JSON float value.
   *
   * @throws IOException if failed
   */
  public abstract void writeNumber(float v) throws IOException;

  /**
   * Writes a JSON double value.
   *
   * @throws IOException if failed
   */
  public abstract void writeNumber(double v) throws IOException;

  /**
   * Writes a JSON big decimal value.
   *
   * @throws IOException if failed
   */
  public abstract void writeNumber(BigDecimal v) throws IOException;

  /**
   * Writes a JSON numeric value that has already been encoded properly.
   *
   * @throws IOException if failed
   */
  public abstract void writeNumber(String encodedValue) throws IOException;

  /**
   * Serializes the given JSON value object.
   *
   * @param value JSON value object
   * @throws IOException if failed
   */
  public final void serialize(Object value) throws IOException {
    if (value == null) {
      writeNull();
    }
    if (value instanceof String) {
      writeString((String) value);
    } else if (value instanceof BigDecimal) {
      writeNumber((BigDecimal) value);
    } else if (value instanceof BigInteger) {
      writeNumber((BigInteger) value);
    } else if (value instanceof Double) {
      // TODO(yanivi): double: what about +- infinity?
      writeNumber((Double) value);
    } else if (value instanceof Long) {
      writeNumber((Long) value);
    } else if (value instanceof Float) {
      // TODO(yanivi): what about +- infinity?
      writeNumber((Float) value);
    } else if (value instanceof Integer || value instanceof Short || value instanceof Byte) {
      writeNumber(((Number) value).intValue());
    } else if (value instanceof Boolean) {
      writeBoolean((Boolean) value);
    } else if (value instanceof DateTime) {
      writeString(((DateTime) value).toStringRfc3339());
    } else if (value instanceof List) {
      writeStartArray();
      @SuppressWarnings("unchecked")
      List