net.morimekta.config.source.WatchedFileConfigSupplier Maven / Gradle / Ivy

Go to download

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

Configuration Utilities. NOTE: This module is deprecated and will be removed at the end of the v2.x versions of the utilities. Preferred config system after that is either to use true type-safe config with `net.morimekta.providence:providence-config` or to use a simple JSON or YAML library or java properties files. The semi-typesafe layered config did not really solve the problems I had hoped it would, and in essence this was just a helper for merging maps and getting pre-cast values out of it.

There is a newer version: 2.7.1

Show newest version

/*
 * Copyright (c) 2016, Stein Eldar Johnsen
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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 net.morimekta.config.source;

import net.morimekta.config.format.ConfigParser;
import net.morimekta.util.FileWatcher;

import java.io.File;

import static net.morimekta.config.util.ConfigUtil.getParserForName;

/**
 * File source for config objects that is updated with help from a file
 * watcher. If you want to have separate watcher that should react to the same
 * file, but trigger after the config is updated, then you need to
 * register that watcher after the supplier is created.
 *
 * 
 *     FileWatcher watcher = new FileWatcher();
 *     WatchedFileConfigSupplier supplier = new WatchedFileConfigSupplier(watcher, file);
 *     watcher.addWatcher(this::onConfigUpdate);
 * 
 *
 * Most likely you would want to register the watcher after your entire app has
 * been initialized, but that is another topic.
 */
public class WatchedFileConfigSupplier extends FileConfigSupplier {
    public WatchedFileConfigSupplier(FileWatcher watcher, File configFile) {
        this(watcher, configFile, getParserForName(configFile.getName()));
    }

    public WatchedFileConfigSupplier(FileWatcher watcher, File configFile, ConfigParser format) {
        super(configFile, format);
        watcher.addWatcher(configFile.toPath(), file -> reload());
    }
}