com.swirlds.config.extensions.sources.PropertyFileConfigSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swirlds-config-extensions 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.56.6

Show 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.extensions.sources;

import edu.umd.cs.findbugs.annotations.NonNull;
import java.io.BufferedReader;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;

/**
 * A {@link com.swirlds.config.api.source.ConfigSource} implementation that can be used to provide values from a
 * property file.
 */
public class PropertyFileConfigSource extends AbstractFileConfigSource {

    /**
     * Creates a new instance based on a file by using the {@link ConfigSourceOrdinalConstants#PROPERTY_FILE_ORDINAL}
     * ordinal.
     *
     * @param filePath the properties file
     * @throws IOException if the file can not loaded or parsed
     */
    public PropertyFileConfigSource(@NonNull final Path filePath) throws IOException {
        super(filePath);
    }

    /**
     * Creates a new instance based on a file.
     *
     * @param filePath the properties file
     * @param ordinal  the ordinal of the config source
     * @throws IOException if the file can not loaded or parsed
     */
    public PropertyFileConfigSource(@NonNull final Path filePath, final int ordinal) throws IOException {
        super(filePath, ordinal);
    }

    /**
     * {@inheritDoc}
     */
    @NonNull
    protected BufferedReader getReader() throws IOException {
        return Files.newBufferedReader(filePath);
    }
}