1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache license, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the license for the specific language governing permissions and
15 * limitations under the license.
16 */
17 package org.apache.logging.log4j.core.time.internal;
18
19 import org.apache.logging.log4j.core.time.MutableInstant;
20 import org.apache.logging.log4j.core.time.PreciseClock;
21
22 /**
23 * Implementation of the {@code PreciseClock} interface that always returns a fixed time value.
24 * @since 2.11
25 */
26 public class FixedPreciseClock implements PreciseClock {
27 private final long currentTimeMillis;
28 private final int nanosOfMillisecond;
29
30 /**
31 * Constructs a {@code FixedPreciseClock} that always returns the epoch.
32 */
33 public FixedPreciseClock() {
34 this(0);
35 }
36
37 /**
38 * Constructs a {@code FixedPreciseClock} that always returns the specified time in milliseconds since the epoch.
39 * @param currentTimeMillis milliseconds since the epoch
40 */
41 public FixedPreciseClock(final long currentTimeMillis) {
42 this(currentTimeMillis, 0);
43 }
44
45 /**
46 * Constructs a {@code FixedPreciseClock} that always returns the specified time in milliseconds since the epoch
47 * and nanosecond of the millisecond.
48 * @param currentTimeMillis milliseconds since the epoch
49 * @param nanosOfMillisecond nanosecond of the specified millisecond
50 */
51 public FixedPreciseClock(final long currentTimeMillis, final int nanosOfMillisecond) {
52 this.currentTimeMillis = currentTimeMillis;
53 this.nanosOfMillisecond = nanosOfMillisecond;
54 }
55
56 @Override
57 public void init(final MutableInstant instant) {
58 instant.initFromEpochMilli(currentTimeMillis, nanosOfMillisecond);
59 }
60
61 @Override
62 public long currentTimeMillis() {
63 return currentTimeMillis;
64 }
65 }