Eclipse Platform
Release 3.2

org.eclipse.ltk.core.refactoring
Class RefactoringSessionDescriptor

java.lang.Object
  extended byorg.eclipse.ltk.core.refactoring.RefactoringSessionDescriptor

public class RefactoringSessionDescriptor
extends Object

Descriptor object of a refactoring session.

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:

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.

Since:
3.2
See Also:
RefactoringDescriptor

Field Summary
static String VERSION_1_0
          The version constant for v1.0 (value: 1.0)
 
Constructor Summary
RefactoringSessionDescriptor(RefactoringDescriptor[] descriptors, String version, String comment)
          Creates a new refactoring session descriptor.
 
Method Summary
 String getComment()
          Returns the comment.
 RefactoringDescriptor[] getRefactorings()
          Returns the refactoring descriptors.
 String getVersion()
          Returns the version tag.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

VERSION_1_0

public static final String VERSION_1_0
The version constant for v1.0 (value: 1.0)

See Also:
Constant Field Values
Constructor Detail

RefactoringSessionDescriptor

public RefactoringSessionDescriptor(RefactoringDescriptor[] descriptors,
                                    String version,
                                    String comment)
Creates a new refactoring session descriptor.

Parameters:
descriptors - the refactoring descriptors in executed order, or the empty array
version - the non-empty version tag, one of the VERSION_xxx constants
comment - the comment of the refactoring session, or null for no comment
Method Detail

getComment

public final String getComment()
Returns the comment.

Returns:
the comment, or the empty string

getRefactorings

public final RefactoringDescriptor[] getRefactorings()
Returns the refactoring descriptors.

Returns:
the array of refactoring descriptors in executed order, or the empty array

getVersion

public final String getVersion()
Returns the version tag.

Returns:
the version tag

Eclipse Platform
Release 3.2

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.