jakarta.json.bind.annotation.JsonbProperty Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2015, 2021 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.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.json.bind.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Allows customization of field (or JavaBean property) name.This name is used either in serialization or
 * in deserialization.
 *
 * Usage
 * The {@code @JsonbProperty} annotation can be used with the following program elements:
 * 
 *    a JavaBean property 
 *    field 
 *    parameter 
 * 
 *
 * @since JSON Binding 1.0
 */
@JsonbAnnotation
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER})
public @interface JsonbProperty {

    /**
     * Customized name of the field (or JavaBean property).
     *
     * @return Customized property name.
     */
    String value() default "";

    /**
     * Switches on/off serialization of null values.
     *
     * @return True if field with null value should be serialized as key/value pair into JSON with null value.
     * @deprecated Please use {@link JsonbNillable} as another annotation instead. This option will be removed in the future.
     */
    @Deprecated(since = "2.1")
    boolean nillable() default false;
}