Module org.basinmc.lavatory

Package org.basinmc.lavatory.file

Class LoggerConfiguration

java.lang.Object

org.basinmc.lavatory.file.LoggerConfiguration

public class LoggerConfiguration
extends Object

Represents a special logger configuration which is passed to the program in order to customize its log output.

Author:

Johannes Donath

Constructor Summary

Constructors

Constructor	Description
LoggerConfiguration(LoggerConfigurationFile file, String argument, String type)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Optional<String>	getArgument()	Retrieves the argument with which this configuration is introduced to the application.
LoggerConfigurationFile	getFile()	Retrieves the logger configuration file which is to be passed.
String	getType()	Retrieves the type of log configuration.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggerConfiguration

public LoggerConfiguration(@NonNull
                           LoggerConfigurationFile file,
                           @Nullable
                           String argument,
                           @NonNull
                           String type)

Method Detail

getFile

@NonNull
public LoggerConfigurationFile getFile()

Retrieves the logger configuration file which is to be passed.

Returns:

a configuration file.

getArgument

@NonNull
public Optional<String> getArgument()

Retrieves the argument with which this configuration is introduced to the application.

Typically this value, if present, will also include the ${path} variable which is expected to be replaced with a reference to the log configuration file.

Returns:

an argument which introduces the log file to the application or, if none is necessary, an empty optional.

getType

@NonNull
public String getType()

Retrieves the type of log configuration.

TODO: Replace with an enum?

Returns:

a configuration type.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object