ks.common
Class ArgumentList

java.lang.Object
  ks.common.ArgumentList

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Command, Message

public class ArgumentList

extends java.lang.Object

implements java.io.Serializable

Parent class for both Message and Command classes.

There is a need to serialize commands from the client to the server, and for messages to be returned from the server to the client. In both cases, the commands and messages may have a variable set of arguments.

There are two cases to consider (both supported by this base class).

1. There may be multiple parameters which are differentiated by name creating a set of (name, value) pairs. These are stored and retrieved using the methods: String getArg(String name) and setArg (String name, String value). One can remove a parameter with clearArg(String name).
2. There may simply be a variable set of arguments where one needs to keep track of multiple sets of values, resulting in a set of (name, VALUES). These are stored and retrieved by using the methods: Iterator getArgMulti(String name) and addArgMulti(String name, String value), addArgMulti(String name, Iterator value)addArgMulti(String name, Enumerator value) addArgMulti(String name, String []values). One can clear a MultiValue with clearArgMulti(String name) One can remove a value from a MultiValue with removeArgMulti(String name, String value), removeArgMulti(String name, Iterator values), removeArgMulti(String name, Enumeration values).

If there is only a single argument (either multi-value or not), then the name argument can be omitted.

See Also:

Serialized Form

Constructor Summary

ArgumentList()

Method Summary

void	addArgMulti(java.util.Enumeration en) Add to the default argument by extracting Strings from an Enumeration.
void	addArgMulti(java.util.Iterator it) Add to the default argument by extracting Strings from an Iterator.
void	addArgMulti(java.lang.String arg) Add to the default argument the single String.
void	addArgMulti(java.lang.String[] args) Add to the default arguments the single String.
void	addArgMulti(java.lang.String name, java.util.Enumeration en) Add to the named arguments by extracting Strings from an Enumeration.
void	addArgMulti(java.lang.String name, java.util.Iterator it) Add to the named arguments by extracting Strings from an Iterator.
void	addArgMulti(java.lang.String name, java.lang.String arg) Add to the named argument the single String.
void	addArgMulti(java.lang.String name, java.lang.String[] args) Add to the named argument the single String.
void	clearArg() Remove the default argument from the set.
void	clearArg(java.lang.String name) Remove the argument from the set.
void	clearArgMulti() Remove the default multi argument from set.
void	clearArgMulti(java.lang.String name) Remove the named multi argument from set.
java.lang.String	getArg() Return the value of the default single argument.
java.lang.String	getArg(java.lang.String name) Return the value of the named argument.
java.util.Iterator	getArgMulti() Return the values of the default Multi argument as an Iterator.
java.util.Iterator	getArgMulti(java.lang.String name) Return the values of the named Multi argument as an Iterator.
java.util.Iterator	multiArgs() Return Iterator containing String names of all multi arguments.
void	removeArgMulti(java.util.Enumeration en) Remove from the default arguments by extracting Strings from an Enumeration.
void	removeArgMulti(java.util.Iterator it) Remove from the default argument by extracting Strings from an Iterator.
void	removeArgMulti(java.lang.String arg) Remove from the default arguments the single String.
void	removeArgMulti(java.lang.String[] args) Remove from the default arguments the single String.
void	removeArgMulti(java.lang.String name, java.util.Enumeration en) Remove from the named arguments by extracting Strings from an Enumeration.
void	removeArgMulti(java.lang.String name, java.util.Iterator it) Remove from the named arguments by extracting Strings from an Iterator.
void	removeArgMulti(java.lang.String name, java.lang.String arg) Remove from the named arguments the single String.
void	removeArgMulti(java.lang.String name, java.lang.String[] args) Remove from the named arguments the elements from the String array.
void	setArg(java.lang.String value) Set the value of the default argument.
void	setArg(java.lang.String name, java.lang.String value) Set the value of the named argument.
java.util.Iterator	singleArgs() Return Iterator containing String names of all single arguments.
java.lang.String	toString() Return entire message as a set of name,value pairs

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ArgumentList

public ArgumentList()

Method Detail

getArgMulti

public java.util.Iterator getArgMulti(java.lang.String name)

Return the values of the named Multi argument as an Iterator. If argument is not present, then the empty Iterator is returned.

Parameters:

name - desired argument

getArgMulti

public java.util.Iterator getArgMulti()

Return the values of the default Multi argument as an Iterator. If default argument is not present, then the empty Iterator is returned.

addArgMulti

public void addArgMulti(java.lang.String name,
                        java.util.Enumeration en)

Add to the named arguments by extracting Strings from an Enumeration.

Parameters:

name - desired argument

en - Enumeration

addArgMulti

public void addArgMulti(java.util.Enumeration en)

Add to the default argument by extracting Strings from an Enumeration.

Parameters:

en - Enumeration

addArgMulti

public void addArgMulti(java.lang.String name,
                        java.util.Iterator it)

Add to the named arguments by extracting Strings from an Iterator.

Parameters:

name - desired argument

it - Iterator of String arguments.

addArgMulti

public void addArgMulti(java.util.Iterator it)

Add to the default argument by extracting Strings from an Iterator.

Parameters:

it - Iterator of String arguments

addArgMulti

public void addArgMulti(java.lang.String name,
                        java.lang.String arg)

Add to the named argument the single String.

Parameters:

name - desired argument

arg - value to add to the multiset.

addArgMulti

public void addArgMulti(java.lang.String arg)

Add to the default argument the single String.

Parameters:

arg - value to add to the multiset

addArgMulti

public void addArgMulti(java.lang.String name,
                        java.lang.String[] args)

Add to the named argument the single String.

Parameters:

name - desired argument

args - String[] array of arguments to add

addArgMulti

public void addArgMulti(java.lang.String[] args)

Add to the default arguments the single String.

Parameters:

args - String[] array of arguments to add

removeArgMulti

public void removeArgMulti(java.lang.String name,
                           java.util.Enumeration en)

Remove from the named arguments by extracting Strings from an Enumeration.

Parameters:

name - desired argument

en - Enumeration

removeArgMulti

public void removeArgMulti(java.util.Enumeration en)

Remove from the default arguments by extracting Strings from an Enumeration.

Parameters:

en - Enumeration

removeArgMulti

public void removeArgMulti(java.lang.String name,
                           java.util.Iterator it)

Remove from the named arguments by extracting Strings from an Iterator.

Parameters:

name - desired argument

it - Iterator of String arguments.

removeArgMulti

public void removeArgMulti(java.util.Iterator it)

Remove from the default argument by extracting Strings from an Iterator.

Parameters:

it - Iterator of String arguments.

removeArgMulti

public void removeArgMulti(java.lang.String name,
                           java.lang.String arg)

Remove from the named arguments the single String.

Parameters:

name - desired argument

arg - value to remove from the multiset.

removeArgMulti

public void removeArgMulti(java.lang.String arg)

Remove from the default arguments the single String.

Parameters:

arg - value to remove

removeArgMulti

public void removeArgMulti(java.lang.String name,
                           java.lang.String[] args)

Remove from the named arguments the elements from the String array.

Parameters:

name - desired argument

args - String[] array of values to remove

removeArgMulti

public void removeArgMulti(java.lang.String[] args)

Remove from the default arguments the single String.

Parameters:

args - String[] array of values to remove

clearArgMulti

public void clearArgMulti(java.lang.String name)

Remove the named multi argument from set.

Parameters:

name - desired argument

clearArgMulti

public void clearArgMulti()

Remove the default multi argument from set.

getArg

public java.lang.String getArg(java.lang.String name)

Return the value of the named argument.

Parameters:

name - desired argument

Returns:

value of that argument.

getArg

public java.lang.String getArg()

Return the value of the default single argument.

Returns:

value of default single argument.

setArg

public void setArg(java.lang.String name,
                   java.lang.String value)

Set the value of the named argument.

Parameters:

name - desired argument

value - desired value

setArg

public void setArg(java.lang.String value)

Set the value of the default argument.

Parameters:

value - desired value

clearArg

public void clearArg(java.lang.String name)

Remove the argument from the set.

Parameters:

name - desired argument.

clearArg

public void clearArg()

Remove the default argument from the set.

singleArgs

public java.util.Iterator singleArgs()

Return Iterator containing String names of all single arguments.

Returns:

Iterator of String names for all single arguments.

multiArgs

public java.util.Iterator multiArgs()

Return Iterator containing String names of all multi arguments.

Returns:

Iterator of String names for all multi arguments.

toString

public java.lang.String toString()

Return entire message as a set of name,value pairs