Record Class ConstraintVerdict

java.lang.Object

java.lang.Record

com.eqixiac.equinix.design.spi.ConstraintVerdict

Record Components:

constraintId - the Constraint.id()

satisfied - whether the portfolio is allowed

reason - why it failed, or what was verified; shown to the reader

public record ConstraintVerdict(String constraintId, boolean satisfied, String reason)
extends Record

The outcome of checking one Constraint against one portfolio.

Constructor Summary

Constructors

Constructor	Description
ConstraintVerdict(String constraintId, boolean satisfied, String reason)	Creates an instance of a ConstraintVerdict record class.

Method Summary

Modifier and Type	Method	Description
String	constraintId()	Returns the value of the constraintId record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static ConstraintVerdict	fail(String constraintId, String reason)
final int	hashCode()	Returns a hash code value for this object.
static ConstraintVerdict	pass(String constraintId, String reason)
String	reason()	Returns the value of the reason record component.
boolean	satisfied()	Returns the value of the satisfied record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ConstraintVerdict

public ConstraintVerdict(String constraintId,
 boolean satisfied,
 String reason)

Creates an instance of a ConstraintVerdict record class.

Parameters:

constraintId - the value for the constraintId record component

satisfied - the value for the satisfied record component

reason - the value for the reason record component

Method Details

pass

public static ConstraintVerdict pass(String constraintId,
 String reason)

Parameters:

constraintId - the constraint

reason - what was verified

Returns:

a passing verdict

fail

public static ConstraintVerdict fail(String constraintId,
 String reason)

Parameters:

constraintId - the constraint

reason - why the portfolio is not allowed

Returns:

a failing verdict

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

constraintId

public String constraintId()

Returns the value of the constraintId record component.

Returns:

the value of the constraintId record component

satisfied

public boolean satisfied()

Returns the value of the satisfied record component.

Returns:

the value of the satisfied record component

reason

public String reason()

Returns the value of the reason record component.

Returns:

the value of the reason record component