org.deeplearning4j.spark.time.TimeSourceProvider Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of dl4j-spark3_2.12 Show documentation
The newest version!
/*
 *  ******************************************************************************
 *  *
 *  *
 *  * This program and the accompanying materials are made available under the
 *  * terms of the Apache License, Version 2.0 which is available at
 *  * https://www.apache.org/licenses/LICENSE-2.0.
 *  *
 *  *  See the NOTICE file distributed with this work for additional
 *  *  information regarding copyright ownership.
 *  * 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.
 *  *
 *  * SPDX-License-Identifier: Apache-2.0
 *  *****************************************************************************
 */

package org.deeplearning4j.spark.time;

import org.deeplearning4j.config.DL4JClassLoading;
import org.deeplearning4j.config.DL4JSystemProperties;

import java.lang.reflect.Method;

public class TimeSourceProvider {

    /**
     * Default class to use when getting a TimeSource instance
     */
    public static final String DEFAULT_TIMESOURCE_CLASS_NAME = NTPTimeSource.class.getName();

    /**
     * @deprecated Use {@link DL4JSystemProperties#TIMESOURCE_CLASSNAME_PROPERTY}
     */
    @Deprecated
    public static final String TIMESOURCE_CLASSNAME_PROPERTY = DL4JSystemProperties.TIMESOURCE_CLASSNAME_PROPERTY;

    private TimeSourceProvider() {}

    /**
     * Get a TimeSource
     * the default TimeSource instance (default: {@link NTPTimeSource}
     *
     * @return TimeSource
     */
    public static TimeSource getInstance() {
        String className = System.getProperty(DL4JSystemProperties.TIMESOURCE_CLASSNAME_PROPERTY, DEFAULT_TIMESOURCE_CLASS_NAME);

        return getInstance(className);
    }

    /**
     * Get a specific TimeSource by class name
     *
     * @param className Class name of the TimeSource to return the instance for
     * @return TimeSource instance
     */
    public static TimeSource getInstance(String className) {
        try {
            Class clazz = DL4JClassLoading.loadClassByName(className);
            Method getInstance = clazz.getMethod("getInstance");
            return (TimeSource) getInstance.invoke(null);
        } catch (Exception e) {
            throw new RuntimeException("Error getting TimeSource instance for class \"" + className + "\"", e);
        }
    }
}