javax.json.bind.annotation.JsonbTransient Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2016, 2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.json.bind.annotation;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
/**
* Prevents mapping of a Java Bean property, field or type to JSON representation.
*
* Usage
* The {@code @JsonbTransient} annotation can be used with the following program elements:
*
* - getter/setter
* - field
*
*
* {@code @JsonbTransient} is mutually exclusive with all other JSON Binding defined annotations.
*
* If a class field is annotated with {@code @JsonbTransient}, exception is thrown when this field,
* getter or setter is annotated with other JSON Binding annotations.
*
* If a getter is annotated with {@code @JsonbTransient}, exception is thrown if when the field
* or this getter are annotated with other JSON Binding annotations. Exception is not thrown
* if JSON Binding annotations are presented on the setter.
*
* If a setter is annotated with {@code @JsonbTransient}, exception is thrown if when the field
* or this setter are annotated with other JSON Binding annotations. Exception is not thrown
* if JSON Binding annotations are presented on the getter.
*
* @since JSON Binding 1.0
*/
@JsonbAnnotation
@Retention(RetentionPolicy.RUNTIME)
@Target({ANNOTATION_TYPE, FIELD, METHOD})
public @interface JsonbTransient { }