Record Class CompromisedPasswordResult.Pwned

java.lang.Object

java.lang.Record

com.svenruppert.jsentinel.credential.compromised.CompromisedPasswordResult.Pwned

Record Components:

occurrences - number of times the password is known to have appeared in breach data; sources that do not report a count must use 1

All Implemented Interfaces:

CompromisedPasswordResult

Enclosing interface:

CompromisedPasswordResult

public static record CompromisedPasswordResult.Pwned(long occurrences)
extends Record
implements CompromisedPasswordResult

The candidate password matched a known compromised entry.

Nested Class Summary

Nested classes/interfaces inherited from interface CompromisedPasswordResult

CompromisedPasswordResult.CheckFailed, CompromisedPasswordResult.Clean, CompromisedPasswordResult.FailureReason, CompromisedPasswordResult.Pwned

Modifier and Type	Interface	Description
static final record	CompromisedPasswordResult.CheckFailed	The checker could not produce a verdict — network outage, malformed response, timeout, etc.
static final record	CompromisedPasswordResult.Clean	The candidate password is not present in the checker's data source.
static enum	CompromisedPasswordResult.FailureReason	Structured failure reason — never carries password material, URLs or response bodies.
static final record	CompromisedPasswordResult.Pwned	The candidate password matched a known compromised entry.

Constructor Summary

Constructors

Constructor	Description
Pwned(long occurrences)	Creates an instance of a Pwned record class.

Method Summary

Modifier and Type	Method	Description
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.
long	occurrences()	Returns the value of the occurrences 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

Pwned

public Pwned(long occurrences)

Creates an instance of a Pwned record class.

Parameters:

occurrences - the value for the occurrences record component

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 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.

occurrences

public long occurrences()

Returns the value of the occurrences record component.

Returns:

the value of the occurrences record component