Repository: logging-log4j2 Updated Branches: refs/heads/master 2f3724591 -> 2deb32280
Javadoc tweaks. Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/2deb3228 Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/2deb3228 Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/2deb3228 Branch: refs/heads/master Commit: 2deb32280549966205f8a9d5cbb8f0e7b937880f Parents: 2f37245 Author: Gary Gregory <[email protected]> Authored: Sun Jan 28 11:13:17 2018 -0700 Committer: Gary Gregory <[email protected]> Committed: Sun Jan 28 11:13:17 2018 -0700 ---------------------------------------------------------------------- .../java/org/apache/logging/log4j/core/util/Instant.java | 2 +- .../org/apache/logging/log4j/core/util/MutableInstant.java | 2 +- .../org/apache/logging/log4j/core/util/PreciseClock.java | 4 ++-- .../java/org/apache/logging/log4j/core/util/SystemClock.java | 2 +- .../main/java/org/apache/logging/log4j/core/LogEvent.java | 2 +- .../org/apache/logging/log4j/core/impl/Log4jLogEvent.java | 2 +- .../java/org/apache/logging/log4j/core/time/Instant.java | 8 +++++--- .../org/apache/logging/log4j/core/time/MutableInstant.java | 2 +- .../org/apache/logging/log4j/core/time/PreciseClock.java | 4 ++-- .../logging/log4j/core/time/internal/FixedPreciseClock.java | 2 +- .../logging/log4j/core/time/internal/SystemMillisClock.java | 2 +- .../org/apache/logging/log4j/flume/appender/FlumeEvent.java | 2 +- 12 files changed, 18 insertions(+), 16 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2deb3228/log4j-core-java9/src/main/java/org/apache/logging/log4j/core/util/Instant.java ---------------------------------------------------------------------- diff --git a/log4j-core-java9/src/main/java/org/apache/logging/log4j/core/util/Instant.java b/log4j-core-java9/src/main/java/org/apache/logging/log4j/core/util/Instant.java index cd4ac9d..829e486 100644 --- a/log4j-core-java9/src/main/java/org/apache/logging/log4j/core/util/Instant.java +++ b/log4j-core-java9/src/main/java/org/apache/logging/log4j/core/util/Instant.java @@ -32,7 +32,7 @@ package org.apache.logging.log4j.core.util; * </p><p> * This class bridges these two time APIs. * </p> - * @since 2.11 + * @since 2.11.0 */ public interface Instant { /** http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2deb3228/log4j-core-java9/src/main/java/org/apache/logging/log4j/core/util/MutableInstant.java ---------------------------------------------------------------------- diff --git a/log4j-core-java9/src/main/java/org/apache/logging/log4j/core/util/MutableInstant.java b/log4j-core-java9/src/main/java/org/apache/logging/log4j/core/util/MutableInstant.java index 8960fc5..a885101 100644 --- a/log4j-core-java9/src/main/java/org/apache/logging/log4j/core/util/MutableInstant.java +++ b/log4j-core-java9/src/main/java/org/apache/logging/log4j/core/util/MutableInstant.java @@ -31,7 +31,7 @@ import java.io.Serializable; * Instances of this class are <em>not</em> thread-safe and should not be shared between threads. * </p> * - * @since 2.11 + * @since 2.11.0 */ @PerformanceSensitive("allocation") public class MutableInstant implements Instant, Serializable { http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2deb3228/log4j-core-java9/src/main/java/org/apache/logging/log4j/core/util/PreciseClock.java ---------------------------------------------------------------------- diff --git a/log4j-core-java9/src/main/java/org/apache/logging/log4j/core/util/PreciseClock.java b/log4j-core-java9/src/main/java/org/apache/logging/log4j/core/util/PreciseClock.java index 3d1f314..7dc0700 100644 --- a/log4j-core-java9/src/main/java/org/apache/logging/log4j/core/util/PreciseClock.java +++ b/log4j-core-java9/src/main/java/org/apache/logging/log4j/core/util/PreciseClock.java @@ -23,14 +23,14 @@ package org.apache.logging.log4j.core.util; * Extension of the {@link Clock} interface that is able to provide more accurate time information than milliseconds * since the epoch. {@code PreciseClock} implementations are free to return millisecond-precision time * if that is the most accurate time information available on this platform. - * @since 2.11 + * @since 2.11.0 */ public interface PreciseClock extends Clock { /** * Initializes the specified instant with time information as accurate as available on this platform. * @param mutableInstant the container to be initialized with the accurate time information - * @since 2.11 + * @since 2.11.0 */ void init(final MutableInstant mutableInstant); } http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2deb3228/log4j-core-java9/src/main/java/org/apache/logging/log4j/core/util/SystemClock.java ---------------------------------------------------------------------- diff --git a/log4j-core-java9/src/main/java/org/apache/logging/log4j/core/util/SystemClock.java b/log4j-core-java9/src/main/java/org/apache/logging/log4j/core/util/SystemClock.java index a74a1fd..6eb2379 100644 --- a/log4j-core-java9/src/main/java/org/apache/logging/log4j/core/util/SystemClock.java +++ b/log4j-core-java9/src/main/java/org/apache/logging/log4j/core/util/SystemClock.java @@ -20,7 +20,7 @@ import java.time.Instant; /** * Implementation of the {@code Clock} interface that returns the system time. - * @since 2.11 + * @since 2.11.0 */ public final class SystemClock implements Clock, PreciseClock { http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2deb3228/log4j-core/src/main/java/org/apache/logging/log4j/core/LogEvent.java ---------------------------------------------------------------------- diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/LogEvent.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/LogEvent.java index 0879f40..017eb2e 100644 --- a/log4j-core/src/main/java/org/apache/logging/log4j/core/LogEvent.java +++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/LogEvent.java @@ -141,7 +141,7 @@ public interface LogEvent extends Serializable { * </p> * * @return the {@code Instant} holding timestamp details for this log event - * @since 2.11 + * @since 2.11.0 */ Instant getInstant(); http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2deb3228/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/Log4jLogEvent.java ---------------------------------------------------------------------- diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/Log4jLogEvent.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/Log4jLogEvent.java index 48076d8..d7da56c 100644 --- a/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/Log4jLogEvent.java +++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/Log4jLogEvent.java @@ -581,7 +581,7 @@ public class Log4jLogEvent implements LogEvent { /** * {@inheritDoc} - * @since 2.11 + * @since 2.11.0 */ @Override public Instant getInstant() { http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2deb3228/log4j-core/src/main/java/org/apache/logging/log4j/core/time/Instant.java ---------------------------------------------------------------------- diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/time/Instant.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/time/Instant.java index ab50da1..c9609cd 100644 --- a/log4j-core/src/main/java/org/apache/logging/log4j/core/time/Instant.java +++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/time/Instant.java @@ -25,14 +25,16 @@ import org.apache.logging.log4j.util.StringBuilderFormattable; * Provides methods for obtaining high precision time information similar to the * <a href="https://docs.oracle.com/javase/9/docs/api/java/time/Instant.html";>Instant</a> class introduced in Java 8, * while also supporting the legacy millisecond precision API. - * </p><p> + * </p> + * <p> * Depending on the platform, time sources ({@link Clock} implementations) may produce high precision or millisecond * precision time values. At the same time, some time value consumers (for example timestamp formatters) may only be * able to consume time values of millisecond precision, while some others may require a high precision time value. - * </p><p> + * </p> + * <p> * This class bridges these two time APIs. * </p> - * @since 2.11 + * @since 2.11.0 */ public interface Instant extends StringBuilderFormattable { /** http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2deb3228/log4j-core/src/main/java/org/apache/logging/log4j/core/time/MutableInstant.java ---------------------------------------------------------------------- diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/time/MutableInstant.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/time/MutableInstant.java index 09b0d39..6e27dd8 100644 --- a/log4j-core/src/main/java/org/apache/logging/log4j/core/time/MutableInstant.java +++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/time/MutableInstant.java @@ -29,7 +29,7 @@ import java.io.Serializable; * Instances of this class are <em>not</em> thread-safe and should not be shared between threads. * </p> * - * @since 2.11 + * @since 2.11.0 */ @PerformanceSensitive("allocation") public class MutableInstant implements Instant, Serializable { http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2deb3228/log4j-core/src/main/java/org/apache/logging/log4j/core/time/PreciseClock.java ---------------------------------------------------------------------- diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/time/PreciseClock.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/time/PreciseClock.java index c2416f6..a0ae3f6 100644 --- a/log4j-core/src/main/java/org/apache/logging/log4j/core/time/PreciseClock.java +++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/time/PreciseClock.java @@ -22,14 +22,14 @@ import org.apache.logging.log4j.core.util.Clock; * Extension of the {@link Clock} interface that is able to provide more accurate time information than milliseconds * since the epoch. {@code PreciseClock} implementations are free to return millisecond-precision time * if that is the most accurate time information available on this platform. - * @since 2.11 + * @since 2.11.0 */ public interface PreciseClock extends Clock { /** * Initializes the specified instant with time information as accurate as available on this platform. * @param mutableInstant the container to be initialized with the accurate time information - * @since 2.11 + * @since 2.11.0 */ void init(final MutableInstant mutableInstant); } http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2deb3228/log4j-core/src/main/java/org/apache/logging/log4j/core/time/internal/FixedPreciseClock.java ---------------------------------------------------------------------- diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/time/internal/FixedPreciseClock.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/time/internal/FixedPreciseClock.java index 868cdbe..eae268b 100644 --- a/log4j-core/src/main/java/org/apache/logging/log4j/core/time/internal/FixedPreciseClock.java +++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/time/internal/FixedPreciseClock.java @@ -21,7 +21,7 @@ import org.apache.logging.log4j.core.time.PreciseClock; /** * Implementation of the {@code PreciseClock} interface that always returns a fixed time value. - * @since 2.11 + * @since 2.11.0 */ public class FixedPreciseClock implements PreciseClock { private final long currentTimeMillis; http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2deb3228/log4j-core/src/main/java/org/apache/logging/log4j/core/time/internal/SystemMillisClock.java ---------------------------------------------------------------------- diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/time/internal/SystemMillisClock.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/time/internal/SystemMillisClock.java index 49b7ffc..af26633 100644 --- a/log4j-core/src/main/java/org/apache/logging/log4j/core/time/internal/SystemMillisClock.java +++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/time/internal/SystemMillisClock.java @@ -20,7 +20,7 @@ import org.apache.logging.log4j.core.util.Clock; /** * Implementation of the {@code Clock} interface that returns the system time in millisecond granularity. - * @since 2.11 + * @since 2.11.0 */ public final class SystemMillisClock implements Clock { http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2deb3228/log4j-flume-ng/src/main/java/org/apache/logging/log4j/flume/appender/FlumeEvent.java ---------------------------------------------------------------------- diff --git a/log4j-flume-ng/src/main/java/org/apache/logging/log4j/flume/appender/FlumeEvent.java b/log4j-flume-ng/src/main/java/org/apache/logging/log4j/flume/appender/FlumeEvent.java index cee5d9c..a471004 100644 --- a/log4j-flume-ng/src/main/java/org/apache/logging/log4j/flume/appender/FlumeEvent.java +++ b/log4j-flume-ng/src/main/java/org/apache/logging/log4j/flume/appender/FlumeEvent.java @@ -296,7 +296,7 @@ public class FlumeEvent extends SimpleEvent implements LogEvent { /** * {@inheritDoc} - * @since 2.11 + * @since 2.11.0 */ @Override public Instant getInstant() {
