com.opensymphony.xwork2.inject.util.Function Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of xwork Show documentation
Show all versions of xwork Show documentation
XWork is an command-pattern framework that is used to power WebWork
as well as other applications. XWork provides an Inversion of Control
container, a powerful expression language, data type conversion,
validation, and pluggable configuration.
/**
* Copyright (C) 2006 Google Inc.
*
* 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 com.opensymphony.xwork2.inject.util;
/**
* A Function provides a transformation on an object and returns the resulting
* object. For example, a {@code StringToIntegerFunction} may implement
* Function<String,Integer> and transform integers in String
* format to Integer format.
*
* The transformation on the source object does not necessarily result in
* an object of a different type. For example, a
* {@code FarenheitToCelciusFunction} may implement
* Function<Float,Float>.
*
*
Implementors of Function which may cause side effects upon evaluation are
* strongly encouraged to state this fact clearly in their API documentation.
*/
public interface Function {
/**
* Applies the function to an object of type {@code F}, resulting in an object
* of type {@code T}. Note that types {@code F} and {@code T} may or may not
* be the same.
*
* @param from The source object.
* @return The resulting object.
*/
T apply(F from);
}