001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *     https://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.configuration2.builder;
018
019import org.apache.commons.configuration2.ex.ConfigurationException;
020import org.apache.commons.configuration2.io.FileHandler;
021import org.apache.commons.configuration2.reloading.FileHandlerReloadingDetector;
022import org.apache.commons.configuration2.reloading.ReloadingDetector;
023
024/**
025 * <p>
026 * A default implementation of the {@code ReloadingDetectorFactory} interface.
027 * </p>
028 * <p>
029 * This factory creates objects of type {@link FileHandlerReloadingDetector}. Instances have no state and can be shared
030 * between multiple builders.
031 * </p>
032 *
033 * @since 2.0
034 */
035public class DefaultReloadingDetectorFactory implements ReloadingDetectorFactory {
036
037    /**
038     * Constructs a new instance.
039     */
040    public DefaultReloadingDetectorFactory() {
041        // empty
042    }
043
044    @Override
045    public ReloadingDetector createReloadingDetector(final FileHandler handler, final FileBasedBuilderParametersImpl params) throws ConfigurationException {
046        final Long refreshDelay = params.getReloadingRefreshDelay();
047
048        final FileHandlerReloadingDetector fileHandlerReloadingDetector = refreshDelay != null ? new FileHandlerReloadingDetector(handler, refreshDelay)
049            : new FileHandlerReloadingDetector(handler);
050
051        fileHandlerReloadingDetector.refresh();
052
053        return fileHandlerReloadingDetector;
054    }
055}