public class RefactoringSessionDescriptor extends Object
Refactoring session descriptors encapsulate a series of refactoring descriptors. They are used to represent chunks of the global workspace refactoring history or refactoring scripts created by the user.
Refactoring session descriptors contain the following information:
RefactoringDescriptor
.
Refactoring session descriptors are potentially heavy weight objects which
should not be held on to. Use refactoring descriptor proxies
RefactoringDescriptorProxy
to present refactoring descriptors in the
user interface or otherwise manipulate refactoring histories. More details
about a particular refactoring session can be revealed in the comment, which
contains more text with refactoring-specific information.
All time stamps are measured as the milliseconds since January 1, 1970, 00:00:00 GMT.
Note: this class is not indented to be subclassed outside the refactoring framework.
RefactoringDescriptor
Modifier and Type | Field and Description |
---|---|
static String |
VERSION_1_0
The version constant for v1.0 (value: 1.0)
|
Constructor and Description |
---|
RefactoringSessionDescriptor(RefactoringDescriptor[] descriptors,
String version,
String comment)
Creates a new refactoring session descriptor.
|
Modifier and Type | Method and Description |
---|---|
String |
getComment()
Returns the comment.
|
RefactoringDescriptor[] |
getRefactorings()
Returns the refactoring descriptors.
|
String |
getVersion()
Returns the version tag.
|
public static final String VERSION_1_0
public RefactoringSessionDescriptor(RefactoringDescriptor[] descriptors, String version, String comment)
descriptors
- the refactoring descriptors in executed order, or the empty
arrayversion
- the non-empty version tag, one of the VERSION_xxx
constantscomment
- the comment of the refactoring session, or null
for no commentpublic final String getComment()
public final RefactoringDescriptor[] getRefactorings()
public final String getVersion()
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.