com.landawn.abacus.eventbus.Subscribe Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of abacus-common Show documentation

A general programming library in Java/Android. It's easy to learn and simple to use with concise and powerful APIs.

There is a newer version: 5.2.4

/*
 * Copyright (C) 2016 HaiYang Li
 *
 * 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.landawn.abacus.eventbus;

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

import com.landawn.abacus.util.ThreadMode;

/**
 *
 * @author Haiyang Li
 * @since 0.8
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Subscribe {

    /**
     * 
     *
     * @return 
     */
    ThreadMode threadMode() default ThreadMode.DEFAULT;

    /**
     * Only accept the events which have extract same class type as the method parameter if it's true.
     * Otherwise, accept all the events which can be assigned to the parameter type.
     * The precondition for both true and false is the event id has to match.
     *
     * @return true, if successful
     */
    boolean strictEventType() default false;

    /**
     * If true, delivers the most recent sticky event (posted with
     * {@link EventBus#postSticky(Object)}) to this subscriber (if event available).
     *
     * @return true, if successful
     */
    boolean sticky() default false;

    /**
     * Only subscribe the events which are posted with the specified event id.
     *
     * @return
     */
    String eventId() default "";

    /**
     * The event will be ignored if the interval between this event and last event is less than the specified interval.
     *
     * @return unit is milliseconds.
     */
    long interval() default 0; // Unit is milliseconds.

    /**
     * Ignore next event if it's same as previous one.
     *
     * @return true, if successful
     */
    boolean deduplicate() default false;
}