org.eclipse.persistence.internal.oxm.JsonTypeConfiguration Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.persistence.core Show documentation
EclipseLink build based upon Git transaction ecdf3c32c4
There is a newer version: 4.0.2
Show newest version
/*
 * Copyright (c) 2015, 2019 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 v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0,
 * or the Eclipse Distribution License v. 1.0 which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
 */

// Contributors:
//     Martin Vojtek - 2.6.0 - initial implementation
package org.eclipse.persistence.internal.oxm;

/**
 * Handles Json type configuration.
 *
 * @author Martin Vojtek
 *
 */
public class JsonTypeConfiguration {

    /**
     * If there should be xsd prefix when using simple types, e.g. xsd.int.
     */
    private boolean useXsdTypesWithPrefix = false;

    /**
     * Allows system property override with context property.
     */
    private boolean useXsdTypesWithPrefixSet = false;

    /**
     * If we should treat unqualified type property in JSON as MOXy type discriminator.
     */
    private boolean jsonTypeCompatibility = false;

    /**
     * Allows system property override with context property.
     */
    private boolean jsonTypeCompatibilitySet = false;

    /**
     * Override default type property name for JSON as MOXy type discriminator.
     */
    private String jsonTypeAttributeName = "type";

    /**
     * Allows system property override with context property.
     */
    private boolean jsonTypeAttributeNameSet = false;

    /**
     * Disable generation of "item" name in nested arrays in JSON.
     */
    private boolean jsonDisableNestedArrayName = false;

    /**
     * Getter for useXsdTypesWithPrefix property.
     *
     * @return value of useXsdTypesWithPrefix property
     * @since 2.6.0
     */
    public boolean isUseXsdTypesWithPrefix() {
        return useXsdTypesWithPrefix;
    }

    /**
     * If there should be xsd prefix when using simple types, e.g. xsd.int.
     *
     * @return true if there should be xsd prefix when using simple types, e.g. xsd.int.
     * @since 2.6.0
     */
    public boolean useXsdTypesWithPrefix() {
        if (useXsdTypesWithPrefixSet) {
            return useXsdTypesWithPrefix;
        } else {
            return OXMSystemProperties.jsonUseXsdTypesPrefix;
        }
    }

    /**
     * If there should be xsd prefix when using simple types, e.g. xsd.int.
     *
     * @param useXsdTypesWithPrefix If there should be xsd prefix when using simple types, e.g. xsd.int.
     * @since 2.6.0
     */
    public void setUseXsdTypesWithPrefix(boolean useXsdTypesWithPrefix) {
        this.useXsdTypesWithPrefix = useXsdTypesWithPrefix;
        this.useXsdTypesWithPrefixSet = true;
    }

    /**
     * Getter for jsonTypeCompatibility
     *
     * @return value of jsonTypeCompatibility property
     * @since 2.6.0
     */
    public boolean isJsonTypeCompatibility() {
        return jsonTypeCompatibility;
    }

    /**
     * If we should treat unqualified type property in JSON as MOXy type discriminator.
     *
     * @return true if we should treat unqualified type property in JSON as MOXy type discriminator.
     * @since 2.6.0
     */
    public boolean useJsonTypeCompatibility() {
        if (jsonTypeCompatibilitySet) {
            return jsonTypeCompatibility;
        } else {
            return OXMSystemProperties.jsonTypeCompatiblity;
        }
    }

    /**
     * If we should treat unqualified type property in JSON as MOXy type discriminator.
     *
     * @param jsonTypeCompatibility If we should treat unqualified type property in JSON as MOXy type discriminator.
     * @since 2.6.0
     */
    public void setJsonTypeCompatibility(boolean jsonTypeCompatibility) {
        this.jsonTypeCompatibility = jsonTypeCompatibility;
        this.jsonTypeCompatibilitySet = true;
    }

    /**
     * Getter for type property name for JSON as MOXy type discriminator.
     *
     * @return value of jsonTypeAttributeName property
     * @since 2.7.4
     */
    public String getJsonTypeAttributeName() {
        return jsonTypeAttributeName;
    }

    /**
     * Override default type property name for JSON as MOXy type discriminator.
     *
     * @return type property name for JSON as MOXy type discriminator.
     * @since 2.7.4
     */
    public String useJsonTypeAttributeName() {
        if (jsonTypeAttributeNameSet) {
            return jsonTypeAttributeName;
        } else {
            return OXMSystemProperties.jsonTypeAttributeName;
        }
    }

    /**
     * Override default type property name for JSON as MOXy type discriminator.
     *
     * @param jsonTypeAttributeName Type property name for JSON as MOXy type discriminator.
     * @since 2.6.0
     */
    public void setJsonTypeAttributeName(String jsonTypeAttributeName) {
        this.jsonTypeAttributeName = jsonTypeAttributeName;
        this.jsonTypeAttributeNameSet = true;
    }

    /**
     * Getter for JSON property to enable/disable generation of "item" name in nested arrays in JSON.
     *
     * @return value of jsonDisableNestedArrayName property
     * @since 2.7.5
     */
    public boolean isJsonDisableNestedArrayName() {
        return jsonDisableNestedArrayName;
    }

    /**
     * Setter for JSON property to enable/disable generation of "item" name in nested arrays in JSON.
     *
     * @param jsonDisableNestedArrayName value of jsonDisableNestedArrayName property
     * @since 2.7.5
     */
    public void setJsonDisableNestedArrayName(boolean jsonDisableNestedArrayName) {
        this.jsonDisableNestedArrayName = jsonDisableNestedArrayName;
    }
}