jakarta.json.bind.annotation.JsonbCreator 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;

/**
 * This annotation identifies the custom constructor or factory method to use when creating an
 * instance of the associated class.
 *
 * Only one constructor or static factory method can be annotated with {@code JsonbCreator} in a
 * given class.
 *
 * 
The {@code @JsonbCreator} annotation is intended to be used with constructors/methods with
 * parameters. Such parameters could be annotated for instance with {@code @JsonbProperty}.
 *
 * 
Usage
 *
 * 
The {@code @JsonbCreator} annotation can be used with the following program elements:
 *
 * 

 *   method
 *   
constructor
 * 
 *
 * @since JSON Binding 1.0
 */
@JsonbAnnotation
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.CONSTRUCTOR})
public @interface JsonbCreator {}