From 453dc0b268ae94a88b36ea37fbcdecde242bf02e Mon Sep 17 00:00:00 2001 From: q3769 Date: Tue, 21 Mar 2023 01:14:19 -0500 Subject: [PATCH] dev --- .../elf4j/impl/core/configuration/WriterRepository.java | 3 ++- src/main/java/elf4j/impl/core/service/LogEntry.java | 4 ++-- src/main/java/elf4j/impl/core/util/PropertiesUtils.java | 6 ++++-- src/main/java/elf4j/impl/core/util/StackTraceUtils.java | 2 +- .../elf4j/impl/core/writer/StandardStreamsWriter.java | 8 +++++--- .../impl/core/writer/pattern/ClassPatternSegment.java | 2 +- .../impl/core/writer/pattern/JsonPatternSegment.java | 2 +- .../impl/core/writer/pattern/LevelPatternSegment.java | 2 +- .../writer/pattern/MessageAndExceptionPatternSegment.java | 3 ++- .../impl/core/writer/pattern/MethodPatternSegment.java | 3 ++- .../impl/core/writer/pattern/PatternSegmentType.java | 2 +- .../impl/core/writer/pattern/ThreadPatternSegment.java | 2 +- .../impl/core/writer/pattern/TimestampPatternSegment.java | 2 +- .../impl/core/writer/pattern/VerbatimPatternSegment.java | 2 +- 14 files changed, 25 insertions(+), 18 deletions(-) diff --git a/src/main/java/elf4j/impl/core/configuration/WriterRepository.java b/src/main/java/elf4j/impl/core/configuration/WriterRepository.java index 66cfab3..bb9afa1 100644 --- a/src/main/java/elf4j/impl/core/configuration/WriterRepository.java +++ b/src/main/java/elf4j/impl/core/configuration/WriterRepository.java @@ -32,6 +32,7 @@ import elf4j.impl.core.writer.StandardStreamsWriter; import lombok.NonNull; +import javax.annotation.Nonnull; import java.util.Properties; /** @@ -48,7 +49,7 @@ private WriterRepository(LogWriter logServiceWriter) { /** * @param properties configuration from which to build the writer repo */ - static WriterRepository from(@NonNull Properties properties) { + static @Nonnull WriterRepository from(@NonNull Properties properties) { GroupWriter groupWriter = GroupWriter.from(properties); if (!groupWriter.isEmpty()) { InternalLogger.log(Level.INFO, diff --git a/src/main/java/elf4j/impl/core/service/LogEntry.java b/src/main/java/elf4j/impl/core/service/LogEntry.java index 2d24b03..0c8eaaf 100644 --- a/src/main/java/elf4j/impl/core/service/LogEntry.java +++ b/src/main/java/elf4j/impl/core/service/LogEntry.java @@ -52,7 +52,7 @@ public class LogEntry { @Nullable StackTraceFrame callerFrame; @Nullable ThreadInformation callerThread; - private static String resolve(Object msg, Object[] arguments) { + private static @NonNull String resolve(Object msg, Object[] arguments) { String message = Objects.toString(supply(msg), ""); int messageLength = message.length(); StringBuilder builder = new StringBuilder(messageLength + ADDITIONAL_STRING_BUILDER_CAPACITY); @@ -98,7 +98,7 @@ public static class StackTraceFrame { @NonNull String className; @NonNull String methodName; int lineNumber; - @NonNull String fileName; + String fileName; } /** diff --git a/src/main/java/elf4j/impl/core/util/PropertiesUtils.java b/src/main/java/elf4j/impl/core/util/PropertiesUtils.java index 5904957..f3f044e 100644 --- a/src/main/java/elf4j/impl/core/util/PropertiesUtils.java +++ b/src/main/java/elf4j/impl/core/util/PropertiesUtils.java @@ -25,6 +25,8 @@ package elf4j.impl.core.util; +import lombok.NonNull; + import java.util.Map; import java.util.Properties; import java.util.Set; @@ -44,7 +46,7 @@ private PropertiesUtils() { * @return all properties entries whose original keys start with the specified prefix. The prefix is removed from * the keys of the returned entries. */ - public static Map getChildProperties(String prefix, Properties properties) { + public static Map getChildProperties(String prefix, @NonNull Properties properties) { final String start = prefix + '.'; return properties.stringPropertyNames() .stream() @@ -59,7 +61,7 @@ public static Map getChildProperties(String prefix, Properties p * @return a group whose every member is a set of properties entries having a common key prefix of the specified * type */ - public static Set> getPropertiesGroupOfType(String type, Properties properties) { + public static Set> getPropertiesGroupOfType(String type, @NonNull Properties properties) { return properties.stringPropertyNames() .stream() .filter(name -> properties.getProperty(name).trim().equals(type)) diff --git a/src/main/java/elf4j/impl/core/util/StackTraceUtils.java b/src/main/java/elf4j/impl/core/util/StackTraceUtils.java index 7b4de4e..4de0fdf 100644 --- a/src/main/java/elf4j/impl/core/util/StackTraceUtils.java +++ b/src/main/java/elf4j/impl/core/util/StackTraceUtils.java @@ -73,7 +73,7 @@ public static LogEntry.StackTraceFrame callerOf(@NonNull Class calleeClass) { * @param throwable to extract stack trace text from * @return stack trace text of the specified throwable */ - public static String stackTraceTextOf(Throwable throwable) { + public static String stackTraceTextOf(@NonNull Throwable throwable) { try (StringWriter stringWriter = new StringWriter(); PrintWriter printWriter = new PrintWriter(stringWriter)) { throwable.printStackTrace(printWriter); return stringWriter.toString(); diff --git a/src/main/java/elf4j/impl/core/writer/StandardStreamsWriter.java b/src/main/java/elf4j/impl/core/writer/StandardStreamsWriter.java index 1465d6d..515a0c3 100644 --- a/src/main/java/elf4j/impl/core/writer/StandardStreamsWriter.java +++ b/src/main/java/elf4j/impl/core/writer/StandardStreamsWriter.java @@ -29,7 +29,9 @@ import elf4j.impl.core.service.LogEntry; import elf4j.impl.core.writer.pattern.LogPattern; import elf4j.impl.core.writer.pattern.PatternSegmentGroup; +import lombok.NonNull; +import javax.annotation.Nonnull; import java.io.BufferedOutputStream; import java.io.PrintStream; import java.util.Map; @@ -55,7 +57,7 @@ private StandardStreamsWriter(Level minimumLevel, PatternSegmentGroup logPattern /** * @return default writer */ - public static StandardStreamsWriter defaultWriter() { + public static @Nonnull StandardStreamsWriter defaultWriter() { return new StandardStreamsWriter(DEFAULT_MINIMUM_LEVEL, PatternSegmentGroup.from(DEFAULT_PATTERN), DEFAULT_OUT_STREAM); @@ -65,7 +67,7 @@ public static StandardStreamsWriter defaultWriter() { * @param configuration properties map to make a console writer * @return console writer per the specified configuration */ - public static StandardStreamsWriter from(Map configuration) { + public static @NonNull StandardStreamsWriter from(@NonNull Map configuration) { String level = configuration.get("level"); String pattern = configuration.get("pattern"); String outStreamType = configuration.get("stream"); @@ -80,7 +82,7 @@ public Level getMinimumLevel() { } @Override - public void write(LogEntry logEntry) { + public void write(@NonNull LogEntry logEntry) { if (this.minimumLevel.ordinal() > logEntry.getNativeLogger().getLevel().ordinal()) { return; } diff --git a/src/main/java/elf4j/impl/core/writer/pattern/ClassPatternSegment.java b/src/main/java/elf4j/impl/core/writer/pattern/ClassPatternSegment.java index 35035d1..11fa3da 100644 --- a/src/main/java/elf4j/impl/core/writer/pattern/ClassPatternSegment.java +++ b/src/main/java/elf4j/impl/core/writer/pattern/ClassPatternSegment.java @@ -64,7 +64,7 @@ public boolean includeCallerThread() { } @Override - public void render(LogEntry logEntry, StringBuilder logTextBuilder) { + public void render(@NonNull LogEntry logEntry, StringBuilder logTextBuilder) { String fullName = logEntry.getCallerClassName(); switch (classDisplayOption) { case FULL: diff --git a/src/main/java/elf4j/impl/core/writer/pattern/JsonPatternSegment.java b/src/main/java/elf4j/impl/core/writer/pattern/JsonPatternSegment.java index d9d5521..85f1d96 100644 --- a/src/main/java/elf4j/impl/core/writer/pattern/JsonPatternSegment.java +++ b/src/main/java/elf4j/impl/core/writer/pattern/JsonPatternSegment.java @@ -111,7 +111,7 @@ static class JsonLogEntry { String message; String exception; - static JsonLogEntry from(LogEntry logEntry, JsonPatternSegment jsonPatternSegment) { + static JsonLogEntry from(@NonNull LogEntry logEntry, @NonNull JsonPatternSegment jsonPatternSegment) { return JsonLogEntry.builder() .timestamp(DATE_TIME_FORMATTER.format(logEntry.getTimestamp())) .callerClass(jsonPatternSegment.includeCallerDetail ? null : logEntry.getCallerClassName()) diff --git a/src/main/java/elf4j/impl/core/writer/pattern/LevelPatternSegment.java b/src/main/java/elf4j/impl/core/writer/pattern/LevelPatternSegment.java index d8ee934..a4a7488 100644 --- a/src/main/java/elf4j/impl/core/writer/pattern/LevelPatternSegment.java +++ b/src/main/java/elf4j/impl/core/writer/pattern/LevelPatternSegment.java @@ -68,7 +68,7 @@ public boolean includeCallerThread() { } @Override - public void render(LogEntry logEntry, StringBuilder logTextBuilder) { + public void render(@NonNull LogEntry logEntry, StringBuilder logTextBuilder) { String level = logEntry.getNativeLogger().getLevel().name(); if (displayLength == DISPLAY_LENGTH_UNSET) { logTextBuilder.append(level); diff --git a/src/main/java/elf4j/impl/core/writer/pattern/MessageAndExceptionPatternSegment.java b/src/main/java/elf4j/impl/core/writer/pattern/MessageAndExceptionPatternSegment.java index e0d5108..f53076f 100644 --- a/src/main/java/elf4j/impl/core/writer/pattern/MessageAndExceptionPatternSegment.java +++ b/src/main/java/elf4j/impl/core/writer/pattern/MessageAndExceptionPatternSegment.java @@ -27,6 +27,7 @@ import elf4j.impl.core.service.LogEntry; import elf4j.impl.core.util.StackTraceUtils; +import lombok.NonNull; import lombok.Value; import javax.annotation.Nonnull; @@ -59,7 +60,7 @@ public boolean includeCallerThread() { } @Override - public void render(LogEntry logEntry, StringBuilder logTextBuilder) { + public void render(@NonNull LogEntry logEntry, @NonNull StringBuilder logTextBuilder) { logTextBuilder.append(logEntry.getResolvedMessage()); Throwable t = logEntry.getException(); if (t == null) { diff --git a/src/main/java/elf4j/impl/core/writer/pattern/MethodPatternSegment.java b/src/main/java/elf4j/impl/core/writer/pattern/MethodPatternSegment.java index 876229c..114cabb 100644 --- a/src/main/java/elf4j/impl/core/writer/pattern/MethodPatternSegment.java +++ b/src/main/java/elf4j/impl/core/writer/pattern/MethodPatternSegment.java @@ -26,6 +26,7 @@ package elf4j.impl.core.writer.pattern; import elf4j.impl.core.service.LogEntry; +import lombok.NonNull; import lombok.Value; import javax.annotation.Nonnull; @@ -59,7 +60,7 @@ public boolean includeCallerThread() { } @Override - public void render(LogEntry logEntry, StringBuilder logTextBuilder) { + public void render(@NonNull LogEntry logEntry, @NonNull StringBuilder logTextBuilder) { logTextBuilder.append(Objects.requireNonNull(logEntry.getCallerFrame()).getMethodName()); } } diff --git a/src/main/java/elf4j/impl/core/writer/pattern/PatternSegmentType.java b/src/main/java/elf4j/impl/core/writer/pattern/PatternSegmentType.java index b72fb13..1e6cdae 100644 --- a/src/main/java/elf4j/impl/core/writer/pattern/PatternSegmentType.java +++ b/src/main/java/elf4j/impl/core/writer/pattern/PatternSegmentType.java @@ -169,7 +169,7 @@ static Optional getPatternSegmentOption(@NonNull String patternSegment) * final log message. * @return ordered list of individual patterns forming the entire layout pattern of the writer */ - static List parsePatternSegments(@NonNull String pattern) { + static @NonNull List parsePatternSegments(@NonNull String pattern) { if (pattern.trim().isEmpty()) { throw new IllegalArgumentException("Unexpected blank pattern"); } diff --git a/src/main/java/elf4j/impl/core/writer/pattern/ThreadPatternSegment.java b/src/main/java/elf4j/impl/core/writer/pattern/ThreadPatternSegment.java index 95d00f7..383ed57 100644 --- a/src/main/java/elf4j/impl/core/writer/pattern/ThreadPatternSegment.java +++ b/src/main/java/elf4j/impl/core/writer/pattern/ThreadPatternSegment.java @@ -64,7 +64,7 @@ public boolean includeCallerThread() { } @Override - public void render(LogEntry logEntry, StringBuilder logTextBuilder) { + public void render(@NonNull LogEntry logEntry, @NonNull StringBuilder logTextBuilder) { LogEntry.ThreadInformation callerThread = Objects.requireNonNull(logEntry.getCallerThread()); logTextBuilder.append(threadDisplayOption == DisplayOption.ID ? callerThread.getId() : callerThread.getName()); } diff --git a/src/main/java/elf4j/impl/core/writer/pattern/TimestampPatternSegment.java b/src/main/java/elf4j/impl/core/writer/pattern/TimestampPatternSegment.java index 712ce5a..1a0fafb 100644 --- a/src/main/java/elf4j/impl/core/writer/pattern/TimestampPatternSegment.java +++ b/src/main/java/elf4j/impl/core/writer/pattern/TimestampPatternSegment.java @@ -72,7 +72,7 @@ public boolean includeCallerThread() { } @Override - public void render(LogEntry logEntry, StringBuilder logTextBuilder) { + public void render(@NonNull LogEntry logEntry, @NonNull StringBuilder logTextBuilder) { logTextBuilder.append(dateTimeFormatter.format(logEntry.getTimestamp())); } } diff --git a/src/main/java/elf4j/impl/core/writer/pattern/VerbatimPatternSegment.java b/src/main/java/elf4j/impl/core/writer/pattern/VerbatimPatternSegment.java index e2dac6f..a8a8731 100644 --- a/src/main/java/elf4j/impl/core/writer/pattern/VerbatimPatternSegment.java +++ b/src/main/java/elf4j/impl/core/writer/pattern/VerbatimPatternSegment.java @@ -64,7 +64,7 @@ public boolean includeCallerThread() { } @Override - public void render(LogEntry logEntry, StringBuilder logTextBuilder) { + public void render(LogEntry logEntry, @NonNull StringBuilder logTextBuilder) { logTextBuilder.append(text); } }