Extension SDK 9.0.5

oracle.jdeveloper.jot
Interface JotManipulations

All Superinterfaces:
JotClassDatabase, Subject
All Known Subinterfaces:
JotModel, JotWorkArea
All Known Implementing Classes:
JotManager

public interface JotManipulations
extends JotClassDatabase

JotManipulations provides interfaces for expedient searching,


Field Summary
 
Fields inherited from interface oracle.ide.addin.Subject
OBJECT_MODIFIED
 
Method Summary
 void copy(JotElement element, JotElement[] parents, JotElement[] siblings, boolean[] befores, java.lang.String[] newNames)
          Copies the specified JotElement to all the specified parents.
 JotElement[] findAllFieldReferences(JotType type, JotField field, java.lang.String[] packageScope)
          Finds all the references to the specified class and member in the search scope.
 JotFile[] findAllFileReferences(JotType type, java.lang.String memberText, java.lang.String[] packageScope)
          Finds all the files containing references to the specified class and member in the search scope.
 JotElement[] findAllMethodReferences(JotType type, JotMethod method, java.lang.String[] packageScope)
          Finds all the references to the specified class and member in the search scope.
 JotElement[] findAllReferences(JotType type, java.lang.String memberText, java.lang.String[] packageScope)
          Finds all the references to the specified class and member in the search scope.
 void move(JotElement element, JotElement parent, JotElement sibling, boolean before, java.lang.String newName)
          Moves the specified element to a new parent.
 
Methods inherited from interface oracle.jdeveloper.jot.JotClassDatabase
getAllClassDescriptors, getAllClassDescriptors, getClass, getClassList, getClassNameList, getJotTypeInfo, getPackage, getPackageList, getPackages, getType
 
Methods inherited from interface oracle.ide.addin.Subject
attach, detach, notifyObservers
 

Method Detail

findAllReferences

public JotElement[] findAllReferences(JotType type,
                                      java.lang.String memberText,
                                      java.lang.String[] packageScope)
                               throws JotException
Finds all the references to the specified class and member in the search scope.

Parameters:
type - the JotType of the class to find.
memberText - a text description of the member referenced to find. If null, this method will return all references to the class.
packageScope - an array of package fragments to search. If null, or empty, this search will use the JotClassDatabase as its scope.
Returns:
an array of all JotElement instances which match the search criteria.
Throws:
JotException

findAllFileReferences

public JotFile[] findAllFileReferences(JotType type,
                                       java.lang.String memberText,
                                       java.lang.String[] packageScope)
                                throws JotException
Finds all the files containing references to the specified class and member in the search scope.

Parameters:
type - the JotType of the class to find.
memberText - a text description of the member referenced to find. If null, this method will return all references to the class.
packageScope - an array of package fragments to search. If null, or empty, this search will use the JotClassDatabase as its scope.
Returns:
an array of all JotFile instances which contain references matching the search criteria
Throws:
JotException

findAllMethodReferences

public JotElement[] findAllMethodReferences(JotType type,
                                            JotMethod method,
                                            java.lang.String[] packageScope)
                                     throws JotException
Finds all the references to the specified class and member in the search scope.

Parameters:
type - the JotType of the class to find.
method - the JotMethod to locate.
packageScope - an array of package fragments to search. If null, or empty, this search will use the JotClassDatabase as its scope.
Returns:
an array of all JotElement instances which match the search criteria.
Throws:
JotException

findAllFieldReferences

public JotElement[] findAllFieldReferences(JotType type,
                                           JotField field,
                                           java.lang.String[] packageScope)
                                    throws JotException
Finds all the references to the specified class and member in the search scope.

Parameters:
type - the JotType of the class to find.
field - the JotField to locate.
packageScope - an array of package fragments to search. If null, or empty, this search will use the JotClassDatabase as its scope.
Returns:
an array of all JotElement instances which match the search criteria.
Throws:
JotException

copy

public void copy(JotElement element,
                 JotElement[] parents,
                 JotElement[] siblings,
                 boolean[] befores,
                 java.lang.String[] newNames)
          throws JotException
Copies the specified JotElement to all the specified parents. The copied element is placed in relation to the sibling specified, before or after it, depending on the corresponding before flag in the array.

Parameters:
element - the element to copy.
parents - the new parents of the copies.
siblings - the sibling in each parent to place the newly copied element adjacent to. If null is specified, it is placed at the start, or end, depending on the before flag
befores - whether each copy is placed before or after it's sibling.
newNames - potential new names for each newly created copy.
Throws:
JotException

move

public void move(JotElement element,
                 JotElement parent,
                 JotElement sibling,
                 boolean before,
                 java.lang.String newName)
          throws JotException
Moves the specified element to a new parent.

Parameters:
element - the element to move.
parent - the new parent.
before - whether the element goes before or after its sibling.
newName - a potential new name for the element moved.
Throws:
JotException

Extension SDK

 

Copyright © 1997, 2004, Oracle. All rights reserved.