Nitido Inc.

com.nitido.nim
Class ModifierContainer

java.lang.Object
  extended by com.nitido.nim.ModifierContainer

public class ModifierContainer
extends java.lang.Object

The ModifierContainer class encapsulates an ordered set of Modifier objects that specify a set of batch modifications to the credential space and user space of an Entity.


Field Summary
protected  java.util.Vector _controlsVec
           
 
Constructor Summary
ModifierContainer()
          Default constructor constructs and empty container.
ModifierContainer(Modifier[] controlsVec)
          Constructs a container that contains the Modifier objects passed in.
 
Method Summary
 void add(int command, java.lang.String key, java.io.Serializable value)
          Uses the given arguments to create a Modifier object and adds it to the end of this container.
 void add(int command, java.lang.String key, java.io.Serializable[] values)
          Uses the given arguments to create a Modifier object and adds it to the end of this container.
 void add(int command, java.lang.String key, java.io.Serializable[] values, int position)
          Uses the given arguments to create a Modifier object and adds it to this container in the speicified position.
 void add(int command, java.lang.String key, java.io.Serializable value, int position)
          Uses the given arguments to create a Modifier object and adds it to this container in the speicified position.
 void addModifier(Modifier control)
          Adds the given Modifier to the end of this container.
 void addModifier(Modifier control, int position)
          Adds the given Modifier to this container in the specified position.
 Modifier getModifier(int position)
          Returns the Modifier object at the specified position.
 java.util.Enumeration getModifiers()
          Returns an Enumeration of the Modifier objects currently stored in this container.
 Modifier remove(int position)
          Removes the Modifier object at the specified position.
 int size()
          Returns the current number of Modifier objects currently stored in the ModifierContainer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_controlsVec

protected java.util.Vector _controlsVec
Constructor Detail

ModifierContainer

public ModifierContainer()
Default constructor constructs and empty container.


ModifierContainer

public ModifierContainer(Modifier[] controlsVec)
Constructs a container that contains the Modifier objects passed in. The order of the array specifies the order the Modifier objects are called.

Parameters:
controlsVec - An array of modify control objects. Each modify control element of the array identifies an operation on a data control.
Method Detail

getModifiers

public java.util.Enumeration getModifiers()
Returns an Enumeration of the Modifier objects currently stored in this container.

Returns:
An Enumeration of the Modifier objects currently in this container.

getModifier

public Modifier getModifier(int position)
Returns the Modifier object at the specified position.

Parameters:
position - The relative position of the Modifier object in the ModifierContainer.
Returns:
The Modifier at the specified position.
Throws:
ArrayIndexOutOfBounds - If the requested position is invalid, or outside the size of this container.

size

public int size()
Returns the current number of Modifier objects currently stored in the ModifierContainer.

Returns:
The size of the container.

addModifier

public void addModifier(Modifier control)
Adds the given Modifier to the end of this container.

Parameters:
control - The Modifier object that is added to the end of the container

add

public void add(int command,
                java.lang.String key,
                java.io.Serializable[] values)
Uses the given arguments to create a Modifier object and adds it to the end of this container.

Parameters:
command - The integer representation of the command to be executed on the data control
key - The key used to reference an object in the DataControl
values - An array of objects associated to the given key
See Also:
Modifier

add

public void add(int command,
                java.lang.String key,
                java.io.Serializable value)
Uses the given arguments to create a Modifier object and adds it to the end of this container.

Parameters:
command - The integer representation of the command to be executed on the data control
key - The key used to reference an object in the DataControl
value - Reference to the object associated to the given key
See Also:
Modifier

addModifier

public void addModifier(Modifier control,
                        int position)
Adds the given Modifier to this container in the specified position.

Parameters:
control - The Modifier object to be added
position - The relative position where the Modifier argument is added in the container.

add

public void add(int command,
                java.lang.String key,
                java.io.Serializable[] values,
                int position)
Uses the given arguments to create a Modifier object and adds it to this container in the speicified position.

Parameters:
command - The integer representation of the command to be executed on the data control
key - The key used to reference an object in the DataControl
values - An array of objects associated to the given key
position - The relative position where the Modifier argument is added in the container.

add

public void add(int command,
                java.lang.String key,
                java.io.Serializable value,
                int position)
Uses the given arguments to create a Modifier object and adds it to this container in the speicified position.

Parameters:
command - The integer representation of the command to be executed on the data control
key - The key used to reference an object in the DataControl
value - Reference to the object associated to the given key
position - The relative position where the Modifier argument is added in the container.
See Also:
Modifier

remove

public Modifier remove(int position)
Removes the Modifier object at the specified position.

Parameters:
position - The relative position indicating the Modifier object to be removed from the container.
Returns:
The Modifier that was removed.
Throws:
ArrayIndexOutOfBounds - If the requested position is invalid, or outside the size of this container.

Nitido NiM 2.5 Java API

These JavaDoc pages are generated for release/nim_2_5-2.5.44

Copyright © 1999-2009 Nitido Inc.    Proprietary and Confidential.    All Rights Reserved.