org.glassfish.api.event.RestrictTo Maven / Gradle / Ivy
/*
* Copyright (c) 2024 Contributors to the Eclipse Foundation.
* Copyright (c) 2009, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.api.event;
import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Sometimes listeners are not interested in receiving all event types,
* forcing them in checking the event type before doing any type of processing.
*
* Alternatively, they can use this annotation to restrict the parameter type
* or value they really are interested in. In this case, they can restrict to an
* event type name so that their listener is only called when such event type is
* dispatched.
*
* @author Jerome Dochez
*/
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(RestrictTo.List.class)
public @interface RestrictTo {
String value();
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@interface List {
RestrictTo[] value();
}
}