com.github.valid8j.pcond.validator

Enum ReportComposer.Utils

java.lang.Object

java.lang.Enum<ReportComposer.Utils>

com.github.valid8j.pcond.validator.ReportComposer.Utils

All Implemented Interfaces:

Serializable, Comparable<ReportComposer.Utils>

Enclosing interface:

ReportComposer

public static enum ReportComposer.Utils
extends Enum<ReportComposer.Utils>

Method Summary

Modifier and Type	Method and Description
static Explanation	composeExplanation(ReportComposer reportComposer, String message, List<EvaluationEntry> evaluationHistory) Note that an exception thrown during an evaluation is normally caught by the framework.
static ReportComposer.FormattedEntry	createFormattedEntryForActualValue(ReportComposer reportComposer, EvaluationEntry entry)
static ReportComposer.FormattedEntry	createFormattedEntryForExpectation(ReportComposer reportComposer, EvaluationEntry entry)
static ReportComposer.Utils	valueOf(String name) Returns the enum constant of this type with the specified name.
static ReportComposer.Utils[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static ReportComposer.Utils[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ReportComposer.Utils c : ReportComposer.Utils.values())
    System.out.println(c);

Returns:

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

valueOf

public static ReportComposer.Utils valueOf(String name)

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

NullPointerException - if the argument is null

composeExplanation

public static Explanation composeExplanation(ReportComposer reportComposer,
                                             String message,
                                             List<EvaluationEntry> evaluationHistory)

Note that an exception thrown during an evaluation is normally caught by the framework.

Parameters:

message - A message to be prepended to a summary.

evaluationHistory - An "evaluation history" object represented as a list of evaluation entries.

Returns:

An explanation object.

createFormattedEntryForExpectation

public static ReportComposer.FormattedEntry createFormattedEntryForExpectation(ReportComposer reportComposer,
                                                                               EvaluationEntry entry)

createFormattedEntryForActualValue

public static ReportComposer.FormattedEntry createFormattedEntryForActualValue(ReportComposer reportComposer,
                                                                               EvaluationEntry entry)