JDeveloper SCM API

oracle.ide.scm
Class SCMOperationSet

java.lang.Object
  |
  +--oracle.ide.scm.SCMOperationSet

public final class SCMOperationSet
extends java.lang.Object

Class representing a client's operation set, and preserving a separation between operations of different category types. This is used in the framework by controls which may visibly divide the operations into their given categories, for example with menu separators.


Constructor Summary
SCMOperationSet()
          Constructs an operation set with no initial categories.
 
Method Summary
 void addCategory(java.lang.Class[] operations)
          Adds a category of operations, given by an array of Class references, to this operation set.
 void addCategory(SCMOperation[] operations)
          Adds a category of operations, given by an array of SCMOperation instances, to this operation set.
 void addSubCategory(java.lang.String name, char mnemonic, java.lang.Class[] operations)
          Adds a sub-category of operations, given by an array of Class references, to this operation set.
 void addSubCategory(java.lang.String name, char mnemonic, SCMOperation[] operations)
          Adds a sub-category of operations, given by an array of SCMOperation instances, to this operation set.
 SCMOperationSet derive(java.util.List required)
          Derives a subset of held operations from the required list of members.
 java.util.Iterator flatten()
          Gets a flat Iterator over all operations contained by the set, disregarding category separation.
 java.util.Iterator iterator()
          Framework-level method.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SCMOperationSet

public SCMOperationSet()
Constructs an operation set with no initial categories.
Method Detail

addCategory

public void addCategory(SCMOperation[] operations)
Adds a category of operations, given by an array of SCMOperation instances, to this operation set.
Parameters:
operations - the category of operation instances to add.

addCategory

public void addCategory(java.lang.Class[] operations)
                 throws SCMException
Adds a category of operations, given by an array of Class references, to this operation set.
Parameters:
operations - the category of operation classes to add.

addSubCategory

public void addSubCategory(java.lang.String name,
                           char mnemonic,
                           SCMOperation[] operations)
Adds a sub-category of operations, given by an array of SCMOperation instances, to this operation set.
Parameters:
operations - the category of operation instances to add.

addSubCategory

public void addSubCategory(java.lang.String name,
                           char mnemonic,
                           java.lang.Class[] operations)
                    throws SCMException
Adds a sub-category of operations, given by an array of Class references, to this operation set.
Parameters:
operations - the category of operation classes to add.

derive

public final SCMOperationSet derive(java.util.List required)
Derives a subset of held operations from the required list of members. These are categorized in the same way, preserving the separation of the original set.
Parameters:
required - a list of member operations required in the derived set.
Returns:
the derived operation subset instance.

iterator

public final java.util.Iterator iterator()
Framework-level method. Gets an Iterator over the set lists, each representing a single operation category. Entries are of class type OperationSetCategory.
Returns:
the operation set iterator.

flatten

public final java.util.Iterator flatten()
Gets a flat Iterator over all operations contained by the set, disregarding category separation.
Returns:
the operation iterator.

Copyright © 2002 Oracle Corporation