View Javadoc

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.shiro.functor;
20  
21  /**
22   * Generic <a href="http://en.wikipedia.org/wiki/Functor">functor</a> interface representing a data translation (or
23   * conversion) operation.  For a given input, a Translator can translate an input argument into a potentially different
24   * output value.
25   * <p/>
26   * One example of where this is particularly convenient is API translation: translating a 3rd-party framework Exception
27   * to a Shiro Exception or vice-versa.
28   *
29   * @param <I> The input type
30   * @param <O> The output type
31   *
32   * @since 1.2
33   */
34  public interface Translator<I,O> {
35  
36      /**
37       * Translates the input argument into the required output instance.
38       *
39       * @param input the input data to translate
40       * @return the translated output data
41       * @since 1.2
42       */
43      O translate(I input);
44  
45  }