SAMZA-1268: Javadoc cleanup for public APIs for 0.13 release
[samza.git] / samza-api / src / main / java / org / apache / samza / operators / functions / MapFunction.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 * Transforms an input message into another message, possibly of a different type.
26 *
27 * @param <M> type of the input message
28 * @param <OM> type of the transformed message
29 */
30 @InterfaceStability.Unstable
31 @FunctionalInterface
32 public interface MapFunction<M, OM> extends InitableFunction {
33
34 /**
35 * Transforms the provided message into another message.
36 *
37 * @param message the input message to be transformed
38 * @return the transformed message
39 */
40 OM apply(M message);
41
42 }