de.intarsys.tools.functor

Class Args

java.lang.Object

de.intarsys.tools.functor.Args

All Implemented Interfaces:

IArgs

public class Args
extends java.lang.Object
implements IArgs

A concrete generic implementation for IArgs.

Field Summary

Fields

Modifier and Type	Field and Description
static IArgs	EMPTY

Fields inherited from interface de.intarsys.tools.functor.IArgs

ARG_ARGS

Constructor Summary

Constructors

Constructor and Description
Args()
Args(IArgs args)
Args(java.util.List values)
Args(java.util.Map values)
Args(java.lang.Object[] values)

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.Object object)
void	clear()
static Args	create()
static Args	createIndexed()
static Args	createIndexed(java.lang.Object p1)
static Args	createIndexed(java.lang.Object p1, java.lang.Object p2)
static Args	createIndexed(java.lang.Object p1, java.lang.Object p2, java.lang.Object p3)
static Args	createNamed()
static Args	createNamed(java.lang.String key, java.lang.Object value)
static Args	createNamed(java.lang.String key1, java.lang.Object value1, java.lang.String key2, java.lang.Object value2)
IArgs	declare(java.lang.String name, int index, java.lang.Object value)
java.lang.Object	get(int index) The argument at position index.
java.lang.Object	get(int index, java.lang.Object defaultValue) The argument at position index
java.lang.Object	get(java.lang.String name) The argument named name.
java.lang.Object	get(java.lang.String name, java.lang.Object defaultValue) The argument named name or the defaultValue if not available.
boolean	isDefined(int index) true if an argument at index is defined.
boolean	isDefined(java.lang.String name) true if an argument named name is defined.
boolean	isIndexed() true if this argument list is indexed.
boolean	isNamed() true if this argument list is named.
java.util.Set	names() The set of all argument names in the argument list if this argument list is not indexed or null.
void	put(int index, java.lang.Object value)
void	put(java.lang.String name, java.lang.Object value)
int	size() The total number of arguments.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final IArgs EMPTY

Constructor Detail

Args

public Args()

Args

public Args(IArgs args)

Args

public Args(java.util.List values)

Args

public Args(java.util.Map values)

Args

public Args(java.lang.Object[] values)

Method Detail

create

public static Args create()

createIndexed

public static Args createIndexed()

createIndexed

public static Args createIndexed(java.lang.Object p1)

createIndexed

public static Args createIndexed(java.lang.Object p1,
                                 java.lang.Object p2)

createIndexed

public static Args createIndexed(java.lang.Object p1,
                                 java.lang.Object p2,
                                 java.lang.Object p3)

createNamed

public static Args createNamed()

createNamed

public static Args createNamed(java.lang.String key,
                               java.lang.Object value)

createNamed

public static Args createNamed(java.lang.String key1,
                               java.lang.Object value1,
                               java.lang.String key2,
                               java.lang.Object value2)

add

public void add(java.lang.Object object)

Specified by:

add in interface IArgs

clear

public void clear()

Specified by:

clear in interface IArgs

declare

public IArgs declare(java.lang.String name,
                     int index,
                     java.lang.Object value)

get

public java.lang.Object get(int index)

Description copied from interface: IArgs

The argument at position index.

Specified by:

get in interface IArgs

Parameters:

index - The index of the argument to return.

Returns:

The argument at position index.

get

public java.lang.Object get(int index,
                            java.lang.Object defaultValue)

Description copied from interface: IArgs

The argument at position index

Specified by:

get in interface IArgs

Parameters:

index - The index of the argument to return.

defaultValue - The default value to be returned if argument is not available.

Returns:

The argument at position index

get

public java.lang.Object get(java.lang.String name)

Description copied from interface: IArgs

The argument named name.

Specified by:

get in interface IArgs

Parameters:

name - The name of the argument to return.

Returns:

The argument named name .

get

public java.lang.Object get(java.lang.String name,
                            java.lang.Object defaultValue)

Description copied from interface: IArgs

The argument named name or the defaultValue if not available.

Specified by:

get in interface IArgs

Parameters:

name - The name of the argument to return.

defaultValue - The default value to be returned if argument is not available.

Returns:

The argument named name

isDefined

public boolean isDefined(int index)

Description copied from interface: IArgs

true if an argument at index is defined.

Specified by:

isDefined in interface IArgs

Returns:

true if an argument at index is defined.

isDefined

public boolean isDefined(java.lang.String name)

Description copied from interface: IArgs

true if an argument named name is defined.

Specified by:

isDefined in interface IArgs

Returns:

true if an argument named name is defined.

isIndexed

public boolean isIndexed()

Description copied from interface: IArgs

true if this argument list is indexed. This means its elements are available via integer indexes.

This does NOT mean the arguments are not available via names - there are implementations that can support both.

Specified by:

isIndexed in interface IArgs

Returns:

true if this argument list is indexed.

isNamed

public boolean isNamed()

Description copied from interface: IArgs

true if this argument list is named. This means its elements are available via names.

This does NOT mean the arguments are not available via indexes - there are implementations that can support both.

Specified by:

isNamed in interface IArgs

Returns:

true if this argument list is named.

names

public java.util.Set names()

Description copied from interface: IArgs

The set of all argument names in the argument list if this argument list is not indexed or null.

Specified by:

names in interface IArgs

Returns:

The set of all argument names in the argument list if this argument list is not indexed or null.

put

public void put(int index,
                java.lang.Object value)

Specified by:

put in interface IArgs

put

public void put(java.lang.String name,
                java.lang.Object value)

Specified by:

put in interface IArgs

size

public int size()

Description copied from interface: IArgs

The total number of arguments.

Specified by:

size in interface IArgs

Returns:

The total number of arguments.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object