Enhydra 5.1 API

org.enhydra.tool.common
Class ReplacementSet

java.lang.Object
  |
  +--org.enhydra.tool.common.ReplacementSet
Direct Known Subclasses:
ProjectReplacementSet

public class ReplacementSet
extends java.lang.Object

ReplacementSet is a utility class for working with Replacement objects.


Constructor Summary
ReplacementSet()
          Create an empty replacement set.
ReplacementSet(Replacement[] reps)
           
 
Method Summary
 void add(Replacement newRep)
          Add a new generator replacement.
 void delete(java.lang.String find)
          Remove the generator replacement that has the specified replacement name.
 Replacement lookup(java.lang.String find)
          Get the generator replacement that has the specified replacement name.
 Replacement[] toArray()
          Convert the option set into an array of individual GeneratorOption objects.
 java.lang.String[][] toStringArray()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReplacementSet

public ReplacementSet()
Create an empty replacement set.


ReplacementSet

public ReplacementSet(Replacement[] reps)
Method Detail

lookup

public Replacement lookup(java.lang.String find)
                   throws ToolException
Get the generator replacement that has the specified replacement name.

Throws:
ToolException - Thrown if the no Replacement exists in the current set with the specified name.

delete

public void delete(java.lang.String find)
            throws ToolException
Remove the generator replacement that has the specified replacement name.

Throws:
GeneratorException - Thrown if the no Replacement exists in the current set with the specified find key.
ToolException

add

public void add(Replacement newRep)
         throws ToolException
Add a new generator replacement.

Throws:
GeneratorException - Thrown if the no Generatorreplacement exists in the current set with the specified name.
ToolException

toArray

public Replacement[] toArray()
Convert the option set into an array of individual GeneratorOption objects.

Returns:
The options as an GeneratorOption array.

toStringArray

public java.lang.String[][] toStringArray()

Enhydra 5.1 API