Package com.atlassian.crowd.embedded.api

Enum Class PasswordScore

java.lang.Object

java.lang.Enum<PasswordScore>

com.atlassian.crowd.embedded.api.PasswordScore

All Implemented Interfaces:

Serializable, Comparable<PasswordScore>, Constable

public enum PasswordScore
extends Enum<PasswordScore>

A rating of a password based on estimated difficulty of cracking by some PasswordScoreService.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAIR
GOOD
STRONG
UNKNOWN
VERY_STRONG
WEAK

Method Summary

Modifier and Type	Method	Description
static PasswordScore	fromRanking(long ranking)
long	getRanking()
boolean	isAtLeast(PasswordScore minimumScore)	Uses an internal ranking to compare the scores and determine if it is 'just as strong'.
static PasswordScore	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PasswordScore[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final PasswordScore UNKNOWN

WEAK

public static final PasswordScore WEAK

FAIR

public static final PasswordScore FAIR

GOOD

public static final PasswordScore GOOD

STRONG

public static final PasswordScore STRONG

VERY_STRONG

public static final PasswordScore VERY_STRONG

Method Details

values

public static PasswordScore[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PasswordScore valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

fromRanking

public static PasswordScore fromRanking(long ranking)

isAtLeast

public boolean isAtLeast(PasswordScore minimumScore)

Uses an internal ranking to compare the scores and determine if it is 'just as strong'. It will return true if this score is greater than or equal to the parameter. Note that this means UNKNOWN is at least as strong as UNKNOWN.

Parameters:

minimumScore - the score to compare to

Returns:

If this score is at least as strong as the score being passed in

getRanking

public long getRanking()