io.helidon.config.hocon.HoconConfigParserBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of helidon-config-hocon Show documentation
Typesafe (Lightbend) Config (HOCON) Parser implementation.
The newest version!
/*
 * Copyright (c) 2017, 2023 Oracle and/or its affiliates.
 *
 * 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 io.helidon.config.hocon;

import java.util.Objects;

import io.helidon.common.Builder;
import io.helidon.config.spi.ConfigParser;

import com.typesafe.config.Config;
import com.typesafe.config.ConfigParseOptions;
import com.typesafe.config.ConfigResolveOptions;

/**
 * HOCON ConfigParser Builder.
 * 
 * {@link Config#resolve() HOCON resolving substitutions support} is by default enabled.
 * {@link ConfigResolveOptions#defaults()} is used to resolve loaded configuration.
 * It is possible to {@link #resolvingEnabled(boolean)}} to disable this feature
 * or specify custom {@link #resolveOptions(ConfigResolveOptions) ConfigResolveOptions} instance.
 */
public final class HoconConfigParserBuilder implements Builder {

    private boolean resolvingEnabled;
    private ConfigResolveOptions resolveOptions;
    private ConfigParseOptions parseOptions;
    private HoconConfigIncluder configIncluder;

    HoconConfigParserBuilder() {
        resolvingEnabled = false;
        resolveOptions = ConfigResolveOptions.defaults();
        parseOptions = ConfigParseOptions.defaults();
    }

    /**
     * Enables/disables HOCON resolving substitutions support. Default is {@code false}.
     * 

     * Note: Even if you disable substitution at HOCON parsing time, values can still be resolved at a later time by the
     * Helidon Config system.
     *
     * @param enabled use to enable or disable substitution
     * @return modified builder instance
     */
    public HoconConfigParserBuilder resolvingEnabled(boolean enabled) {
        this.resolvingEnabled = enabled;
        return this;
    }

    /**
     * Sets custom instance of {@link ConfigResolveOptions}.
     * 
     * By default {@link ConfigResolveOptions#defaults()} is used.
     *
     * @param resolveOptions resolve options
     *
     * @return modified builder instance
     */
    public HoconConfigParserBuilder resolveOptions(ConfigResolveOptions resolveOptions) {
        this.resolveOptions = Objects.requireNonNull(resolveOptions);
        return this;
    }

    /**
     * Builds new instance of HOCON ConfigParser.
     *
     * @return new instance of HOCON ConfigParser.
     */
    @Override
    public HoconConfigParser build() {
        return new HoconConfigParser(this);
    }

    HoconConfigIncluder includer() {
        if (configIncluder == null) {
            configIncluder = new HoconConfigIncluder();
            parseOptions = parseOptions.appendIncluder(configIncluder);
        }
        return configIncluder;
    }

    ConfigParseOptions parseOptions() {
        if (configIncluder == null) {
            configIncluder = new HoconConfigIncluder();
            parseOptions = parseOptions.appendIncluder(configIncluder);
        }
        return parseOptions;
    }

    ConfigResolveOptions resolveOptions() {
        return resolveOptions;
    }

    boolean resolvingEnabled() {
        return resolvingEnabled;
    }
}