Class Log4j2

java.lang.Object

io.micronaut.starter.feature.logging.Log4j2

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature, LoggingFeature, OneOfFeature

@Requires(property="micronaut.starter.feature.log4j2.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class Log4j2
extends Object
implements LoggingFeature

Logging feature that adds Log4j 2 support.

This feature configures the necessary dependencies and provides a default Log4j 2 configuration file for the project.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
Log4j2()

Method Summary

Modifier and Type	Method	Description
void	apply(GeneratorContext generatorContext)	If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature).
@NonNull String	getDescription()
@NonNull String	getName()	The name of the feature.
String	getTitle()

Methods inherited from class Object

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

Methods inherited from interface io.micronaut.core.naming.Described

getDescription

Methods inherited from interface Feature

getFrameworkDocumentation, getOrder, getThirdPartyDocumentation, isCommunity, isPreview, isVisible, processSelectedFeatures, supports

Methods inherited from interface LoggingFeature

getCategory, getFeatureClass

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

Log4j2

public Log4j2()

Method Details

getName

@NonNull
public @NonNull String getName()

Description copied from interface: Feature

The name of the feature. It must be unique.

Specified by:

getName in interface Feature

Specified by:

getName in interface io.micronaut.core.naming.Named

Returns:

the name of the feature

getTitle

public String getTitle()

Specified by:

getTitle in interface Feature

Returns:

The title of the feature

getDescription

@NonNull
public @NonNull String getDescription()

Specified by:

getDescription in interface io.micronaut.core.naming.Described

Specified by:

getDescription in interface Feature

apply

public void apply(GeneratorContext generatorContext)

Description copied from interface: Feature

If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature). At this point the feature list is set and cannot change.

Specified by:

apply in interface Feature

Parameters:

generatorContext - THe generator context