net.digitalid.utility.processing.logging

Class ProcessingLog

java.lang.Object

net.digitalid.utility.processing.logging.ProcessingLog

Direct Known Subclasses:

ErrorLogger

@Utility
public abstract class ProcessingLog
extends Object

This class makes it easier to log messages during annotation processing. If you need to call log(net.digitalid.utility.logging.Level, java.lang.CharSequence, net.digitalid.utility.processing.logging.SourcePosition, java.lang.Object...) directly in order to have a correct Caller.index, you can extend this class.

Constructor Summary

Constructors

Constructor and Description
ProcessingLog()

Method Summary

Modifier and Type	Method and Description
static void	annotatedElements(@Nonnull net.digitalid.utility.functional.iterables.FiniteIterable<? extends TypeElement> annotations, @Nonnull RoundEnvironment roundEnvironment) Logs the elements which are annotated with one of the given annotations of the given round environment.
static void	debugging(@Nonnull CharSequence message, Object... arguments) Logs the given message for debugging.
static void	debugging(@Nonnull CharSequence message, @Nullable SourcePosition position, Object... arguments) Logs the given message with the given position for debugging.
static void	error(@Nonnull CharSequence message, Object... arguments) Logs the given message as an error.
static void	error(@Nonnull CharSequence message, @Nullable SourcePosition position, Object... arguments) Logs the given message with the given position as an error.
static void	information(@Nonnull CharSequence message, Object... arguments) Logs the given message as information.
static void	information(@Nonnull CharSequence message, @Nullable SourcePosition position, Object... arguments) Logs the given message with the given position as information.
static void	initialize(@Nonnull String name) Initializes the output file of the logger with the given name.
protected static void	log(@Nonnull Level level, @Nonnull CharSequence message, @Nullable SourcePosition position, Object... arguments) Logs the given message with the given position at the given level.
static void	rootElements(@Nonnull RoundEnvironment roundEnvironment) Logs the root elements of the given round environment.
static void	verbose(@Nonnull CharSequence message, Object... arguments) Logs the given message only in verbose mode.
static void	verbose(@Nonnull CharSequence message, @Nullable SourcePosition position, Object... arguments) Logs the given message with the given position only in verbose mode.
static void	warning(@Nonnull CharSequence message, Object... arguments) Logs the given message as a warning.
static void	warning(@Nonnull CharSequence message, @Nullable SourcePosition position, Object... arguments) Logs the given message with the given position as a warning.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProcessingLog

public ProcessingLog()

Method Detail

initialize

@Impure
public static void initialize(@Nonnull
                                      @Nonnull String name)
                               throws IllegalArgumentException,
                                      FileNotFoundException

Initializes the output file of the logger with the given name.

Throws:

IllegalArgumentException

FileNotFoundException

log

@Impure
protected static void log(@Nonnull
                                  @Nonnull Level level,
                                  @Nonnull
                                  @Nonnull CharSequence message,
                                  @Nullable
                                  @Nullable SourcePosition position,
                                  @NonCaptured @Unmodified @Nonnull @NullableElements
                                  Object... arguments)

Logs the given message with the given position at the given level. Each dollar sign in the message is replaced with the corresponding argument.

error

@Impure
public static void error(@Nonnull
                                 @Nonnull CharSequence message,
                                 @Nullable
                                 @Nullable SourcePosition position,
                                 @NonCaptured @Unmodified @Nonnull @NullableElements
                                 Object... arguments)

Logs the given message with the given position as an error. Each dollar sign in the message is replaced with the corresponding argument.

error

@Impure
public static void error(@Nonnull
                                 @Nonnull CharSequence message,
                                 @NonCaptured @Unmodified @Nonnull @NullableElements
                                 Object... arguments)

Logs the given message as an error. Each dollar sign in the message is replaced with the corresponding argument.

warning

@Impure
public static void warning(@Nonnull
                                   @Nonnull CharSequence message,
                                   @Nullable
                                   @Nullable SourcePosition position,
                                   @NonCaptured @Unmodified @Nonnull @NullableElements
                                   Object... arguments)

Logs the given message with the given position as a warning. Each dollar sign in the message is replaced with the corresponding argument.

warning

@Impure
public static void warning(@Nonnull
                                   @Nonnull CharSequence message,
                                   @NonCaptured @Unmodified @Nonnull @NullableElements
                                   Object... arguments)

Logs the given message as a warning. Each dollar sign in the message is replaced with the corresponding argument.

information

@Impure
public static void information(@Nonnull
                                       @Nonnull CharSequence message,
                                       @Nullable
                                       @Nullable SourcePosition position,
                                       @NonCaptured @Unmodified @Nonnull @NullableElements
                                       Object... arguments)

Logs the given message with the given position as information. Each dollar sign in the message is replaced with the corresponding argument.

information

@Impure
public static void information(@Nonnull
                                       @Nonnull CharSequence message,
                                       @NonCaptured @Unmodified @Nonnull @NullableElements
                                       Object... arguments)

Logs the given message as information. Each dollar sign in the message is replaced with the corresponding argument.

debugging

@Impure
public static void debugging(@Nonnull
                                     @Nonnull CharSequence message,
                                     @Nullable
                                     @Nullable SourcePosition position,
                                     @NonCaptured @Unmodified @Nonnull @NullableElements
                                     Object... arguments)

Logs the given message with the given position for debugging. Each dollar sign in the message is replaced with the corresponding argument.

debugging

@Impure
public static void debugging(@Nonnull
                                     @Nonnull CharSequence message,
                                     @NonCaptured @Unmodified @Nonnull @NullableElements
                                     Object... arguments)

Logs the given message for debugging. Each dollar sign in the message is replaced with the corresponding argument.

verbose

@Impure
public static void verbose(@Nonnull
                                   @Nonnull CharSequence message,
                                   @Nullable
                                   @Nullable SourcePosition position,
                                   @NonCaptured @Unmodified @Nonnull @NullableElements
                                   Object... arguments)

Logs the given message with the given position only in verbose mode. Each dollar sign in the message is replaced with the corresponding argument.

verbose

@Impure
public static void verbose(@Nonnull
                                   @Nonnull CharSequence message,
                                   @NonCaptured @Unmodified @Nonnull @NullableElements
                                   Object... arguments)

Logs the given message only in verbose mode. Each dollar sign in the message is replaced with the corresponding argument.

annotatedElements

@Impure
public static void annotatedElements(@Nonnull
                                             @Nonnull net.digitalid.utility.functional.iterables.FiniteIterable<? extends TypeElement> annotations,
                                             @Nonnull
                                             @Nonnull RoundEnvironment roundEnvironment)

Logs the elements which are annotated with one of the given annotations of the given round environment.

rootElements

@Impure
public static void rootElements(@Nonnull
                                        @Nonnull RoundEnvironment roundEnvironment)

Logs the root elements of the given round environment.