Package com.cloudforgeci.api.core.rules

Record Class ComplianceMatrix.FrameworkRequirement

java.lang.Object

java.lang.Record

com.cloudforgeci.api.core.rules.ComplianceMatrix.FrameworkRequirement

Record Components:

citation - the framework control citation (e.g., "AC-2", "CIP-007-6 R2")

level - the requirement enforcement level

Enclosing class:

ComplianceMatrix

public static record ComplianceMatrix.FrameworkRequirement(String citation, ComplianceMatrix.RequirementLevel level)
extends Record

Framework-specific requirement with enforcement level.

Constructor Summary

Constructors

Constructor	Description
FrameworkRequirement(String citation, ComplianceMatrix.RequirementLevel level)	Creates an instance of a FrameworkRequirement record class.

Method Summary

Modifier and Type	Method	Description
static ComplianceMatrix.FrameworkRequirement	advisory(String citation)
String	citation()	Returns the value of the citation record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
ComplianceMatrix.RequirementLevel	level()	Returns the value of the level record component.
static ComplianceMatrix.FrameworkRequirement	notApplicable()
static ComplianceMatrix.FrameworkRequirement	required(String citation)
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

FrameworkRequirement

public FrameworkRequirement(String citation,
 ComplianceMatrix.RequirementLevel level)

Creates an instance of a FrameworkRequirement record class.

Parameters:

citation - the value for the citation record component

level - the value for the level record component

Method Details

required

public static ComplianceMatrix.FrameworkRequirement required(String citation)

advisory

public static ComplianceMatrix.FrameworkRequirement advisory(String citation)

notApplicable

public static ComplianceMatrix.FrameworkRequirement notApplicable()

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

citation

public String citation()

Returns the value of the citation record component.

Returns:

the value of the citation record component

level

public ComplianceMatrix.RequirementLevel level()

Returns the value of the level record component.

Returns:

the value of the level record component