Top Description Fields Constructors Methods
org.opentest4j.reporting.tooling.core.validator

public final Record ValidationResult

extends Record
implements Iterable<ValidationMessage>
Class Inheritance
All Implemented Interfaces
java.lang.Iterable
Annotations
@API
status:EXPERIMENTAL
since:0.1.0
Record Components
messages:List<ValidationMessage>
the validation messages
Imports
org.apiguardian.api.API, java.util.Iterator, .List, .Objects

Result of validating an XML report file.
Since
0.1.0

Field Summary

Modifier and TypeField and Description
private final List<ValidationMessage>
messages

Record Component accessed by messages().

the validation messages

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

number of validation messages with the supplied severity
count
(Severity
the severity to count
severity
)

Count the number of validation messages with the supplied severity.

public final boolean
equals(Object
the reference object with which to compare.
o
)

Implements abstract java.lang.Record.equals.

Indicates whether some other object is "equal to" this one.

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public Iterator<ValidationMessage>
iterator()

Implements java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

public List<ValidationMessage>
messages()

Record Component getter of messages.

Record Component the validation messages

public String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

messagesback to summary
private final List<ValidationMessage> messages

Record Component accessed by messages().

the validation messages

Constructor Detail

ValidationResultback to summary
public ValidationResult(List<ValidationMessage> messages)

Method Detail

countback to summary
public long count(Severity severity)

Count the number of validation messages with the supplied severity.

Parameters
severity:Severity

the severity to count

Returns:long

number of validation messages with the supplied severity

equalsback to summary
public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this record is equal to the argument; false otherwise.

hashCodeback to summary
public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

Returns:int

a hash code value for this record.

iteratorback to summary
public Iterator<ValidationMessage> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:Iterator<ValidationMessage>

an Iterator.

Annotations
@Override
messagesback to summary
public List<ValidationMessage> messages()

Record Component getter of messages.

Record Component
the validation messages
toStringback to summary
public String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

Returns:String

a string representation of the object.

Annotations
@Override