com.swirlds.config.api.converter.ConfigConverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swirlds-config-api Show documentation

Swirlds is a software platform designed to build fully-distributed applications that harness the power of the cloud without servers. Now you can develop applications with fairness in decision making, speed, trust and reliability, at a fraction of the cost of traditional server-based platforms.

The newest version!

/*
 * Copyright (C) 2016-2024 Hedera Hashgraph, LLC
 *
 * 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.swirlds.config.api.converter;

import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;

/**
 * Interface that provides the functionality to convert a raw {@link String} value of a property to a specific data
 * type.
 * 
 * Implementations of the interface can be added to the configuration setup by calling {@link
 * com.swirlds.config.api.ConfigurationBuilder#withConverter(Class, ConfigConverter)}}
 *
 * @param  The data type of the converter
 */
@FunctionalInterface
public interface ConfigConverter {

    /**
     * The method that is called to convert the given raw string value to a specific data type.
     *
     * @param value the value that should be converted to the specific data type
     * @return the converted value
     * @throws IllegalArgumentException if the given String value can not be converted
     * @throws NullPointerException     if the given String value is null
     */
    @Nullable
    T convert(@NonNull String value) throws IllegalArgumentException, NullPointerException;
}