com.github.sonus21.rqueue.annotation.RqueueHandler Maven / Gradle / Ivy

Go to download
/*
 *  Copyright 2021 Sonu Kumar
 *
 *  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
 *
 *         https://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.github.sonus21.rqueue.annotation;

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;

/**
 * This designated any public method as listener given the containing method is also annotated with
 * {@link RqueueListener}. In a class there must be exactly one primary one handler.
 *
 * Registering more than one primary handler is not allowed.
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RqueueHandler {

  /**
   * When true, designate that this is the default method only one method can be so designated.
   *
   * @return true if this is the default method.
   */
  boolean primary() default false;
}