core-common/src/main/java/org/glassfish/jersey/spi/Contract.java

/*
 * Copyright (c) 2012, 2019 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 org.glassfish.jersey.spi;

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

/**
 * Used to annotate SPI provider contracts recognized by Jersey (in addition to the JAX-RS providers).
 *
 * All proprietary Jersey extension APIs are annotated with the {@code @Contract} annotation.
 * <p>
 * Similarly, any custom (i.e. not JAX-RS or Jersey) extension provider contract must be annotated with this
 * annotation otherwise concrete service classes implementing the provider contract would not be recognized
 * and treated as extension service provider by Jersey runtime.
 * </p>
 *
 * @author Miroslav Fuksa
 * @author Marek Potociar
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
public @interface Contract {
}