org.eclipse.persistence.oxm.mappings.nullpolicy.XMLNullRepresentationType 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) 1998, 2018 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:
//     Oracle - initial API and implementation from Oracle TopLink
package org.eclipse.persistence.oxm.mappings.nullpolicy;

/**
 * Description:
 * An enum that is used within a Node Null Policy to determine what to marshal for a null node.

 * We define 3 final instances available to the user (XSI_NIL, ABSENT_NODE(default) and EMPTY_NODE.
 *
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Flag Description
 XSI_NIL Nillable: Write out an xsi:nil="true" attribute.
 ABSENT_NODE(default) Optional: Write out no node.
 EMPTY_NODE Required: Write out an empty {@literal } or node="" node.
 * @see org.eclipse.persistence.oxm.mappings.nullpolicy.AbstractNullPolicy
 */
public enum XMLNullRepresentationType {

    /**
     * Write out an xsi:nil="true" attribute. Nillable policy behavior.
     */
    XSI_NIL,

    /**
     * Do not write out anything (default optional policy behavior).
     */
    ABSENT_NODE,

    /**
     * Write out an empty node. Required policy behavior
     */
    EMPTY_NODE
    }

Flag	Description
XSI_NIL	Nillable: Write out an xsi:nil="true" attribute.
ABSENT_NODE(default)	Optional: Write out no node.
EMPTY_NODE	Required: Write out an empty {@literal } or node="" node.