org.eclipse.persistence.oxm.annotations.XmlNullPolicy Maven / Gradle / Ivy
The newest version!
/*
* Copyright (c) 2011, 2024 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 = 2.2 - Initial contribution
package org.eclipse.persistence.oxm.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Provide a means of using annotations to customise the handling of null values
* and their xml representation.
* This annotation provides the user with a mechanism to customise the way that EclipseLink
* handles the reading and writing of null values. The following values can be specified:
*
* - xsiNilRepresentsNull - This indicates that during unmarshal, an element with an xsi:nil="true"
* attribute specified should be unmarshalled as "null" into the object.
* - emptyNodeRepresentsNull - This indicates that during unmarshal, an empty node "{@code
}"
* should be unmarshalled to as null in the object model.
* - isSetPerformedForAbsentNode - If this is set to true, then for each mapped element that was absent from
* the document during unmarshal, the property in java will be explicitly set to null.
* - nullRepresentationForXml - Determines how a null value in the object model is written out
* to XML.
*
*
* @see XmlIsSetNullPolicy
* @see XmlMarshalNullRepresentation
* @see org.eclipse.persistence.oxm.mappings.nullpolicy.NullPolicy
*/
@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.TYPE, ElementType.PACKAGE })
@Retention(RetentionPolicy.RUNTIME)
public @interface XmlNullPolicy {
boolean xsiNilRepresentsNull() default false;
boolean emptyNodeRepresentsNull() default false;
boolean isSetPerformedForAbsentNode() default true;
XmlMarshalNullRepresentation nullRepresentationForXml() default XmlMarshalNullRepresentation.ABSENT_NODE;
}