Record Class ComplianceScope

java.lang.Object

java.lang.Record

org.j7m.middleware.compliance.api.ComplianceScope

Record Components:

environment - environment label

runtimeIds - scoped runtime ids

modules - scoped modules

notes - safe scope notes

public record ComplianceScope(String environment, List<String> runtimeIds, List<String> modules, String notes)
extends Record

Scope used when collecting evidence or generating a report.

Constructor Summary

Constructors

Constructor	Description
ComplianceScope(String environment, List<String> runtimeIds, List<String> modules, String notes)	Creates immutable scope values.

Method Summary

Modifier and Type	Method	Description
String	environment()	Returns the value of the environment 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.
static ComplianceScope	local()	Returns a default local development scope.
List<String>	modules()	Returns the value of the modules record component.
String	notes()	Returns the value of the notes record component.
List<String>	runtimeIds()	Returns the value of the runtimeIds 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

ComplianceScope

public ComplianceScope(String environment,
 List<String> runtimeIds,
 List<String> modules,
 String notes)

Creates immutable scope values.

Method Details

local

public static ComplianceScope local()

Returns a default local development scope.

Returns:

default scope

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.

environment

public String environment()

Returns the value of the environment record component.

Returns:

the value of the environment record component

runtimeIds

public List<String> runtimeIds()

Returns the value of the runtimeIds record component.

Returns:

the value of the runtimeIds record component

modules

public List<String> modules()

Returns the value of the modules record component.

Returns:

the value of the modules record component

notes

public String notes()

Returns the value of the notes record component.

Returns:

the value of the notes record component