jsonb/src/main/java/org/eclipse/persistence/json/bind/model/CustomizationBuilder.java

/*******************************************************************************
 * Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved.
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
 * which accompanies this distribution.
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * Contributors:
 * Roman Grigoriadi
 ******************************************************************************/

package org.eclipse.persistence.json.bind.model;

import org.eclipse.persistence.json.bind.internal.adapter.AdapterBinding;
import org.eclipse.persistence.json.bind.internal.adapter.DeserializerBinding;
import org.eclipse.persistence.json.bind.internal.adapter.SerializerBinding;
import org.eclipse.persistence.json.bind.internal.serializer.JsonbDateFormatter;
import org.eclipse.persistence.json.bind.internal.serializer.JsonbNumberFormatter;

/**
 * Builder for ensuring immutable state of {@link Customization} objects.
 *
 * @author Roman Grigoriadi
 */
public class CustomizationBuilder {

    private boolean nillable;

    private boolean jsonbTransient;

    private String jsonReadName;

    private String jsonWriteName;

    private AdapterBinding adapterInfo;

    private SerializerBinding serializerBinding;

    private DeserializerBinding deserializerBinding;

    private JsonbDateFormatter dateFormatter;

    private JsonbNumberFormatter numberFormat;

    private JsonbCreator creator;

    private String[] propertyOrder;

    /**
     * Creates customization for class properties.
     * @return class property customization
     */
    public PropertyCustomization buildPropertyCustomization() {
        return new PropertyCustomization(this);
    }

    /**
     * Creates customization for class.
     * @return class customization
     */
    public ClassCustomization buildClassCustomization() {
        return new ClassCustomization(this);
    }

    /**
     * Marshall null values to JSON.
     * @return if true marshalling null values is active
     */
    public boolean isNillable() {
        return nillable;
    }

    /**
     * Marshall null values to JSON.
     */
    public void setNillable(boolean nillable) {
        this.nillable = nillable;
    }

    /**
     * Skip marshalling / unmarshalling for this customization.
     * Works as java "transient" keyword.
     */
    public boolean isJsonbTransient() {
        return jsonbTransient;
    }

    /**
     * Skip marshalling / unmarshalling for this customization.
     * Works as java "transient" keyword.
     */
    public void setJsonbTransient(boolean jsonbTransient) {
        this.jsonbTransient = jsonbTransient;
    }

    /**
     * Name as appears in JSON for reading property.
     */
    public String getJsonReadName() {
        return jsonReadName;
    }

    /**
     * Name as appears in JSON for reading property.
     */
    public void setJsonReadName(String jsonReadName) {
        this.jsonReadName = jsonReadName;
    }

    /**
     * Name as should be written to JSON for marshalling.
     */
    public String getJsonWriteName() {
        return jsonWriteName;
    }

    /**
     * Name as should be written to JSON for marshalling.
     */
    public void setJsonWriteName(String jsonWriteName) {
        this.jsonWriteName = jsonWriteName;
    }

    /**
     * Adapter a class or a property of a class.
     * @return adapter
     */
    public AdapterBinding getAdapterInfo() {
        return adapterInfo;
    }

    /**
     * Adapter a class or a property of a class.
     * @param adapterInfo adapter info
     */
    public void setAdapterInfo(AdapterBinding adapterInfo) {
        this.adapterInfo = adapterInfo;
    }

    /**
     * Meta info for user serializers.
     * @return serializer info
     */
    public SerializerBinding getSerializerBinding() {
        return serializerBinding;
    }

    /**
     * Set serializer info.
     * @param serializerBinding
     */
    public void setSerializerBinding(SerializerBinding serializerBinding) {
        this.serializerBinding = serializerBinding;
    }

    /**
     * Deserializer info.
     * @return deserialzier
     */
    public DeserializerBinding getDeserializerBinding() {
        return deserializerBinding;
    }

    /**
     * Deserializer info.
     * @param deserializerBinding deserializer
     */
    public void setDeserializerBinding(DeserializerBinding deserializerBinding) {
        this.deserializerBinding = deserializerBinding;
    }

    /**
     * Date format for formatting dates.
     * @return date format
     */
    public JsonbDateFormatter getDateFormatter() {
        return dateFormatter;
    }

    /**
     * Date format for formatting dates.
     * @param dateFormatter date format
     */
    public CustomizationBuilder setDateFormatter(JsonbDateFormatter dateFormatter) {
        this.dateFormatter = dateFormatter;
        return this;
    }

    /**
     * Number formatter for formatting numbers
     * @return number format
     */
    public JsonbNumberFormatter getNumberFormat() {
        return numberFormat;
    }

    /**
     * Number formatter for formatting numbers.
     * @param numberFormat number format
     */
    public void setNumberFormat(JsonbNumberFormatter numberFormat) {
        this.numberFormat = numberFormat;
    }

    /**
     * Custom constructor or method for user instantiation.
     * @return creator
     */
    public JsonbCreator getCreator() {
        return creator;
    }

    /**
     * Custom constructor or method for user instantiation.
     */
    public void setCreator(JsonbCreator creator) {
        this.creator = creator;
    }

    /**
     * Names of properties to sort with.
     *
     * @return sorted names of properties
     */
    public String[] getPropertyOrder() {
        return propertyOrder;
    }

    public void setPropertyOrder(String[] propertyOrder) {
        this.propertyOrder = propertyOrder;
    }
}