ml.alternet.security.web

Class PasswordParam

java.lang.Object

ml.alternet.security.web.PasswordParam

All Implemented Interfaces:

Iterable<Password>, Destroyable, Unwrappable<Password>, Password

public class PasswordParam
extends Object
implements Password, Iterable<Password>, Unwrappable<Password>

Represent a non empty sequence of passwords.

If no passwords are in this sequence, the current item is the empty password.

NOTE : All the values are available at once in a PasswordParam. Actually, PasswordParam is iterable on all the passwords bound to the same name (if any) and already refer the first one in the sequence (if any, otherwise it refers to the empty password) ; therefore, it is irrelevant to specifically ask for a List<PasswordParam>, a Set<PasswordParam> or a SortedSet<PasswordParam>.

Author:

Philippe Poulard

Nested Class Summary

Nested classes/interfaces inherited from interface ml.alternet.security.Password

Password.Clear

Nested classes/interfaces inherited from interface ml.alternet.facet.Unwrappable

Unwrappable.Unwrapper

Constructor Summary

Constructors

Constructor and Description
PasswordParam() Convenient constructor for a sequence representing the empty password.
PasswordParam(Iterator<Password> sequence) Create a sequence of passwords.
PasswordParam(Password password) Convenient constructor for a sequence of a single password.

Method Summary

Modifier and Type	Method and Description
void	destroy() Invalidate this password.
Password.Clear	getClearCopy() Wrap this password in a clear copy.
boolean	hasNext() Indicates whether there is a next password in this sequence.
Iterator<Password>	iterator()
PasswordParam	next() Return the next password in this sequence.
PasswordState	state() Return the state of this password.
String	toString()
Password	unwrap()

Methods inherited from class java.lang.Object

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

Methods inherited from interface ml.alternet.security.Password

isDestroyed, newPassword

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

PasswordParam

public PasswordParam(Iterator<Password> sequence)

Create a sequence of passwords.

Parameters:

sequence - An iterator on the sequence.

PasswordParam

public PasswordParam(Password password)

Convenient constructor for a sequence of a single password.

Parameters:

password - The single password of the sequence.

PasswordParam

public PasswordParam()

Convenient constructor for a sequence representing the empty password.

Method Detail

destroy

public void destroy()

Description copied from interface: Password

Invalidate this password.

Specified by:

destroy in interface Destroyable

Specified by:

destroy in interface Password

state

public PasswordState state()

Description copied from interface: Password

Return the state of this password.

Specified by:

state in interface Password

Returns:

Empty, Valid, or Invalid

getClearCopy

public Password.Clear getClearCopy()
                            throws IllegalStateException

Description copied from interface: Password

Wrap this password in a clear copy.

Specified by:

getClearCopy in interface Password

Returns:

A working copy of the password.

Throws:

IllegalStateException - If this password has been invalidated.

hasNext

public boolean hasNext()

Indicates whether there is a next password in this sequence.

Returns:

true if a password is available, false otherwise.

next

public PasswordParam next()

Return the next password in this sequence.

Returns:

The next password in this sequence.

iterator

public Iterator<Password> iterator()

Specified by:

iterator in interface Iterable<Password>

toString

public String toString()

Overrides:

toString in class Object

unwrap

public Password unwrap()

Specified by:

unwrap in interface Unwrappable<Password>