Record Class RedactionSummary

java.lang.Object

java.lang.Record

com.shaft.capture.model.RedactionSummary

Record Components:

redactedValueCount - number of values replaced by references

removedAttributeCount - number of sensitive attributes removed

redactedUrlParameterCount - number of URL parameters redacted

appliedRules - names of deterministic rules that were applied

public record RedactionSummary(int redactedValueCount, int removedAttributeCount, int redactedUrlParameterCount, Set<String> appliedRules)
extends Record

Safe aggregate of privacy decisions without removed values.

Constructor Summary

Constructors

Constructor	Description
RedactionSummary(int redactedValueCount, int removedAttributeCount, int redactedUrlParameterCount, Set<String> appliedRules)	Creates a safe immutable summary.

Method Summary

Modifier and Type	Method	Description
Set<String>	appliedRules()	Returns the value of the appliedRules record component.
static RedactionSummary	empty()	Returns an empty summary.
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.
RedactionSummary	merge(RedactionSummary other)	Combines two safe summaries.
int	redactedUrlParameterCount()	Returns the value of the redactedUrlParameterCount record component.
int	redactedValueCount()	Returns the value of the redactedValueCount record component.
int	removedAttributeCount()	Returns the value of the removedAttributeCount record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RedactionSummary

public RedactionSummary(int redactedValueCount,
 int removedAttributeCount,
 int redactedUrlParameterCount,
 Set<String> appliedRules)

Creates a safe immutable summary.

Method Details

empty

public static RedactionSummary empty()

Returns an empty summary.

Returns:

empty summary

merge

public RedactionSummary merge(RedactionSummary other)

Combines two safe summaries.

Parameters:

other - summary to add

Returns:

combined summary

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.

redactedValueCount

public int redactedValueCount()

Returns the value of the redactedValueCount record component.

Returns:

the value of the redactedValueCount record component

removedAttributeCount

public int removedAttributeCount()

Returns the value of the removedAttributeCount record component.

Returns:

the value of the removedAttributeCount record component

redactedUrlParameterCount

public int redactedUrlParameterCount()

Returns the value of the redactedUrlParameterCount record component.

Returns:

the value of the redactedUrlParameterCount record component

appliedRules

public Set<String> appliedRules()

Returns the value of the appliedRules record component.

Returns:

the value of the appliedRules record component