SingleCopyRefactoring (Refactoring API) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.refactoring.api 1.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.modules.refactoring.api
Class SingleCopyRefactoring

java.lang.Object
  org.netbeans.modules.refactoring.api.AbstractRefactoring
      org.netbeans.modules.refactoring.api.SingleCopyRefactoring

public final class SingleCopyRefactoring
extends AbstractRefactoring
extends AbstractRefactoring

This class is just holder for parameters of Single Copy Refactoring. Refactoring itself is implemented in plugins

See Also:: RefactoringPlugin, RefactoringPluginFactory, AbstractRefactoring, RefactoringSession

Field Summary

Fields inherited from class org.netbeans.modules.refactoring.api.AbstractRefactoring

INIT, PARAMETERS_CHECK, PRE_CHECK, PREPARE

Constructor Summary

SingleCopyRefactoring(Lookup objectToCopy)
          Creates a new instance of SingleCopyRefactoring.

Method Summary

String getNewName()
          getter for new name of copied file

Lookup getTarget()
          Target for copying

void setNewName(String newName)
          setter for new name of copied file

void setTarget(Lookup target)
          Target for copying.

Methods inherited from class org.netbeans.modules.refactoring.api.AbstractRefactoring

addProgressListener, cancelRequest, checkParameters, fastCheckParameters, getContext, getRefactoringSource, preCheck, prepare, removeProgressListener

Methods inherited from class java.lang.Object

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

Fields inherited from class org.netbeans.modules.refactoring.api.AbstractRefactoring
`INIT, PARAMETERS_CHECK, PRE_CHECK, PREPARE`

Constructor Summary
`SingleCopyRefactoring(Lookup objectToCopy)` Creates a new instance of SingleCopyRefactoring.

Method Summary
`String`	`getNewName()` getter for new name of copied file
`Lookup`	`getTarget()` Target for copying
`void`	`setNewName(String newName)` setter for new name of copied file
`void`	`setTarget(Lookup target)` Target for copying.

Methods inherited from class org.netbeans.modules.refactoring.api.AbstractRefactoring
`addProgressListener, cancelRequest, checkParameters, fastCheckParameters, getContext, getRefactoringSource, preCheck, prepare, removeProgressListener`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

SingleCopyRefactoring

public SingleCopyRefactoring(Lookup objectToCopy)

Creates a new instance of SingleCopyRefactoring. Single Copy Refactoring implementations currently understand following types:

Module	Types the Module Understands	Implementation
Refactoring API (Default impl.)	FileObject	Does file copy
Java Refactoring	`FileObject`(s) with content type text/x-java (class copy)	Updates name, package declaration and import statements

Parameters:: objectToCopy - Object to be copied stored into Lookup

Method Detail

setTarget

public void setTarget(Lookup target)

Target for copying. Single Copy Refactoring implementations currently understand following types:

Module	Types the Module Understands	Implementation
Refactoring API (Default impl.)	`URL`	Creates directory corresponding to specified URL (if does not exist) and copies all FileObjects into this folder.
Java Refactoring	`URL`	Updates name, package declaration and import statements

Parameters:: target -

getTarget

public Lookup getTarget()

Target for copying

Returns:: target
See Also:: setTarget(org.openide.util.Lookup)

getNewName

public String getNewName()

getter for new name of copied file

Returns:: value String value

setNewName

public void setNewName(String newName)

setter for new name of copied file

Parameters:: newName - new value