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

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

EclipseLink build based upon Git transaction 774c696

There is a newer version: 4.0.3

/*******************************************************************************
 * 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.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;

/**
 * Purpose: This annotation indicates that a specific property should be flagged as write-only
 * by EclipseLink. The value for this property will be written out to XML during
 * a marshal, but ignored during unmarshal if flagged as write-only.
 * 
 * Example:

 * 
 *  @XmlRootElement(name="customer")

 *  public class Customer {

 *     ...

 *     @XmlElement

 *     @XmlWriteOnly

 *     public String firstName

 *     ...

 *  }
 */
@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface XmlWriteOnly {}