org.dominokit.jackson.stream.JsonWriter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of domino-jackson Show documentation
Apt based jackson
The newest version!
/*
 * Copyright 2013 Nicolas Morel
 *
 * 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 org.dominokit.jackson.stream;

/** JsonWriter interface. */
public interface JsonWriter {

  /**
   * Sets the indentation string to be repeated for each level of indentation in the encoded
   * document. If {@code indent.isEmpty()} the encoded document will be compact. Otherwise the
   * encoded document will be more human-readable.
   *
   * @param indent a string containing only whitespace.
   */
  void setIndent(String indent);

  /**
   * Configure this writer to relax its syntax rules. By default, this writer only emits well-formed
   * JSON as specified by RFC 4627. Setting the
   * writer to lenient permits the following:
   *
   * 
   *   Top-level values of any type. With strict writing, the top-level value must be an object
   *       or an array.
   *   
Numbers may be {@link java.lang.Double#isNaN() NaNs} or {@link Double#isInfinite()
   *       infinities}.
   * 
   *
   * @param lenient a boolean.
   */
  void setLenient(boolean lenient);

  /**
   * Sets whether object members are serialized when their value is null. This has no impact on
   * array elements. The default is true.
   *
   * @param serializeNulls a boolean.
   */
  void setSerializeNulls(boolean serializeNulls);

  /**
   * getSerializeNulls
   *
   * @return a boolean.
   */
  boolean getSerializeNulls();

  /**
   * Begins encoding a new array. Each call to this method must be paired with a call to {@link
   * #endArray}.
   *
   * @return this writer.
   */
  JsonWriter beginArray();

  /**
   * Ends encoding the current array.
   *
   * @return this writer.
   */
  JsonWriter endArray();

  /**
   * Begins encoding a new object. Each call to this method must be paired with a call to {@link
   * #endObject}.
   *
   * @return this writer.
   */
  JsonWriter beginObject();

  /**
   * Ends encoding the current object.
   *
   * @return this writer.
   */
  JsonWriter endObject();

  /**
   * Encodes the property name.
   *
   * @param name the name of the forthcoming value. May not be null.
   * @return this writer.
   */
  JsonWriter name(String name);

  /**
   * Encodes the property name without escaping it.
   *
   * @param name the name of the forthcoming value. May not be null.
   * @return this writer.
   */
  JsonWriter unescapeName(String name);

  /**
   * Encodes {@code value}.
   *
   * @param value the literal string value, or null to encode a null literal.
   * @return this writer.
   */
  JsonWriter value(String value);

  /**
   * Encodes {@code value} without escaping it.
   *
   * @param value the literal string value, or null to encode a null literal.
   * @return this writer.
   */
  JsonWriter unescapeValue(String value);

  /**
   * Encodes {@code null}.
   *
   * @return this writer.
   */
  JsonWriter nullValue();

  /**
   * cancelName
   *
   * @return a {@link org.dominokit.jackson.stream.JsonWriter} object.
   */
  JsonWriter cancelName();

  /**
   * Encodes {@code value}.
   *
   * @param value a boolean.
   * @return this writer.
   */
  JsonWriter value(boolean value);

  /**
   * Encodes {@code value}.
   *
   * @param value a finite value. May not be {@link java.lang.Double#isNaN() NaNs} or {@link
   *     java.lang.Double#isInfinite() infinities}.
   * @return this writer.
   */
  JsonWriter value(double value);

  /**
   * Encodes {@code value}.
   *
   * @param value a long.
   * @return this writer.
   */
  JsonWriter value(long value);

  /**
   * Encodes {@code value}.
   *
   * @param value a finite value. May not be {@link java.lang.Double#isNaN() NaNs} or {@link
   *     java.lang.Double#isInfinite() infinities}.
   * @return this writer.
   */
  JsonWriter value(Number value);

  /**
   * Encodes {@code value}.toString() as is.
   *
   * @param value a value .
   * @return this writer.
   */
  JsonWriter rawValue(Object value);

  /**
   * Ensures all buffered data is written to the underlying {@link java.lang.StringBuilder} and
   * flushes that writer.
   */
  void flush();

  /** Flushes and closes this writer and the underlying {@link java.lang.StringBuilder}. */
  void close();

  /**
   * getOutput
   *
   * @return the output when the serialization is over
   */
  String getOutput();
}