Package com._1c.g5.v8.dt.refactoring.core

Class RefactoringOperationDescriptor

java.lang.Object

com._1c.g5.v8.dt.refactoring.core.RefactoringOperationDescriptor

public final class RefactoringOperationDescriptor
extends Object

A descriptor of the refactoring operation.

Descriptors are provided by refactoring contributors to participate in the refactoring process. It keeps the refactoring operation that will be performed during refactoring. Optionally it keeps the localized name of the operation and the 'optional' flag.

If the name is provided the operation is reflected in the logical structure of refactoring.

See Also:

IRefactoringOperation, IRefactoringItem, IRenameRefactoringContributor, IDeleteRefactoringContributor

Constructor Summary

Constructors

Constructor	Description
RefactoringOperationDescriptor(IRefactoringOperation operation)	Creates a descriptor with the specified operation.
RefactoringOperationDescriptor(IRefactoringOperation operation, String name, boolean optional)	Creates a descriptor with the specified operation, name and optional flag.

Method Summary

Modifier and Type	Method	Description
String	getName()	Returns the localized name of the refactoring operation.
IRefactoringOperation	getOperation()	Returns the refactoring operation.
boolean	isOptional()	Returns the flag indicating whether the refactoring operation is optional or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RefactoringOperationDescriptor

public RefactoringOperationDescriptor(IRefactoringOperation operation,
                                      String name,
                                      boolean optional)

Creates a descriptor with the specified operation, name and optional flag.

Parameters:

operation - the refactoring operation, cannot be null.

name - the localized name, can be null.

optional - the optional flag.

RefactoringOperationDescriptor

public RefactoringOperationDescriptor(IRefactoringOperation operation)

Creates a descriptor with the specified operation.

Parameters:

operation - the refactoring operation, cannot be null.

Method Detail

getOperation

public IRefactoringOperation getOperation()

Returns the refactoring operation.

Returns:

the refactoring operation, never null.

getName

public String getName()

Returns the localized name of the refactoring operation.

Returns:

the localized name of the refactoring operation or null.

isOptional

public boolean isOptional()

Returns the flag indicating whether the refactoring operation is optional or not.

Returns:

true if the refactoring operation is optional, false - otherwise.