io.divide.otto.Subscribe Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of shared Show documentation

The newest version!

/*
 * Copyright (C) 2007 The Guava 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.divide.otto;

import java.lang.annotation.*;

/**
 * Marks a method as an event handler, as used by {@link io.divide.otto.AnnotatedHandlerFinder} and {@link io.divide.otto.Bus}.
 *
 * The method's first (and only) parameter defines the event type.
 * 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 io.divide.otto.Bus}. Otto fails fast by throwing
 * runtime exceptions in these cases.
 *
 * @author Cliff Biffle
 */
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Subscribe {
}