org.eclipse.persistence.oxm.annotations.XmlMarshalNullRepresentation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eclipselink Show documentation

EclipseLink build based upon Git transaction 346465e

There is a newer version: 5.0.0-B05

/*******************************************************************************
 * Copyright (c) 2011, 2014 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:
 * Oracle = 2.1 - Initial contribution
 ******************************************************************************/
package org.eclipse.persistence.oxm.annotations;

/**
 * Purpose: This enumeration provides a means of specifying how a null value in a
 * java object should be marshalled to XML. The possible options are:

 * 
 * XSI_NIL - This means that the element should be written out with an xsi:nil attribute. Example: 
 * <element xsi:nil="true"/>
 * EMPTY_NODE - This indicates that the element should be written out to xml with no contents
 * Example: <element />
 * ABSENT_NODE - Absent node means that no element should be written to XML if null is encountered
 * 
 */
public enum XmlMarshalNullRepresentation {

    XSI_NIL,
    ABSENT_NODE,
    EMPTY_NODE;

    public String value() {
        return name();
    }

    public static XmlMarshalNullRepresentation fromValue(String v) {
        return valueOf(v);
    }

}