org.eclipse.ltk.core.refactoring
Class RefactoringSessionDescriptor

java.lang.Object
  org.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 and provide additional information such as version information and comments.

Refactoring session descriptors are potentially heavyweight objects which should not be held on to. Use refactoring descriptor handles RefactoringDescriptorProxy to store refactoring information.

Note: this class is not indented to be subclassed outside the refactoring framework.

Note: This API is considered experimental and may change in the near future.

Since:

3.2

See Also:

RefactoringDescriptor

Field Summary

static String

VERSION_1_0 The version constant for v1.0

Constructor Summary

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

Method Summary

String	getComment() Returns the comment associated with this refactoring session.
RefactoringDescriptor[]	getRefactorings() Returns the refactoring descriptors of the refactorings in this session.
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

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

comment - the comment associated with the refactoring session, or null for no commment

Method Detail

getComment

public final String getComment()

Returns the comment associated with this refactoring session.

Returns:

the associated comment, or the empty string

getRefactorings

public final RefactoringDescriptor[] getRefactorings()

Returns the refactoring descriptors of the refactorings in this session.

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