Package org.apache.logging.log4j.core
Enum Filter.Result
- java.lang.Object
-
- java.lang.Enum<Filter.Result>
-
- org.apache.logging.log4j.core.Filter.Result
-
- All Implemented Interfaces:
Serializable
,Comparable<Filter.Result>
- Enclosing interface:
- Filter
public static enum Filter.Result extends Enum<Filter.Result>
The result that can returned from a filter method call.
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Filter.Result
toResult(String name)
Returns the Result for the given string.static Filter.Result
toResult(String name, Filter.Result defaultResult)
Returns the Result for the given string.static Filter.Result
valueOf(String name)
Returns the enum constant of this type with the specified name.static Filter.Result[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ACCEPT
public static final Filter.Result ACCEPT
The event will be processed without further filtering based on the log Level.
-
NEUTRAL
public static final Filter.Result NEUTRAL
No decision could be made, further filtering should occur.
-
DENY
public static final Filter.Result DENY
The event should not be processed.
-
-
Method Detail
-
values
public static Filter.Result[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (Filter.Result c : Filter.Result.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Filter.Result valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
toResult
public static Filter.Result toResult(String name)
Returns the Result for the given string.- Parameters:
name
- The Result enum name, case-insensitive. If null, returns, null- Returns:
- a Result enum value or null if name is null
-
toResult
public static Filter.Result toResult(String name, Filter.Result defaultResult)
Returns the Result for the given string.- Parameters:
name
- The Result enum name, case-insensitive. If null, returns, defaultResultdefaultResult
- the Result to return if name is null- Returns:
- a Result enum value or null if name is null
-
-