oracle.as.scheduler

Class ParameterList

java.lang.Object

oracle.as.scheduler.ParameterList

All Implemented Interfaces:

Serializable

public class ParameterList
extends Object
implements Serializable

Stores list of parameters. Instance of this class is used to declare all the parameters of a given JobDefinition, JobType or JobSet definition. This can include both application level parameters and system properties for a given definition (metadata object).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ParameterList() Constructs an instance of ParameterList.
ParameterList(ParameterList source) Constructs an instance with the same list mappings as the specified object.

Method Summary

Modifier and Type	Method and Description
void	add(ParameterInfo param) Adds a parameter to the list.
void	add(String name, Boolean value, boolean readOnly) Adds a parameter of type Boolean to this list with the given name and value.
void	add(String name, Integer value, boolean readOnly) Adds a parameter of type Integer to this list with the given name and value.
void	add(String name, Long value, boolean readOnly) Adds a parameter of type Long to this list with the given name and value.
void	add(String name, ParameterInfo.DataType type) Adds a parameter to this list with the given name and data type.
void	add(String name, ParameterInfo.DataType type, Object value, boolean readOnly) Adds a parameter to the list with the given information about the parameter.
void	add(String name, ParameterInfo.DataType type, Object value, boolean readOnly, boolean legacy) Adds a parameter to the list with the given information about the parameter.
void	add(String name, String value, boolean readOnly) Adds a parameter of type String to this list with the given name and value.
void	clear() Removes all parameter information from this list.
int	compareSpecial(Object obj) Compares the specific object with this object for equality, including parameters.
boolean	contains(String name) Indicates if this list contains a parameter for the given name.
boolean	equals(Object obj) Compares the specific object with this object for equality.
ParameterInfo	get(String name) Returns the information about the given parameter from this list.
Collection	getAll() Returns a collection view of all the parameters from this list.
Enumeration	getNames() Returns all the names of the parameters in this list.
Object	getValue(String name) Gets the value for a parameter in the list.
int	hashCode() Returns the hash code value of this list.
void	remove(String name) Removes the given parameter from the list.
int	size() Returns the number of parameters in this list.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParameterList

public ParameterList()

Constructs an instance of ParameterList.

ParameterList

public ParameterList(ParameterList source)

Constructs an instance with the same list mappings as the specified object.

Parameters:

source - the list whose parameters are to be placed in this object

Throws:

NullPointerException - if the specified list is null.

Method Detail

add

public void add(String name,
                String value,
                boolean readOnly)

Adds a parameter of type String to this list with the given name and value.

Parameters:

name - the name of the parameter to be added.

value - value of the parameter.

readOnly - indicates whether the parameter is read-only or not. If read only, subsequent objects cannot change the value.

add

public void add(String name,
                Integer value,
                boolean readOnly)

Adds a parameter of type Integer to this list with the given name and value.

Parameters:

name - the name of the parameter to be added.

value - value of the parameter.

readOnly - indicates whether the parameter is read-only or not. If read only, subsequent objects cannot change the value.

add

public void add(String name,
                Long value,
                boolean readOnly)

Adds a parameter of type Long to this list with the given name and value.

Parameters:

name - the name of the parameter to be added.

value - value of the parameter.

readOnly - indicates whether the parameter is read-only or not. If read only, subsequent objects cannot change the value.

add

public void add(String name,
                Boolean value,
                boolean readOnly)

Adds a parameter of type Boolean to this list with the given name and value.

Parameters:

name - the name of the parameter to be added.

value - value of the parameter.

readOnly - indicates whether the parameter is read-only or not. If read only, subsequent objects cannot change the value.

add

public void add(String name,
                ParameterInfo.DataType type)

Adds a parameter to this list with the given name and data type. A parameter added via this method has no value and is not flagged as read-only.

Parameters:

name - the name of the parameter to be added.

type - the data type of the parameter. The data type is one of the supported data types.

add

public void add(String name,
                ParameterInfo.DataType type,
                Object value,
                boolean readOnly)

Adds a parameter to the list with the given information about the parameter.

Parameters:

name - the name of the parameter to be added.

type - the data type of the parameter

value - an optional (default) value of the parameter. The data type of the value must match with the type argument.

readOnly - indicates whether the parameter is read-only or not. If read only, subsequent objects cannot change the value.

add

public void add(String name,
                ParameterInfo.DataType type,
                Object value,
                boolean readOnly,
                boolean legacy)

Adds a parameter to the list with the given information about the parameter.

Parameters:

name - the name of the parameter to be added.

type - the data type of the parameter

value - an optional (default) value of the parameter. The data type of the value must match with the type argument.

readOnly - indicates whether the parameter is read-only or not. If read only, subsequent objects cannot change the value.

legacy - indicates whether the parameter is legacy

add

public void add(ParameterInfo param)

Adds a parameter to the list.

This simply adds the specified ParameterInfo to the list, it does not create a new ParameterInfo object.

Parameters:

param - the parameter info instance to be added to the list.

Throws:

NullPointerException - if the parameter info is null.

getNames

public Enumeration getNames()

Returns all the names of the parameters in this list. The method is useful for iterating over all the parameters.

Returns:

parameter names as Enumeration.

contains

public boolean contains(String name)

Indicates if this list contains a parameter for the given name.

Parameters:

name - the name of the parameter

Returns:

true if the parameter exists in the list, or false if not.

get

public ParameterInfo get(String name)

Returns the information about the given parameter from this list.

Parameters:

name - the name of the parameter whose information is returned.

Returns:

an instance of ParameterInfo for the parameter. This will be null if this list does not contain a parameter with the given name.

getAll

public Collection getAll()

Returns a collection view of all the parameters from this list.

Returns:

a collection containing instances of ParameterInfo

getValue

public Object getValue(String name)

Gets the value for a parameter in the list.

Parameters:

name - the name of the parameter

Returns:

the parameter value. This will be null if the list does not a parameter with the given name.

remove

public void remove(String name)

Removes the given parameter from the list.

Parameters:

name - the name of the parameter to be removed.

clear

public void clear()

Removes all parameter information from this list.

size

public int size()

Returns the number of parameters in this list.

hashCode

public int hashCode()

Returns the hash code value of this list.

Overrides:

hashCode in class Object

Returns:

the hash code of this instance.

equals

public boolean equals(Object obj)

Compares the specific object with this object for equality.

Overrides:

equals in class Object

Parameters:

obj - the object to be compared.

Returns:

true of the given object is equal to this object, or false otherwise.

compareSpecial

public int compareSpecial(Object obj)

Compares the specific object with this object for equality, including parameters. The result differentiates differences in customizable parameters versus other differences.

Parameters:

obj - the object to be compared.

Returns:

0 if the objects are equal; -1 if the only differences are for customizable params, including additions, and removals; 1 if there are any other differences.