com.box.boxjavalibv2.jsonparsing.IBoxJSONParser Maven / Gradle / Ivy

Go to download
package com.box.boxjavalibv2.jsonparsing;

import java.io.IOException;
import java.io.InputStream;

import com.box.boxjavalibv2.exceptions.BoxJSONException;

public interface IBoxJSONParser {

    /**
     * Convert the object into String. No exception will be thrown, in case of failure, null is returned.
     * 
     * @param object
     * @return
     */
    String convertBoxObjectToJSONStringQuietly(final Object object);

    /**
     * Convert InputStream to object.No exception will be thrown, in case of failure, null is returned.
     * 
     * @param inputStream
     * @param theClass
     * @return
     */
     T parseIntoBoxObjectQuietly(final InputStream inputStream, final Class theClass);

    /**
     * Convert the json string into object.No exception will be thrown, in case of failure, null is returned.
     * 
     * @param jsonString
     * @param theClass
     * @return
     */
     T parseIntoBoxObjectQuietly(final String jsonString, final Class theClass);

    /**
     * Convert the object into String.
     * 
     * @param object
     * @return
     * @throws BoxJSONException
     * @throws IOException
     */
    String convertBoxObjectToJSONString(final Object object) throws BoxJSONException, IOException;

    /**
     * Convert InputStream to object.
     * 
     * @param inputStream
     * @param theClass
     * @return
     * @throws BoxJSONException
     * @throws IOException
     */
     T parseIntoBoxObject(final InputStream inputStream, final Class theClass) throws BoxJSONException, IOException;

    /**
     * Convert the json string into object.
     * 
     * @param jsonString
     * @param theClass
     * @return
     * @throws BoxJSONException
     * @throws IOException
     */
     T parseIntoBoxObject(final String jsonString, final Class theClass) throws BoxJSONException, IOException;
}