com.swirlds.config.api.validation.PropertyMetadata 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.

There is a newer version: 0.57.3

Show newest version

/*
 * Copyright (C) 2018-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.validation;

import com.swirlds.config.api.converter.ConfigConverter;

/**
 * Interface that provides metadata for a property.
 *
 * @param  type of the property value
 */
public interface PropertyMetadata {

    /**
     * Returns the raw value of the property.
     *
     * @return the raw value of the property
     */
    String getRawValue();

    /**
     * Returns the value of the property.
     *
     * @return the value of the property
     */
    default T getValue() {
        return getConverter().convert(getRawValue());
    }

    /**
     * Returns the type of the property value.
     *
     * @return the type of the property value
     */
    Class getValueType();

    /**
     * Returns the converter that will be used to convert the raw string value of the property to the value of the
     * property type.
     *
     * @return the converter
     */
    ConfigConverter getConverter();

    /**
     * Returns true if the property exists (is defined by a {@link com.swirlds.config.api.source.ConfigSource}).
     *
     * @return true if the property exists, false otherwise
     */
    boolean exists();

    /**
     * Returns the name of the property.
     *
     * @return the names
     */
    String getName();
}