CommandExecutionContext (NetBeans VCS API) - NetBeans API Javadoc 4.1.0

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.modules.vcscore.commands
Interface CommandExecutionContext

All Known Implementing Classes:: VcsFileSystem

public interface CommandExecutionContext

A provider of execution context, that is necessary for the UserCommand to be executed. If this information object is an instance of VcsFileSystem, more information can be obtained from VcsFileSystem.

Method Summary

void checkForModifications(String path)
          Should be called when the modification in a file or folder is expected and its content should be refreshed.

void debug(String msg)
          Print a debug output.

void debugErr(String msg)
          Print an error output.

VcsCommand getCommand(String name)


VcsCommandsProvider getCommandsProvider()


CommandSupport getCommandSupport(String name)


String[] getEnvironmentVars()


String getPassword()


String getPasswordDescription()


Map getPossibleFileStatusInfoMap()
          Get the map of possible pairs of status name and corresponding FileStatusInfo object.

String[] getUserLocalParamsLabels()


String[] getUserParams()


String[] getUserParamsLabels()


Vector getVariables()
          If this is FileSystem, take it from there! If not, get abolute paths.

Hashtable getVariablesAsHashtable()


VariableValueAdjustment getVarValueAdjustment()


boolean isAcceptUserParams()


boolean isCommandNotification()


boolean isExpertMode()


boolean isOffLine()


boolean isPromptForVarsForEachFile()


void setCommandNotification(boolean commandNotification)


void setPassword(String password)


void setPromptForVarsForEachFile(boolean promptForVarsForEachFile)


void setUserParams(String[] userParams)


void setVariables(Vector variables)

Method Detail

isOffLine

public boolean isOffLine()

isExpertMode

public boolean isExpertMode()

isPromptForVarsForEachFile

public boolean isPromptForVarsForEachFile()

setPromptForVarsForEachFile

public void setPromptForVarsForEachFile(boolean promptForVarsForEachFile)

isCommandNotification

public boolean isCommandNotification()

setCommandNotification

public void setCommandNotification(boolean commandNotification)

getVariables

public Vector getVariables()

If this is FileSystem, take it from there! If not, get abolute paths. If the execution context is a filesystem, it may wish to String convertFileToPath(java.io.File file); String convertFileToPath(FileObject file);

setVariables

public void setVariables(Vector variables)

getVariablesAsHashtable

public Hashtable getVariablesAsHashtable()

getVarValueAdjustment

public VariableValueAdjustment getVarValueAdjustment()

getEnvironmentVars

public String[] getEnvironmentVars()

getPossibleFileStatusInfoMap

public Map getPossibleFileStatusInfoMap()

Get the map of possible pairs of status name and corresponding FileStatusInfo object.

getCommand

public VcsCommand getCommand(String name)

getCommandSupport

public CommandSupport getCommandSupport(String name)

getCommandsProvider

public VcsCommandsProvider getCommandsProvider()

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getPasswordDescription

public String getPasswordDescription()

getUserParamsLabels

public String[] getUserParamsLabels()

getUserLocalParamsLabels

public String[] getUserLocalParamsLabels()

getUserParams

public String[] getUserParams()

setUserParams

public void setUserParams(String[] userParams)

isAcceptUserParams

public boolean isAcceptUserParams()

checkForModifications

public void checkForModifications(String path)

Should be called when the modification in a file or folder is expected and its content should be refreshed.

debug

public void debug(String msg)

Print a debug output. If the debug property is true, the message is printed to the Output Window.

Parameters:: msg - The message to print out.

debugErr

public void debugErr(String msg)

Print an error output. Force the message to print to the Output Window. The debug property is not considered.

Parameters:: msg - the message to print out.