Enum Class Retention

java.lang.Object

java.lang.Enum<Retention>

burp.api.montoya.http.execution.Retention

All Implemented Interfaces:

Serializable, Comparable<Retention>, Constable

public enum Retention
extends Enum<Retention>

A ResponseHandler's verdict on a single completed request: whether to retain its RequestResult in the terminal RequestExecutionResult. Returned from ResponseHandler.onResponse(burp.api.montoya.http.execution.RequestResult, burp.api.montoya.http.execution.RequestExecution).

A run with no handler keeps every result. A handler returns DROP for results it does not want - useful for bounding memory on large runs, where the uninteresting results are discarded as they arrive.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DROP	Discard this result entirely: it does not appear in RequestExecutionResult.results().
KEEP	Keep this result in the terminal RequestExecutionResult.

Method Summary

Modifier and Type	Method	Description
static Retention	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Retention[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

KEEP

public static final Retention KEEP

Keep this result in the terminal RequestExecutionResult.

DROP

public static final Retention DROP

Discard this result entirely: it does not appear in RequestExecutionResult.results(). It is still counted in the run's stats.

Method Details

values

public static Retention[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Retention valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null