io.micronaut.core.value.ValueResolver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-core Show documentation
Core components supporting the Micronaut Framework
There is a newer version: 4.7.9
/*
 * Copyright 2017-2020 original 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 io.micronaut.core.value;

import io.micronaut.core.convert.ArgumentConversionContext;
import io.micronaut.core.convert.ConversionContext;
import io.micronaut.core.type.Argument;

import java.util.Optional;

/**
 * An interface for any type that is able to resolve and convert values.
 *
 * @param  parent type
 * @author Graeme Rocher
 * @see io.micronaut.core.convert.TypeConverter
 * @since 1.0
 */
public interface ValueResolver {

    /**
     * Resolve the given property for the given name.
     *
     * @param name              The name
     * @param conversionContext The conversion context
     * @param                The concrete type
     * @return An optional containing the property value if it exists and is able to be converted
     */
     Optional get(K name, ArgumentConversionContext conversionContext);

    /**
     * Resolve the given property for the given name.
     *
     * @param name         The name
     * @param requiredType The required type
     * @param           The concrete type
     * @return An optional containing the property value if it exists and is able to be converted
     */
    default  Optional get(K name, Class requiredType) {
        return get(name, ConversionContext.of(Argument.of(requiredType)));
    }

    /**
     * Resolve the given property for the given name.
     *
     * @param name         The name
     * @param requiredType The required type
     * @param           The concrete type
     * @return An optional containing the property value if it exists and is able to be converted
     */
    default  Optional get(K name, Argument requiredType) {
        return get(name, ConversionContext.of(requiredType));
    }

    /**
     * Resolve the given property for the given name.
     *
     * @param name         The name
     * @param requiredType The required type
     * @param defaultValue The default value
     * @param           The concrete type
     * @return Property value if it exists or default value
     */
    default  T get(K name, Class requiredType, T defaultValue) {
        return get(name, requiredType).orElse(defaultValue);
    }
}