Package com.github.invictum.reportportal

Enum Class LogsPreset

java.lang.Object

java.lang.Enum<LogsPreset>

com.github.invictum.reportportal.LogsPreset

All Implemented Interfaces:

Serializable, Comparable<LogsPreset>, Constable

public enum LogsPreset
extends Enum<LogsPreset>

Describes a presets of predefined log units.

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
CUSTOM	Custom preset for manual configuration.
DEFAULT	Default preset with pre-defined minimalistic set of log units.
FULL	Preset configured with all available out of the box log units.

Method Summary

Modifier and Type	Method	Description
abstract Function<net.thucydides.core.model.TestStep,Collection<com.epam.ta.reportportal.ws.model.log.SaveLogRQ>>[]	logUnits()	Returns an array of log units associated with current preset
LogsPreset	register(Function<net.thucydides.core.model.TestStep,Collection<com.epam.ta.reportportal.ws.model.log.SaveLogRQ>>... units)	Configures a preset to use a list of passed log units.
static LogsPreset	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LogsPreset[]	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

DEFAULT

public static final LogsPreset DEFAULT

Default preset with pre-defined minimalistic set of log units.

FULL

public static final LogsPreset FULL

Preset configured with all available out of the box log units.

CUSTOM

public static final LogsPreset CUSTOM

Custom preset for manual configuration. By default returns an empty array of log units.

Method Details

values

public static LogsPreset[] 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 LogsPreset 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

logUnits

public abstract Function<net.thucydides.core.model.TestStep,Collection<com.epam.ta.reportportal.ws.model.log.SaveLogRQ>>[] logUnits()

Returns an array of log units associated with current preset

register

public LogsPreset register(Function<net.thucydides.core.model.TestStep,Collection<com.epam.ta.reportportal.ws.model.log.SaveLogRQ>>... units)

Configures a preset to use a list of passed log units. Registration is allowed only for CUSTOM preset