org.apache.wink.json4j.JSONArtifact Maven / Gradle / Ivy
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 org.apache.wink.json4j;
import java.io.OutputStream;
import java.io.Writer;
/**
* Interface class to define a set of generic apis both JSONObject and JSONArray implement.
* This is namely so that functions such as write, which are common between the two, can be easily
* invoked without knowing the object type.
*/
public interface JSONArtifact
{
/**
* Write this object to the stream as JSON text in UTF-8 encoding. Same as calling write(os,false);
* Note that encoding is always written as UTF-8, as per JSON spec.
* @param os The output stream to write data to.
* @return The passed in OutputStream.
*
* @throws JSONException Thrown on errors during serialization.
*/
public OutputStream write(OutputStream os) throws JSONException;
/**
* Write this object to the stream as JSON text in UTF-8 encoding, specifying whether to use verbose (tab-indented) output or not.
* Note that encoding is always written as UTF-8, as per JSON spec.
* @param os The output stream to write data to.
* @param verbose Whether or not to write the JSON text in a verbose format. If true, will indent via tab.
* @return The passed in OutputStream.
*
* @throws JSONException Thrown on errors during serialization.
*/
public OutputStream write(OutputStream os, boolean verbose) throws JSONException;
/**
* Write this object to the stream as JSON text in UTF-8 encoding, specifying how many spaces should be used for each indent.
* This is an alternate indent style to using tabs.
* @param indentDepth How many spaces to use for each indent. The value should be between one to eight.
* Less than one means no indenting, greater than 8 and it will just use tab.
* @return The passed in OutputStream.
*
* @throws JSONException Thrown on errors during serialization.
*/
public OutputStream write(OutputStream os, int indentDepth) throws JSONException;
/**
* Write this object to the writer as JSON text. Same as calling write(writer,false);
* @param writer The writer which to write the JSON text to.
* @return The passed in writer.
*
* @throws JSONException Thrown on errors during serialization.
*/
public Writer write(Writer writer) throws JSONException;
/**
* Writer this object to the writer as JSON text, specifying whether to use verbose (tab-indented) output or not.
* be used for each indent. This is an alternate indent style to using tabs.
* @param writer The writer which to write the JSON text to.
* @return The passed in writer.
*
* @throws JSONException Thrown on errors during serialization.
*/
public Writer write(Writer writer, boolean verbose) throws JSONException;
/**
* Write this object to the writer as JSON text, specifying how many spaces should be used for each indent.
* This is an alternate indent style to using tabs.
* @param writer The writer which to write the JSON text to.
* @param indentDepth How many spaces to use for each indent. The value should be between one to eight.
* @return The passed in writer.
*
* @throws JSONException Thrown on errors during serialization.
*/
public Writer write(Writer writer, int indentDepth) throws JSONException;
/**
* Convert this object into a String of JSON text, specifying whether to use verbose (tab-indented) output or not.
* @param verbose Whether or not to write in compressed format.
* Less than one means no indenting, greater than 8 and it will just use tab.
*
* @throws JSONException Thrown on errors during serialization.
*/
public String write(boolean verbose) throws JSONException;
/**
* Convert this object into a String of JSON text, specifying how many spaces should be used for each indent.
* This is an alternate indent style to using tabs.
* @param indentDepth How many spaces to use for each indent. The value should be between one to eight.
* Less than one means no indenting, greater than 8 and it will just use tab.
*
* @throws JSONException Thrown on errors during serialization.
*/
public String write(int indentDepth) throws JSONException;
/**
* Convert this object into a String of JSON text. Same as write(false);
*
* @throws JSONException Thrown on errors during serialization.
*/
public String write() throws JSONException;
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy