org.netbeans.modules.java.api.common.project
Class BaseActionProvider

java.lang.Object
  org.netbeans.modules.java.api.common.project.BaseActionProvider

All Implemented Interfaces:

ActionProvider

public abstract class BaseActionProvider
extends Object
implements ActionProvider

Action provider which was originally written for J2SE project and later refactored here so that other EE project types requiring handling of Java related actions can reuse and extend it.

Since:

org.netbeans.modules.java.api.common/1 1.20

Nested Class Summary

static interface	BaseActionProvider.Callback Callback for accessing project private data.
static interface	BaseActionProvider.Callback2 Callback for accessing project private data and supporting ant invocation hooks.
static class	BaseActionProvider.CallbackImpl

Field Summary

static String	AUTOMATIC_BUILD_TAG
static String	BUILD_SCRIPT
static String	PROPERTY_RUN_SINGLE_ON_SERVER
String	unitTestingSupport_fixClasses

Fields inherited from interface org.netbeans.spi.project.ActionProvider

COMMAND_BUILD, COMMAND_CLEAN, COMMAND_COMPILE_SINGLE, COMMAND_COPY, COMMAND_DEBUG, COMMAND_DEBUG_SINGLE, COMMAND_DEBUG_STEP_INTO, COMMAND_DEBUG_TEST_SINGLE, COMMAND_DELETE, COMMAND_MOVE, COMMAND_PROFILE, COMMAND_PROFILE_SINGLE, COMMAND_PROFILE_TEST_SINGLE, COMMAND_REBUILD, COMMAND_RENAME, COMMAND_RUN, COMMAND_RUN_SINGLE, COMMAND_TEST, COMMAND_TEST_SINGLE

Constructor Summary

BaseActionProvider(Project project, UpdateHelper updateHelper, PropertyEvaluator evaluator, SourceRoots sourceRoots, SourceRoots testRoots, AntProjectHelper antProjectHelper, BaseActionProvider.Callback callback)

Method Summary

protected abstract String[]	getActionsDisabledForQuickRun()
protected AntProjectHelper	getAntProjectHelper()
static FileObject	getBuildXml(Project project, PropertyEvaluator evaluator)
static String	getBuildXmlName(Project project, PropertyEvaluator evaluator)
protected BaseActionProvider.Callback	getCallback() Callback for project private data.
abstract Map<String,String[]>	getCommands() Return map from commands to ant targets
protected PropertyEvaluator	getEvaluator()
protected abstract Set<String>	getJavaModelActions() Return set of commands which need java model up to date
protected abstract String[]	getPlatformSensitiveActions()
protected Project	getProject()
protected abstract Set<String>	getScanSensitiveActions() Return set of commands which are affected by background scanning
String[]	getTargetNames(String command, Lookup context, Properties p) Compatibility
String[]	getTargetNames(String command, Lookup context, Properties p, boolean doJavaChecks)
protected UpdateHelper	getUpdateHelper()
protected boolean	handleJavaClass(Properties p, FileObject javaFile, String command, List<String> targetNames)
void	invokeAction(String command, Lookup context)
boolean	isActionEnabled(String command, Lookup context)
protected abstract boolean	isCompileOnSaveEnabled()
protected boolean	isServerExecution()
protected void	setServerExecution(boolean serverExecution)
void	startFSListener()
protected void	updateJavaRunnerClasspath(String command, Map<String,Object> execProperties)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.netbeans.spi.project.ActionProvider

getSupportedActions

Field Detail

AUTOMATIC_BUILD_TAG

public static final String AUTOMATIC_BUILD_TAG

See Also:

Constant Field Values

PROPERTY_RUN_SINGLE_ON_SERVER

public static final String PROPERTY_RUN_SINGLE_ON_SERVER

See Also:

Constant Field Values

unitTestingSupport_fixClasses

public String unitTestingSupport_fixClasses

BUILD_SCRIPT

public static final String BUILD_SCRIPT

See Also:

Constant Field Values

Constructor Detail

BaseActionProvider

public BaseActionProvider(Project project,
                          UpdateHelper updateHelper,
                          PropertyEvaluator evaluator,
                          SourceRoots sourceRoots,
                          SourceRoots testRoots,
                          AntProjectHelper antProjectHelper,
                          BaseActionProvider.Callback callback)

Method Detail

getPlatformSensitiveActions

protected abstract String[] getPlatformSensitiveActions()

getActionsDisabledForQuickRun

protected abstract String[] getActionsDisabledForQuickRun()

getCommands

public abstract Map<String,String[]> getCommands()

Return map from commands to ant targets

getScanSensitiveActions

protected abstract Set<String> getScanSensitiveActions()

Return set of commands which are affected by background scanning

getJavaModelActions

protected abstract Set<String> getJavaModelActions()

Return set of commands which need java model up to date

isCompileOnSaveEnabled

protected abstract boolean isCompileOnSaveEnabled()

setServerExecution

protected void setServerExecution(boolean serverExecution)

isServerExecution

protected boolean isServerExecution()

getEvaluator

protected PropertyEvaluator getEvaluator()

getUpdateHelper

protected UpdateHelper getUpdateHelper()

getAntProjectHelper

protected AntProjectHelper getAntProjectHelper()

getCallback

protected BaseActionProvider.Callback getCallback()

Callback for project private data.

Returns:

See Also:

BaseActionProvider.Callback, BaseActionProvider.Callback2

startFSListener

public void startFSListener()

getBuildXmlName

public static String getBuildXmlName(Project project,
                                     PropertyEvaluator evaluator)

getBuildXml

public static FileObject getBuildXml(Project project,
                                     PropertyEvaluator evaluator)

getProject

protected final Project getProject()

invokeAction

public void invokeAction(String command,
                         Lookup context)
                  throws IllegalArgumentException

Specified by:

invokeAction in interface ActionProvider

Throws:

IllegalArgumentException

updateJavaRunnerClasspath

protected void updateJavaRunnerClasspath(String command,
                                         Map<String,Object> execProperties)

getTargetNames

public String[] getTargetNames(String command,
                               Lookup context,
                               Properties p)
                        throws IllegalArgumentException

Compatibility

Throws:

IllegalArgumentException

getTargetNames

@CheckForNull
public String[] getTargetNames(String command,
                                            Lookup context,
                                            Properties p,
                                            boolean doJavaChecks)
                        throws IllegalArgumentException

Returns:

array of targets or null to stop execution; can return empty array

Throws:

IllegalArgumentException

handleJavaClass

protected boolean handleJavaClass(Properties p,
                                  FileObject javaFile,
                                  String command,
                                  List<String> targetNames)

Parameters:

targetNames - caller of this method must set this parameter to empty modifiable array; implementor of this method can return alternative target names to be used to handle this Java class

isActionEnabled

public boolean isActionEnabled(String command,
                               Lookup context)

Specified by:

isActionEnabled in interface ActionProvider