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 *      http://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.logging.log4j.core.time;
018
019import org.apache.logging.log4j.core.util.Clock;
020
021/**
022 * Extension of the {@link Clock} interface that is able to provide more accurate time information than milliseconds
023 * since the epoch. {@code PreciseClock} implementations are free to return millisecond-precision time
024 * if that is the most accurate time information available on this platform.
025 * @since 2.11
026 */
027public interface PreciseClock extends Clock {
028
029    /**
030     * Initializes the specified instant with time information as accurate as available on this platform.
031     * @param mutableInstant the container to be initialized with the accurate time information
032     * @since 2.11
033     */
034    void init(final MutableInstant mutableInstant);
035}