me.gosimple.nbvcxz.scoring

Class Result

java.lang.Object

me.gosimple.nbvcxz.scoring.Result

public class Result
extends Object

This class contains all info about the entropy calculation.

Author:

Adam Brusselback

Constructor Summary

Constructors

Constructor and Description
Result(Configuration configuration, String password, List<Match> matches)

Method Summary

Modifier and Type	Method and Description
Configuration	getConfiguration() Returns the configuration used to generate this result.
Double	getEntropy() Returns the entropy for this Result.
Feedback	getFeedback() Returns feedback to the user to suggest ways to improve their password.
BigDecimal	getGuesses() The estimated number of tries required to crack this password
List<Match>	getMatches() The matches that comprise this result.
String	getPassword() The original password passed in.
boolean	isMinimumEntropyMet() Returns whether the minimum entropy specified in the config was met.
boolean	isRandom() Returns whether the password is considered to be random.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Result

public Result(Configuration configuration,
              String password,
              List<Match> matches)
       throws IllegalStateException

Parameters:

configuration - the Configuration object.

password - the password this result was generated for

matches - list of matches which when combined make up the original password

Throws:

IllegalStateException - if the matches do not equal the original password, this will be thrown.

Method Detail

getEntropy

public Double getEntropy()

Returns the entropy for this Result.

Returns:

the estimated entropy as a double.

getGuesses

public BigDecimal getGuesses()

The estimated number of tries required to crack this password

Returns:

the estimated number of guesses as a BigDecimal

getMatches

public List<Match> getMatches()

The matches that comprise this result.

Returns:

a List of Match that were used in this result estimation.

getPassword

public String getPassword()

The original password passed in.

Returns:

String of the original password.

isMinimumEntropyMet

public boolean isMinimumEntropyMet()

Returns whether the minimum entropy specified in the config was met.

Returns:

true if minimum entropy is met; false if not.

isRandom

public boolean isRandom()

Returns whether the password is considered to be random.

Returns:

true if the password is considered random, false otherwise.

getConfiguration

public Configuration getConfiguration()

Returns the configuration used to generate this result.

Returns:

Configuration that was used to generate this Result.

getFeedback

public Feedback getFeedback()

Returns feedback to the user to suggest ways to improve their password.

Returns:

a Feedback object with suggestions for the user.