com.payu.ratel.Publish Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015 PayU
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.payu.ratel;

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;

import javax.inject.Named;

/**
 * Annotation used to mark a bean to be exported by Ralel as a service.
 */
@Target({ElementType.TYPE, ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Named
public @interface Publish {

    /**
     * Specifies a contract under which a service should be exported. The
     * annotated class must implement this interface
     *
     * @return the interaface class that denotes the service contract. A
     *         default value Void.class denotes
     *         that the first interface implemented by the annotated class
     *         should be used as a service contract. This is useful, when a
     *         class only implements one interface.
     */
    Class value() default Void.class;
}