org.dominokit.jacksonapt.JsonDeserializationContext Maven / Gradle / Ivy

Go to download
package org.dominokit.jacksonapt;

import com.fasterxml.jackson.annotation.ObjectIdGenerator;
import org.dominokit.jacksonapt.exception.JsonDeserializationException;
import org.dominokit.jacksonapt.stream.JsonReader;

/**
 * JsonDeserializationContext interface.
 *
 * @author vegegoku
 * @version $Id: $Id
 */
public interface JsonDeserializationContext extends JsonMappingContext {
    /**
     * isFailOnUnknownProperties.
     *
     * @return a boolean.
     */
    boolean isFailOnUnknownProperties();

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

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

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

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

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

    /**
     * newJsonReader.
     *
     * @param input a {@link java.lang.String} object.
     * @return a {@link org.dominokit.jacksonapt.stream.JsonReader} object.
     */
    JsonReader newJsonReader(String input);

    /**
     * traceError.
     *
     * @param message a {@link java.lang.String} object.
     * @return a {@link org.dominokit.jacksonapt.exception.JsonDeserializationException} object.
     */
    JsonDeserializationException traceError(String message);

    /**
     * traceError.
     *
     * @param message a {@link java.lang.String} object.
     * @param reader a {@link org.dominokit.jacksonapt.stream.JsonReader} object.
     * @return a {@link org.dominokit.jacksonapt.exception.JsonDeserializationException} object.
     */
    JsonDeserializationException traceError(String message, JsonReader reader);

    /**
     * traceError.
     *
     * @param cause a {@link java.lang.RuntimeException} object.
     * @return a {@link java.lang.RuntimeException} object.
     */
    RuntimeException traceError(RuntimeException cause);

    /**
     * traceError.
     *
     * @param cause a {@link java.lang.RuntimeException} object.
     * @param reader a {@link org.dominokit.jacksonapt.stream.JsonReader} object.
     * @return a {@link java.lang.RuntimeException} object.
     */
    RuntimeException traceError(RuntimeException cause, JsonReader reader);

    /**
     * addObjectId.
     *
     * @param id a {@link com.fasterxml.jackson.annotation.ObjectIdGenerator.IdKey} object.
     * @param instance a {@link java.lang.Object} object.
     */
    void addObjectId(ObjectIdGenerator.IdKey id, Object instance);

    /**
     * getObjectWithId.
     *
     * @param id a {@link com.fasterxml.jackson.annotation.ObjectIdGenerator.IdKey} object.
     * @return a {@link java.lang.Object} object.
     */
    Object getObjectWithId(ObjectIdGenerator.IdKey id);

    /**
     * defaultParameters.
     *
     * @return a {@link org.dominokit.jacksonapt.JsonDeserializerParameters} object.
     */
    JsonDeserializerParameters defaultParameters();
}