SAMZA-1268: Javadoc cleanup for public APIs for 0.13 release
[samza.git] / samza-api / src / main / java / org / apache / samza / operators / functions / FilterFunction.java
1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.samza.operators.functions;
20
21 import org.apache.samza.annotation.InterfaceStability;
22
23
24 /**
25 * Specifies whether a message should be retained for further processing.
26 *
27 * @param <M> type of the input message
28 */
29 @InterfaceStability.Unstable
30 @FunctionalInterface
31 public interface FilterFunction<M> extends InitableFunction {
32
33 /**
34 * Returns a boolean indicating whether this message should be retained or filtered out.
35 *
36 * @param message the input message to be checked
37 * @return true if {@code message} should be retained
38 */
39 boolean apply(M message);
40
41 }