org.eclipse.persistence.oxm.annotations.XmlCDATA 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 f2b9fc5

There is a newer version: 5.0.0-B03

/*
 * Copyright (c) 2011, 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 = 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;

/**
 * Wrap the value inside a CDATA section.  Normally JAXB will escape certain
 * characters in a string during a marshal operation:
 * 

 * {@code & (as &)}
 * {@code < (as <)}
 * {@code " (as ")}
 * 
 * This means a property foo with string value {@code "1 < 2"} without
 * {@code @XmlCDATA} will be marshalled as {@code 1 < 2}. When
 * {@code @XmlCDATA} is used the content is marshalled as
 * {@code }.
 * Example
 * 
 * import javax.xml.bind.annotation.XmlRootElement;
 * import org.eclipse.persistence.oxm.annotations.XmlCDATA;
 *
 * @XmlRootElement()
 * public class Root {
 *     private String foo;
 *
 *     @XmlCDATA
 *     public String getFoo() {
 *         return foo;
 *     }
 *
 *     public void setFoo(String foo) {
 *         this.foo = foo;
 *     }
 * }
 * 
 */
@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface XmlCDATA {}