org.dishevelled.commandline

Class ArgumentList

java.lang.Object

org.dishevelled.commandline.ArgumentList

All Implemented Interfaces:

Iterable<Argument<?>>

public final class ArgumentList
extends Object
implements Iterable<Argument<?>>

An argument list.

Author:

Michael Heuer

Constructor Summary

Constructors

Constructor and Description
ArgumentList() Create a new empty argument list.
ArgumentList(Argument<?>... arguments) Create a new argument list with the specified arguments.
ArgumentList(Collection<Argument<?>> arguments) Create a new argument list with the arguments in the specified collection of arguments.

Method Summary

Modifier and Type	Method and Description
boolean	add(Argument<?> argument) Add the specified argument to this argument list.
boolean	addAll(Collection<Argument<?>> arguments) Add all of the arguments in the specified collection of arguments to this argument list.
Iterator<Argument<?>>	iterator()
int	size() Return the number of arguments in this argument list.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ArgumentList

public ArgumentList()

Create a new empty argument list.

ArgumentList

public ArgumentList(Argument<?>... arguments)

Create a new argument list with the specified arguments. The arguments must not contain any duplicate short or long names or an IllegalArgumentException will be thrown.

Parameters:

arguments - variable number of arguments, must not be null

ArgumentList

public ArgumentList(Collection<Argument<?>> arguments)

Create a new argument list with the arguments in the specified collection of arguments. The arguments will be copied defensively into this class. The arguments in arguments must not contain any duplicate short or long names or an IllegalArgumentException will be thrown.

Parameters:

arguments - collection of arguments to add, must not be null

Method Detail

add

public boolean add(Argument<?> argument)

Add the specified argument to this argument list. An argument with the same short or long name as the specified argument must not be contained in this argument list already or an IllegalArgumentException will be thrown.

Parameters:

argument - argument to add, must not be null

Returns:

true if this argument list changed as a result of the call

addAll

public boolean addAll(Collection<Argument<?>> arguments)

Add all of the arguments in the specified collection of arguments to this argument list. An argument with the same short or long name as any of the arguments in arguments must not be contained in this argument list already or an IllegalArgumentException will be thrown.

Parameters:

arguments - collection of arguments to add, must not be null

Returns:

true if this argument list changed as a result of the call

size

public int size()

Return the number of arguments in this argument list.

Returns:

the number of arguments in this argument list

iterator

public Iterator<Argument<?>> iterator()

Specified by:

iterator in interface Iterable<Argument<?>>