public interface Scope
Modifier and Type | Interface and Description |
---|---|
static class |
Scope.MethodData
Scope method data.
|
static class |
Scope.UpdateException
Exception for update errors.
|
Modifier and Type | Method and Description |
---|---|
String |
getID()
Gets a string describing the scope.
|
List<String> |
getTextDescription()
Gets a human-readable description of the scope.
|
List<String> |
getTextDescriptionLabels()
Gets labels for the human-readable description of the scope.
|
void |
getTypesAndMethods(Set<String> types,
Set<Scope.MethodData> methods)
Gets the types and methods used in the scope.
|
boolean |
includes(Scope scope,
ScopeTest test)
Determines if this scope includes another.
|
boolean |
isUtility() |
void |
toXML(Document doc,
Element e)
Populates an XML dom element for this scope.
|
Scope |
update(Map<String,String> oldClassToNew,
Map<Scope.MethodData,String> oldMethodToNewDescription)
Creates a version of this scope reflecting class and method changes.
|
String getID()
List<String> getTextDescription()
List<String> getTextDescriptionLabels()
void getTypesAndMethods(Set<String> types, Set<Scope.MethodData> methods)
types
- set to which any types used in this scope will be added.methods
- set to which and methods used in this scope will be
added.boolean includes(Scope scope, ScopeTest test)
scope
- the scope to be compared.test
- the test type to use in the comparison.scope
applies, this
scope also applies, false otherwise.void toXML(Document doc, Element e)
doc
- the document to which the element belongs.e
- the element to be populated.Scope update(Map<String,String> oldClassToNew, Map<Scope.MethodData,String> oldMethodToNewDescription) throws Scope.UpdateException
oldClassToNew
- map from old class names to new class names.oldMethodToNewDescription
- map from old method data to new
descriptions to be used in the data.Scope.UpdateException
- if any of the new class names or method
descriptions are invalid.boolean isUtility()