com.uchuhimo.konf.source.properties.PropertiesProvider.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017-2019 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
 *
 *     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.uchuhimo.konf.source.properties

import com.uchuhimo.konf.annotation.JavaApi
import com.uchuhimo.konf.source.Provider
import com.uchuhimo.konf.source.Source
import com.uchuhimo.konf.source.base.FlatSource
import java.io.InputStream
import java.io.Reader
import java.util.Properties

/**
 * Provider for properties source.
 */
object PropertiesProvider : Provider {
    @Suppress("UNCHECKED_CAST")
    private fun Properties.toMap(): Map = this as Map

    override fun reader(reader: Reader): Source =
        FlatSource(Properties().apply { load(reader) }.toMap(), type = "properties")

    override fun inputStream(inputStream: InputStream): Source =
        FlatSource(Properties().apply { load(inputStream) }.toMap(), type = "properties")

    /**
     * Returns a new source from system properties.
     *
     * @return a new source from system properties
     */
    fun system(): Source = FlatSource(
        System.getProperties().toMap(),
        type = "system-properties",
        allowConflict = true
    )

    /**
     * Returns a new source from system properties.
     *
     * @return a new source from system properties
     */
    @Deprecated("use `system` instead", replaceWith = ReplaceWith("system"))
    fun fromSystem(): Source = system()

    @JavaApi
    @JvmStatic
    fun get() = this
}