io.github.theangrydev.businessflows.Mapping Maven / Gradle / Ivy
/*
* Copyright 2016 Liam Williams .
*
* This file is part of business-flows.
*
* 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 io.github.theangrydev.businessflows;
/**
* Similar to a {@link java.util.function.Function} but is allowed to throw an {@link Exception}.
*
* @param The old type (before mapping)
* @param The new type (after mapping)
*/
@FunctionalInterface
public interface Mapping {
/**
* Map the {@link Old} object to a {@link New} object.
*
* @param old The old argument
* @return The new result
* @throws Exception If there is a technical failure during the mapping
*/
New map(Old old) throws Exception;
/**
* Map the old type to itself unchanged
*
* @param The old type
* @return The identity mapping
*/
static Mapping identity() {
return old -> old;
}
}