io.helidon.config.spi.WatchableSource Maven / Gradle / Ivy

Go to download

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

Configuration Core module.

There is a newer version: 4.1.1

/*
 * Copyright (c) 2020 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.spi;

import java.util.Optional;

/**
 * A source implementing this interface provides a target that a {@link io.helidon.config.spi.ChangeWatcher} can
 * use.
 *
 * @param  Type of target of this config source
 * @see io.helidon.config.spi.ChangeWatcher
 */
public interface WatchableSource {
    /**
     * Target type as supported by this source.
     *
     * @return class of the target, by default used for {@link #target()}
     */
    @SuppressWarnings("unchecked")
    default Class targetType() {
        return (Class) target().getClass();
    }

    /**
     * The target of this source.
     *
     * @return target this source is configured with, never {@code null}
     */
    T target();

    /**
     * If a change watcher is configured with this source, return it.
     * The source implementation does not need to handle change watcher .
     *
     * @return change watcher if one is configured on this source
     */
    Optional> changeWatcher();

    /**
     * A builder for a watchable source.
     *
     * @param  type of the builder, used when extending this builder ({@code MyBuilder implements Builder}
     * @param  type of the target of the source
     * @see io.helidon.config.AbstractConfigSourceBuilder
     * @see io.helidon.config.AbstractConfigSource
     */
    interface Builder, T> {
        /**
         * Configure the change watcher to be used with this source.
         *
         * @param changeWatcher watcher to use
         * @return updated builder instance
         */
        B changeWatcher(ChangeWatcher changeWatcher);
    }
}