org.zaproxy.zap.spider.filters

Class ParseFilter.FilterResult

java.lang.Object

org.zaproxy.zap.spider.filters.ParseFilter.FilterResult

Enclosing class:

ParseFilter

public static final class ParseFilter.FilterResult
extends Object

The result of a ParseFilter's check.

Used to indicate if a resource was filtered and why.

Since:

2.7.0

See Also:

NOT_FILTERED, FilterResult(String)

Field Summary

Fields

Modifier and Type	Field and Description
static ParseFilter.FilterResult	FILTERED Indicates that the resource was filtered, with no specific reason.
static ParseFilter.FilterResult	NOT_FILTERED Indicates that the resource was not filtered.
static ParseFilter.FilterResult	WANTED Indicates that the resource is wanted by a custom parser.

Constructor Summary

Constructors

Constructor and Description
FilterResult(String reason) Constructs a FilterResult with the reason why the resource will not be parsed.

Method Summary

Modifier and Type	Method and Description
String	getReason() Gets the reason why the resource was filtered.
boolean	isFiltered() Tells whether or not the resource was filtered.

Methods inherited from class java.lang.Object

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

Field Detail

NOT_FILTERED

public static final ParseFilter.FilterResult NOT_FILTERED

Indicates that the resource was not filtered.

WANTED

public static final ParseFilter.FilterResult WANTED

Indicates that the resource is wanted by a custom parser. The resource skips the default filter, if no other filter filters it out.

FILTERED

public static final ParseFilter.FilterResult FILTERED

Indicates that the resource was filtered, with no specific reason.

Constructor Detail

FilterResult

public FilterResult(String reason)

Constructs a FilterResult with the reason why the resource will not be parsed.

Parameters:

reason - the reason why the resource was filtered.

See Also:

NOT_FILTERED

Method Detail

isFiltered

public boolean isFiltered()

Tells whether or not the resource was filtered.

Filtered resources are not parsed.

Returns:

true if the resource was filtered, false otherwise.

See Also:

getReason()

getReason

public String getReason()

Gets the reason why the resource was filtered.

Returns:

the reason why the resource was filtered, never null.

See Also:

isFiltered()