Package org.apache.logging.log4j.core.filter

Class StringMatchFilter.Builder

java.lang.Object

org.apache.logging.log4j.core.filter.AbstractFilter.AbstractFilterBuilder<StringMatchFilter.Builder>

org.apache.logging.log4j.core.filter.StringMatchFilter.Builder

All Implemented Interfaces:

Builder<StringMatchFilter>

Enclosing class:

StringMatchFilter

public static class StringMatchFilter.Builder
extends AbstractFilter.AbstractFilterBuilder<StringMatchFilter.Builder>
implements Builder<StringMatchFilter>

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	text

Fields inherited from class org.apache.logging.log4j.core.filter.AbstractFilter.AbstractFilterBuilder

ATTR_ON_MATCH, ATTR_ON_MISMATCH

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StringMatchFilter	build()	Builds the object after all configuration has been set.
StringMatchFilter.Builder	setMatchString(java.lang.String text)	Deprecated. since 2.25.0, use setText(java.lang.String) instead.
StringMatchFilter.Builder	setText(java.lang.String text)	Sets the text to search in event messages.

Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilter.AbstractFilterBuilder

asBuilder, getOnMatch, getOnMismatch, setOnMatch, setOnMismatch

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.util.Builder

getErrorPrefix, isValid

Field Detail

text

@PluginBuilderAttribute
@Required(message="No text provided for StringMatchFilter")
private java.lang.String text

Constructor Detail

Builder

public Builder()

Method Detail

setMatchString

@Deprecated
public StringMatchFilter.Builder setMatchString(java.lang.String text)

Deprecated.

since 2.25.0, use setText(java.lang.String) instead.

setText

public StringMatchFilter.Builder setText(java.lang.String text)

Sets the text to search in event messages.

Parameters:

text - the text to search in event messages.

Returns:

this instance.

Since:

2.25.0

build

public StringMatchFilter 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<StringMatchFilter>

Returns:

the configured instance.