aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/core/api/src/main/java/org/onosproject/event/EventFilter.java
blob: 3b2498f664cf9dde1e6602cdb0c533cd520abe29 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
/*
 * Copyright 2015 Open Networking Laboratory
 *
 * 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 org.onosproject.event;

/**
 * Entity capable of filtering events.
 */
public interface EventFilter<E extends Event> {

    /**
     * Indicates whether the specified event is of interest or not.
     * Default implementation always returns true.
     *
     * @param event event to be inspected
     * @return true if event is relevant; false otherwise
     */
    default boolean isRelevant(E event) {
        return true;
    }

}