org.springframework.boot.actuate.endpoint.invoke.ParameterValueMapper Maven / Gradle / Ivy
/*
* Copyright 2012-2018 the original author or authors.
*
* 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
*
* https://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 org.springframework.boot.actuate.endpoint.invoke;
/**
* Maps parameter values to the required type when invoking an endpoint.
*
* @author Stephane Nicoll
* @since 2.0.0
*/
@FunctionalInterface
public interface ParameterValueMapper {
/**
* A {@link ParameterValueMapper} that does nothing.
*/
ParameterValueMapper NONE = (parameter, value) -> value;
/**
* Map the specified {@code input} parameter to the given {@code parameterType}.
* @param parameter the parameter to map
* @param value a parameter value
* @return a value suitable for that parameter
* @throws ParameterMappingException when a mapping failure occurs
*/
Object mapParameterValue(OperationParameter parameter, Object value)
throws ParameterMappingException;
}