Record Class ControlRequirement

java.lang.Object

java.lang.Record

org.j7m.middleware.compliance.api.ControlRequirement

Record Components:

controlId - stable control id

framework - framework containing the requirement

title - short title

description - safe requirement description

public record ControlRequirement(ControlId controlId, ControlFramework framework, String title, String description)
extends Record

Machine-readable compliance requirement.

Constructor Summary

Constructors

Constructor	Description
ControlRequirement(ControlId controlId, ControlFramework framework, String title, String description)	Creates a normalized requirement.

Method Summary

Modifier and Type	Method	Description
ControlId	controlId()	Returns the value of the controlId record component.
String	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ControlFramework	framework()	Returns the value of the framework record component.
final int	hashCode()	Returns a hash code value for this object.
String	title()	Returns the value of the title 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

ControlRequirement

public ControlRequirement(ControlId controlId,
 ControlFramework framework,
 String title,
 String description)

Creates a normalized requirement.

Method Details

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.

controlId

public ControlId controlId()

Returns the value of the controlId record component.

Returns:

the value of the controlId record component

framework

public ControlFramework framework()

Returns the value of the framework record component.

Returns:

the value of the framework record component

title

public String title()

Returns the value of the title record component.

Returns:

the value of the title record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component