com.github.nmorel.gwtjackson.client.JsonSerializerParameters Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwt-jackson Show documentation
gwt-jackson is a GWT JSON serializer/deserializer mechanism based on Jackson annotations
There is a newer version: 0.15.4
/*
 * 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 com.github.nmorel.gwtjackson.client;

import java.util.HashSet;
import java.util.Set;

import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.annotation.JsonFormat.Shape;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.github.nmorel.gwtjackson.client.ser.IterableJsonSerializer;
import com.github.nmorel.gwtjackson.client.ser.bean.IdentitySerializationInfo;
import com.github.nmorel.gwtjackson.client.ser.bean.TypeSerializationInfo;
import com.google.gwt.i18n.client.TimeZone;

/**
 * This class includes parameters defined through properties annotations like {@link JsonFormat}. They are specific to one
 * {@link JsonSerializer} and that's why they are not contained inside {@link JsonSerializationContext}.
 * 
 * For container serializers like {@link IterableJsonSerializer}, these parameters are passed to the value serializer.
 * 
 *
 * @author Nicolas Morel
 * @version $Id: $
 */
public final class JsonSerializerParameters {

    /** Constant DEFAULT */
    public static final JsonSerializerParameters DEFAULT = new JsonSerializerParameters();

    /**
     * Datatype-specific additional piece of configuration that may be used
     * to further refine formatting aspects. This may, for example, determine
     * low-level format String used for {@link java.util.Date} serialization;
     * however, exact use is determined by specific {@link JsonSerializer}
     */
    private String pattern;

    /**
     * Structure to use for serialization: definition of mapping depends on datatype,
     * but usually has straight-forward counterpart in data format (JSON).
     * Note that commonly only a subset of shapes is available; and if 'invalid' value
     * is chosen, defaults are usually used.
     */
    private Shape shape = Shape.ANY;

    /**
     * Locale to use for serialization (if needed).
     */
    private String locale;

    /**
     * Timezone to use for serialization (if needed).
     */
    private TimeZone timezone;

    /**
     * Names of properties to ignore.
     */
    private Set ignoredProperties;

    /**
     * Inclusion rule to use.
     */
    private Include include;

    /**
     * Bean identity informations
     */
    private IdentitySerializationInfo identityInfo;

    /**
     * Bean type informations
     */
    private TypeSerializationInfo typeInfo;

    /**
     * If true, all the properties of an object will be serialized inside the current object.
     */
    private boolean unwrapped = false;

    /**
     * Getter for the field pattern.
     *
     * @return a {@link java.lang.String} object.
     */
    public String getPattern() {
        return pattern;
    }

    /**
     * Setter for the field pattern.
     *
     * @param pattern a {@link java.lang.String} object.
     * @return a {@link com.github.nmorel.gwtjackson.client.JsonSerializerParameters} object.
     */
    public JsonSerializerParameters setPattern( String pattern ) {
        this.pattern = pattern;
        return this;
    }

    /**
     * Getter for the field shape.
     *
     * @return a {@link com.fasterxml.jackson.annotation.JsonFormat.Shape} object.
     */
    public Shape getShape() {
        return shape;
    }

    /**
     * Setter for the field shape.
     *
     * @param shape a {@link com.fasterxml.jackson.annotation.JsonFormat.Shape} object.
     * @return a {@link com.github.nmorel.gwtjackson.client.JsonSerializerParameters} object.
     */
    public JsonSerializerParameters setShape( Shape shape ) {
        this.shape = shape;
        return this;
    }

    /**
     * Getter for the field locale.
     *
     * @return a {@link java.lang.String} object.
     */
    public String getLocale() {
        return locale;
    }

    /**
     * Setter for the field locale.
     *
     * @param locale a {@link java.lang.String} object.
     * @return a {@link com.github.nmorel.gwtjackson.client.JsonSerializerParameters} object.
     */
    public JsonSerializerParameters setLocale( String locale ) {
        this.locale = locale;
        return this;
    }

    /**
     * Getter for the field timezone.
     *
     * @return a {@link com.google.gwt.i18n.client.TimeZone} object.
     */
    public TimeZone getTimezone() {
        return timezone;
    }

    /**
     * Setter for the field timezone.
     *
     * @param timezone a {@link com.google.gwt.i18n.client.TimeZone} object.
     * @return a {@link com.github.nmorel.gwtjackson.client.JsonSerializerParameters} object.
     */
    public JsonSerializerParameters setTimezone( TimeZone timezone ) {
        this.timezone = timezone;
        return this;
    }

    /**
     * Getter for the field ignoredProperties.
     *
     * @return a {@link java.util.Set} object.
     */
    public Set getIgnoredProperties() {
        return ignoredProperties;
    }

    /**
     * addIgnoredProperty
     *
     * @param ignoredProperty a {@link java.lang.String} object.
     * @return a {@link com.github.nmorel.gwtjackson.client.JsonSerializerParameters} object.
     */
    public JsonSerializerParameters addIgnoredProperty( String ignoredProperty ) {
        if ( null == ignoredProperties ) {
            ignoredProperties = new HashSet();
        }
        ignoredProperties.add( ignoredProperty );
        return this;
    }

    /**
     * Getter for the field include.
     *
     * @return a {@link com.fasterxml.jackson.annotation.JsonInclude.Include} object.
     */
    public Include getInclude() {
        return include;
    }

    /**
     * Setter for the field include.
     *
     * @param include a {@link com.fasterxml.jackson.annotation.JsonInclude.Include} object.
     * @return a {@link com.github.nmorel.gwtjackson.client.JsonSerializerParameters} object.
     */
    public JsonSerializerParameters setInclude( Include include ) {
        this.include = include;
        return this;
    }

    /**
     * Getter for the field identityInfo.
     *
     * @return a {@link com.github.nmorel.gwtjackson.client.ser.bean.IdentitySerializationInfo} object.
     */
    public IdentitySerializationInfo getIdentityInfo() {
        return identityInfo;
    }

    /**
     * Setter for the field identityInfo.
     *
     * @param identityInfo a {@link com.github.nmorel.gwtjackson.client.ser.bean.IdentitySerializationInfo} object.
     * @return a {@link com.github.nmorel.gwtjackson.client.JsonSerializerParameters} object.
     */
    public JsonSerializerParameters setIdentityInfo( IdentitySerializationInfo identityInfo ) {
        this.identityInfo = identityInfo;
        return this;
    }

    /**
     * Getter for the field typeInfo.
     *
     * @return a {@link com.github.nmorel.gwtjackson.client.ser.bean.TypeSerializationInfo} object.
     */
    public TypeSerializationInfo getTypeInfo() {
        return typeInfo;
    }

    /**
     * Setter for the field typeInfo.
     *
     * @param typeInfo a {@link com.github.nmorel.gwtjackson.client.ser.bean.TypeSerializationInfo} object.
     * @return a {@link com.github.nmorel.gwtjackson.client.JsonSerializerParameters} object.
     */
    public JsonSerializerParameters setTypeInfo( TypeSerializationInfo typeInfo ) {
        this.typeInfo = typeInfo;
        return this;
    }

    /**
     * isUnwrapped
     *
     * @return a boolean.
     */
    public boolean isUnwrapped() {
        return unwrapped;
    }

    /**
     * Setter for the field unwrapped.
     *
     * @param unwrapped a boolean.
     * @return a {@link com.github.nmorel.gwtjackson.client.JsonSerializerParameters} object.
     */
    public JsonSerializerParameters setUnwrapped( boolean unwrapped ) {
        this.unwrapped = unwrapped;
        return this;
    }
}