WhereUsedQuery (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 WhereUsedQuery

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

public final class WhereUsedQuery
extends AbstractRefactoring
extends AbstractRefactoring

Where used query does not do any "real" refactoring. It just encapsulates parameters for Find Usages, which is implemented by plugins. Refactoring itself is implemented in plugins

See Also:: RefactoringPlugin, RefactoringPluginFactory, AbstractRefactoring, RefactoringSession

Field Summary

static String FIND_REFERENCES
          key for getBooleanValue() is find references requested?

static String SEARCH_IN_COMMENTS
          key for getBooleanValue() is search in comments requested?

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

INIT, PARAMETERS_CHECK, PRE_CHECK, PREPARE

Constructor Summary

WhereUsedQuery(Lookup lookup)
          Creates a new instance of WhereUsedQuery.

Method Summary

boolean getBooleanValue(Object key)
          getter for various properties

void putValue(Object key, Object value)
          setter for various properties

void setRefactoringSource(Lookup lookup)
          Setter for searched item

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

Field Summary
`static String`	`FIND_REFERENCES` key for `getBooleanValue()` is find references requested?
`static String`	`SEARCH_IN_COMMENTS` key for `getBooleanValue()` is search in comments requested?

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

Constructor Summary
`WhereUsedQuery(Lookup lookup)` Creates a new instance of WhereUsedQuery.

Method Summary
`boolean`	`getBooleanValue(Object key)` getter for various properties
`void`	`putValue(Object key, Object value)` setter for various properties
`void`	`setRefactoringSource(Lookup lookup)` Setter for searched item

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`

Field Detail

SEARCH_IN_COMMENTS

public static final String SEARCH_IN_COMMENTS

key for getBooleanValue() is search in comments requested?

See Also:: Constant Field Values

FIND_REFERENCES

public static final String FIND_REFERENCES

key for getBooleanValue() is find references requested?

See Also:: Constant Field Values

Constructor Detail

WhereUsedQuery

public WhereUsedQuery(Lookup lookup)

Creates a new instance of WhereUsedQuery. WhereUsedQuery implementations currently understand following types:

Module	Types the Module Understands	Implementation
Java Refactoring	`FileObject` with content type text/x-java (class references) `TreePathHandle` (class, field, method references)	Finds references

Parameters:: lookup - put object for which you request references into Lookup instance.

Method Detail

setRefactoringSource

public final void setRefactoringSource(Lookup lookup)

Setter for searched item

Parameters:: lookup - put object for which you request references into Lookup instance.

getBooleanValue

public final boolean getBooleanValue(Object key)

getter for various properties

Parameters:: key -
Returns:: value for given key
See Also:: SEARCH_IN_COMMENTS, FIND_REFERENCES

putValue

public final void putValue(Object key,
                           Object value)

setter for various properties

Parameters:: key -; value - set value for given key
See Also:: SEARCH_IN_COMMENTS, FIND_REFERENCES