org.json.simple.Jsonable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of json-simple Show documentation

Java 7+ toolkit to quickly develop RFC 4627 JSON compatible applications.

There is a newer version: 4.0.1

/* Copyright 2016 Clifton Labs

   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.json.simple;

import java.io.IOException;
import java.io.Writer;

/** Jsonables can be serialized in java script object notation (JSON).
 * @since 2.0.0 */
public interface Jsonable{
    /** Serialize to a JSON formatted string.
     * @return a string, formatted in JSON, that represents the Jsonable. */
    public String toJson();

    /** Serialize to a JSON formatted stream.
     * @param writable where the resulting JSON text should be sent.
     * @throws IOException when the writable encounters an I/O error. */
    public void toJson(Writer writable) throws IOException;
}