Package org.apache.logging.log4j.core.config.arbiters

Class EnvironmentArbiter

java.lang.Object

org.apache.logging.log4j.core.config.arbiters.EnvironmentArbiter

All Implemented Interfaces:

Arbiter

@Plugin(name="EnvironmentArbiter",
        category="Core",
        elementType="Arbiter",
        deferChildren=true,
        printObject=true)
public class EnvironmentArbiter
extends java.lang.Object
implements Arbiter

Condition that determines if the specified environment variable is set.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EnvironmentArbiter.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	propertyName
private java.lang.String	propertyValue

Fields inherited from interface org.apache.logging.log4j.core.config.arbiters.Arbiter

ELEMENT_TYPE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	EnvironmentArbiter(java.lang.String propertyName, java.lang.String propertyValue)

Method Summary

Modifier and Type	Method	Description
boolean	isCondition()	Returns true if either the environment variable is defined (it has any value) or the property value matches the requested value.
static EnvironmentArbiter.Builder	newBuilder()

Methods inherited from class java.lang.Object

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

Field Detail

propertyName

private final java.lang.String propertyName

propertyValue

private final java.lang.String propertyValue

Constructor Detail

EnvironmentArbiter

private EnvironmentArbiter(java.lang.String propertyName,
                           java.lang.String propertyValue)

Method Detail

isCondition

public boolean isCondition()

Returns true if either the environment variable is defined (it has any value) or the property value matches the requested value.

Specified by:

isCondition in interface Arbiter

newBuilder

@PluginBuilderFactory
public static EnvironmentArbiter.Builder newBuilder()