io.github.pustike.eventbus.Subscribe Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pustike-eventbus Show documentation

Event Bus based on publish-subscribe pattern

The newest version!

/*
 * Copyright (C) 2016-2017 the original author or authors.
 *
 * 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 io.github.pustike.eventbus;

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

/**
 * Marks a method as an event subscriber.
 *
 * The type of event will be indicated by the method's first (and only) parameter. If this annotation is applied to
 * methods with zero parameters, or more than one parameter, the object containing the method will not be able to
 * register for event delivery from the {@link EventBus}.
 *
 * Unless {@link #threadSafe()} is set to true, event subscriber methods will be invoked serially by each event bus
 * that they are registered with.
 * @author Cliff Biffle
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Subscribe {
    /**
     * Marks an event subscriber method as being thread-safe. This annotation indicates that EventBus may invoke the
     * event subscriber simultaneously from multiple threads.
     * @return true if the method is thread-safe
     */
    boolean threadSafe() default false;
}