BurstFilter.Builder (Apache Log4j 2 2.10.0 API)

java.lang.Object
- org.apache.logging.log4j.core.filter.BurstFilter.Builder

All Implemented Interfaces:: Builder<BurstFilter>

Enclosing class:: BurstFilter

public static class BurstFilter.Builder
extends java.lang.Object
implements Builder<BurstFilter>

Constructor Summary

Constructors
Constructor Description

Builder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BurstFilter`	`build()`	Builds the object after all configuration has been set.
`BurstFilter.Builder`	`setLevel(Level level)`	Sets the logging level to use.
`BurstFilter.Builder`	`setMaxBurst(long maxBurst)`	Sets the maximum number of events that can occur before events are filtered for exceeding the average rate.
`BurstFilter.Builder`	`setOnMatch(Filter.Result onMatch)`	Sets the Result to return when the filter matches.
`BurstFilter.Builder`	`setOnMismatch(Filter.Result onMismatch)`	Sets the Result to return when the filter does not match.
`BurstFilter.Builder`	`setRate(float rate)`	Sets the average number of events per second to allow.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - setLevel
```
public BurstFilter.Builder setLevel(Level level)
```
    Sets the logging level to use.
  - setRate
```
public BurstFilter.Builder setRate(float rate)
```
    Sets the average number of events per second to allow. This must be a positive number.
  - setMaxBurst
```
public BurstFilter.Builder setMaxBurst(long maxBurst)
```
    Sets the maximum number of events that can occur before events are filtered for exceeding the average rate. The default is 10 times the rate.
  - setOnMatch
```
public BurstFilter.Builder setOnMatch(Filter.Result onMatch)
```
    Sets the Result to return when the filter matches. Defaults to Result.NEUTRAL.
  - setOnMismatch
```
public BurstFilter.Builder setOnMismatch(Filter.Result onMismatch)
```
    Sets the Result to return when the filter does not match. The default is Result.DENY.
  - build
```
public BurstFilter build()
```
    Description copied from interface: Builder
    
    Builds the object after all configuration has been set. This will use default values for any unspecified attributes for the object.
    
    Specified by:
    
    build in interface Builder<BurstFilter>
    
    Returns:
    
    the configured instance.