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

All Superinterfaces:: Node.Cookie, VcsCommandCookie

All Known Implementing Classes:: UserCommand

public interface VcsCommand
extends VcsCommandCookie

The VcsCommand interface should be implemented by any class whose instances are intended to be executed by a VcsCommandExecutor.

Field Summary

static int EXEC_CONCURRENT_ALL
          All execution of this command can be done concurrently with others.

static int EXEC_SERIAL_ALL
          Serial execution of all commands.

static int EXEC_SERIAL_INERT
          This command is inert with all other commands.

static int EXEC_SERIAL_OF_COMMAND
          Serial execution of commands of this name.

static int EXEC_SERIAL_ON_FILE
          Serial execution is guaranteed on each file.

static int EXEC_SERIAL_ON_PACKAGE
          Serial execution is guaranteed inside a single package.

static int EXEC_SERIAL_WITH_PARENT
          Serial execution of commands with respect to commands running on a parent folders.

static int EXEC_SERIAL_WITH_PENDING
          Serial execution even with respect to the pending commands, that are waiting for the actual execution.

static String NAME_DELETE_DIR
          The name of the command which will be called after a directory was deleted.

static String NAME_DELETE_FILE
          The name of the command which will be called after a file was deleted.

static String NAME_EDIT
          The name of the command which will be called to prepare the file for editing in VCS.

static String NAME_LOCK
          The name of the command which will be called to lock the file in VCS.

static String NAME_REFRESH
          The name of the command which does non recursive refresh of a folder.

static String NAME_REFRESH_RECURSIVELY
          The name of the command which does recursive refresh of a folder.

static String NAME_REVISION_LIST
          The name of the command which is used to get a list of revisions.

static String NAME_REVISION_OPEN
          The name of the command which is used to get a specific revision to open.

static String NAME_SCHEDULE_ADD
          The name of the command which will schedule a file for later add to the repository.

static String NAME_SCHEDULE_REMOVE
          The name of the command which will schedule a file for later remove from the repository.

static String NAME_SUFFIX_OFFLINE
          The suffix, that is used to distinguish offline commands.

static String NAME_UNLOCK
          The name of the command which will be called to unlock the file in VCS.

static String PROP_NAME_FOR_INTERNAL_USE_ONLY
          Properties wich contains this string in their names can be added to the command by the vcscore or any other module.

static String PROPERTY_ADVANCED_NAME
          Command may set this property which will be visible on the VariableInputDialog.

static String PROPERTY_ASSOCIATED_COMMAND_INTERFACE_NAME
          The String property, that contain the name of an interface, that represents this command.

static String PROPERTY_CHANGED_REVISION_VAR_NAME
          The name of the variable that specifies the changed revision.

static String PROPERTY_CHANGING_NUM_REVISIONS
          Whether the command changes the number of revisions.

static String PROPERTY_CHANGING_REVISION
          Whether the command changes one specific revision.

static String PROPERTY_CHECK_FOR_MODIFICATIONS
          When true, automatically check the file modification and reload the editor content if necessary without asking the user.

static String PROPERTY_CLEAN_UNIMPORTANT_FILES_ON_SUCCESS
          When this property is true, all unimportant files, that are associated with processed files are deleted after the command finish successfully.

static String PROPERTY_COMMANDS_AFTER_FAIL
          List of comma separated quoted commands, that will be executed after this command fails.

static String PROPERTY_COMMANDS_AFTER_SUCCESS
          List of comma separated quoted commands, that will be executed after this command succeeds.

static String PROPERTY_CONCURRENT_EXECUTION
          This Integer property can contain values of EXEC_* constants.

static String PROPERTY_CONCURRENT_EXECUTION_WITH
          This property has similar meaning as PROPERTY_CONCURRENT_EXECUTION, but contains pairs of command name and integer property enclosed in quotes and delimited by commas.

static String PROPERTY_CONFIRMATION_MSG
          If non empty, the user will be asked to confirm this message prior to command execution.

static String PROPERTY_DISABLED_ON_STATUS
          A string property, that can contain a list of file status attributes.

static String PROPERTY_DISABLED_WHEN_NOT_LOCKED
          A boolean property, that when true, the command menu item will be disabled on files that are not locked by the user defined in VcsFileSystem.VAR_LOCKER_USER_NAME variable, or locked by the current user if the variable does not exist.

static String PROPERTY_DISPLAY_INTERACTIVE_OUTPUT
          A boolean property, if true a window which shows the output of the command with a possibility to enter an input will pop-up.

static String PROPERTY_DISPLAY_PLAIN_OUTPUT
          A boolean property, if true a window which shows the output of the command will pop-up.

static String PROPERTY_DISPLAY_VISUALIZER
          A String property that contains the name of the class which represents the GUI visualizer of this command.

static String PROPERTY_DISTINGUISH_BINARY_FILES
          This is a boolean property, which should be set to true on commands, that behaves differently on textual and binary files.

static String PROPERTY_EXEC
          This property denotes the executable string.

static String PROPERTY_EXEC_PRIORITY
          An Integer property, that defines the execution priority of this command.

static String PROPERTY_EXEC_SCHEDULED_COMMAND
          This property contains the name of command, that is executed on scheduled files.

static String PROPERTY_EXEC_STRUCTURED
          This property denotes the structured execution property.

static String PROPERTY_GENERAL_COMMAND_ACTION_CLASS_NAME
          This String property contains the name of class of an action, that will run this command.

static String PROPERTY_GENERAL_COMMAND_ACTION_DISPLAY_NAME
          This String property contains the display name of an action, that will run this command.

static String PROPERTY_HIDDEN
          Whether the command will appear on the actions popup menu.

static String PROPERTY_HIDDEN_TEST_EXPRESSION
          An expression, which if expands to an empty string, the command will appear on the actions popup menu.

static String PROPERTY_IGNORE_FAIL
          When true, the command is supposed to return fail status even when it finish normally.

static String PROPERTY_INPUT_DESCRIPTOR
          Describe the components, that will appear in the variable input dialog prior the command is executed.

static String PROPERTY_LABEL_MNEMONIC
          If the command label is not null, this property is used as a mnemonic for the command lanel.

static String PROPERTY_LOAD_ATTRS_TO_VARS
          This property can contain the array of attribute names and variable names.

static String PROPERTY_MERGE_ERROR_TO_STANDARD_OUTPUT
          A Boolean property indicating whether the error stream should be merged with the standard stream of the command.

static String PROPERTY_NEEDS_HIERARCHICAL_ORDER
          A boolean property, if true the files that are to be processed are sorted by the hierarchical order prior calling the command (the child file never goes before its parent).

static String PROPERTY_NOTIFICATION_FAIL_MSG
          If non empty, the user will be notified, that the command has failed.

static String PROPERTY_NOTIFICATION_SUCCESS_MSG
          If non empty, the user will be notified, that the command has finished successfully.

static String PROPERTY_NUM_REVISIONS
          An integer property that means the number of revisions the command can be applied.

static String PROPERTY_ON_DIR
          A boolean property, if true, the command can act on folders.

static String PROPERTY_ON_FILE
          A boolean property, if true, the command can act on files.

static String PROPERTY_ON_NON_RECURSIVE_DIR
          A boolean property, if true, the command can act on non recursive folders.

static String PROPERTY_ON_ROOT
          A boolean property, if true, the command can act on the root of the filesystem, if false, the command can act everywhere but on the root.

static String PROPERTY_PRE_COMMANDS
          List of comma separated quoted commands, that will be executed before this command is executed.

static String PROPERTY_PROCESS_ALL_FILES
          Whether to run this command on all files or ignore unimportant.

static String PROPERTY_REFRESH_CURRENT_FOLDER
          When this property is true, refresh of the current folder is performed after successfull execution of this command.

static String PROPERTY_REFRESH_ON_FAIL
          An integer property.

static String PROPERTY_REFRESH_PARENT_FOLDER
          When this property is true, refresh of the parent folder is performed after successfull execution of this command.

static String PROPERTY_REFRESH_PARENT_OF_CURRENT_FOLDER
          When this property is true, refresh of the parent folder of the current folder is performed after successfull execution of this command.

static String PROPERTY_REFRESH_RECURSIVELY_PATTERN_MATCHED
          Pattern that when matched from the exec string, the refresh is performed recursively.

static String PROPERTY_REFRESH_RECURSIVELY_PATTERN_UNMATCHED
          Pattern that when not matched from the exec string, the refresh is performed recursively.

static String PROPERTY_RUN_ON_MULTIPLE_FILES
          A boolean property, if true the command can run on multiple files.

static String PROPERTY_RUN_ON_MULTIPLE_FILES_IN_FOLDER
          A boolean property, if true the command can run on multiple files inside a single folder.

static String PROPERTY_SUPPORTS_ADVANCED_MODE
          A boolean property that describes if the command supports advanced mode in filesystem.

static String PROPERTY_USER_PARAMS
          Value of this property should be an array of Strings.

static Integer REFRESH_ON_FAIL_FALSE
          When this constant is the value of PROPERTY_REFRESH_ON_FAIL command property, the refresh command will be performed after the command fails.

static Integer REFRESH_ON_FAIL_TRUE
          When this constant is the value of PROPERTY_REFRESH_ON_FAIL command property, the refresh command will be always performed even when the command fails.

static Integer REFRESH_ON_FAIL_TRUE_ON_FOLDERS
          When this constant is the value of PROPERTY_REFRESH_ON_FAIL command property, the refresh command will be performed after the command fails only when the command acts on a folder.

Method Summary

String getDisplayName()
          Get the display name of the command.

String getName()
          Get the name of the command.

Object getProperty(String propertyName)
          Get the additional command property.

String[] getPropertyNames()
          Get the names of all supported properties.

void setDisplayName(String displayName)
          Set the display name of the command.

void setName(String name)
          Set the name of the command.

void setProperty(String propertyName, Object value)
          Set the additional property to the command.

Field Detail

NAME_SUFFIX_OFFLINE

public static final String NAME_SUFFIX_OFFLINE

The suffix, that is used to distinguish offline commands.

See Also:: Constant Field Values

NAME_REFRESH

public static final String NAME_REFRESH

The name of the command which does non recursive refresh of a folder.

See Also:: Constant Field Values

NAME_REFRESH_RECURSIVELY

public static final String NAME_REFRESH_RECURSIVELY

The name of the command which does recursive refresh of a folder.

See Also:: Constant Field Values

NAME_LOCK

public static final String NAME_LOCK

The name of the command which will be called to lock the file in VCS.

See Also:: Constant Field Values

NAME_UNLOCK

public static final String NAME_UNLOCK

The name of the command which will be called to unlock the file in VCS.

See Also:: Constant Field Values

NAME_EDIT

public static final String NAME_EDIT

The name of the command which will be called to prepare the file for editing in VCS.

See Also:: Constant Field Values

NAME_DELETE_FILE

public static final String NAME_DELETE_FILE

The name of the command which will be called after a file was deleted.

See Also:: Constant Field Values

NAME_DELETE_DIR

public static final String NAME_DELETE_DIR

The name of the command which will be called after a directory was deleted.

See Also:: Constant Field Values

NAME_REVISION_OPEN

public static final String NAME_REVISION_OPEN

The name of the command which is used to get a specific revision to open.

See Also:: Constant Field Values

NAME_REVISION_LIST

public static final String NAME_REVISION_LIST

The name of the command which is used to get a list of revisions. The encoded serialized RevisionList object should be put to the data output of this command.

See Also:: Constant Field Values

NAME_SCHEDULE_ADD

public static final String NAME_SCHEDULE_ADD

The name of the command which will schedule a file for later add to the repository.

See Also:: Constant Field Values

NAME_SCHEDULE_REMOVE

public static final String NAME_SCHEDULE_REMOVE

The name of the command which will schedule a file for later remove from the repository.

See Also:: Constant Field Values

PROPERTY_LABEL_MNEMONIC

public static final String PROPERTY_LABEL_MNEMONIC

If the command label is not null, this property is used as a mnemonic for the command lanel.

See Also:: Constant Field Values

PROPERTY_ADVANCED_NAME

public static final String PROPERTY_ADVANCED_NAME

Command may set this property which will be visible on the VariableInputDialog. Can be used to tell the user about the specific command appearance.

See Also:: Constant Field Values

PROPERTY_INPUT_DESCRIPTOR

public static final String PROPERTY_INPUT_DESCRIPTOR

Describe the components, that will appear in the variable input dialog prior the command is executed.

See Also:: Constant Field Values

PROPERTY_EXEC

public static final String PROPERTY_EXEC

This property denotes the executable string. This string may contain any number of variables that are expanded prior to execution.

See Also:: Constant Field Values

PROPERTY_EXEC_STRUCTURED

public static final String PROPERTY_EXEC_STRUCTURED

This property denotes the structured execution property. The value of this property is an instance of StructuredExec class. The working directory, executable and arguments can contain variables that are expanded prior to execution.

See Also:: Constant Field Values

PROPERTY_EXEC_SCHEDULED_COMMAND

public static final String PROPERTY_EXEC_SCHEDULED_COMMAND

This property contains the name of command, that is executed on scheduled files. To obtain the full name of this property it has to followed by the scheduled action name.

See Also:: Constant Field Values

PROPERTY_CONCURRENT_EXECUTION

public static final String PROPERTY_CONCURRENT_EXECUTION

This Integer property can contain values of EXEC_* constants. Some of them can be combined together (if their values are simply summed). These values can be summed together:

EXEC_SERIAL_ON_FILE, EXEC_SERIAL_ON_PACKAGE, EXEC_SERIAL_WITH_PARENT, EXEC_SERIAL_OF_COMMAND. The combination has a meaning of logical OR with the exception of EXEC_SERIAL_OF_COMMAND, which applies as a logical AND with the others.

E.g.: (EXEC_SERIAL_ON_FILE | EXEC_SERIAL_OF_COMMAND) will run only one command of this name on the supplied file at a time.

See Also:: Constant Field Values

PROPERTY_CONCURRENT_EXECUTION_WITH

public static final String PROPERTY_CONCURRENT_EXECUTION_WITH

This property has similar meaning as PROPERTY_CONCURRENT_EXECUTION, but contains pairs of command name and integer property enclosed in quotes and delimited by commas. The integer concurrent execution property is valid only with respect to the associated command name.

i.e.: "ADD 4", "STATUS 1"

See Also:: Constant Field Values

PROPERTY_EXEC_PRIORITY

public static final String PROPERTY_EXEC_PRIORITY

An Integer property, that defines the execution priority of this command. (see CommandTask.getPriority() for details).

See Also:: Constant Field Values

PROPERTY_ON_FILE

public static final String PROPERTY_ON_FILE

A boolean property, if true, the command can act on files.

See Also:: Constant Field Values

PROPERTY_ON_DIR

public static final String PROPERTY_ON_DIR

A boolean property, if true, the command can act on folders.

See Also:: Constant Field Values

PROPERTY_ON_NON_RECURSIVE_DIR

public static final String PROPERTY_ON_NON_RECURSIVE_DIR

A boolean property, if true, the command can act on non recursive folders. In terms of NonRecursiveFolder. When the command is executed on a non-recursive folder, recursionBanned variable will be set to "true".

See Also:: Constant Field Values

PROPERTY_ON_ROOT

public static final String PROPERTY_ON_ROOT

A boolean property, if true, the command can act on the root of the filesystem, if false, the command can act everywhere but on the root.

See Also:: Constant Field Values

PROPERTY_PRE_COMMANDS

public static final String PROPERTY_PRE_COMMANDS

List of comma separated quoted commands, that will be executed before this command is executed. The value of this property will be expanded with the command's variables, so that it can be decided by the command (or set in it's variable input descriptor) which command names will be used.

See Also:: Constant Field Values

PROPERTY_REFRESH_CURRENT_FOLDER

public static final String PROPERTY_REFRESH_CURRENT_FOLDER

When this property is true, refresh of the current folder is performed after successfull execution of this command. When a file is selected, the folder in which the file resides is refreshed, when a folder is selected, refresh of that folder is performed.

See Also:: Constant Field Values

PROPERTY_REFRESH_PARENT_FOLDER

public static final String PROPERTY_REFRESH_PARENT_FOLDER

When this property is true, refresh of the parent folder is performed after successfull execution of this command. The parent folder of the selected file/folder is refreshed.

See Also:: Constant Field Values

PROPERTY_REFRESH_PARENT_OF_CURRENT_FOLDER

public static final String PROPERTY_REFRESH_PARENT_OF_CURRENT_FOLDER

When this property is true, refresh of the parent folder of the current folder is performed after successfull execution of this command. When a file is selected, it's grand-parent folder is refreshed, when a folder is selected, it's parent folder is refreshed.

See Also:: Constant Field Values

PROPERTY_REFRESH_RECURSIVELY_PATTERN_MATCHED

public static final String PROPERTY_REFRESH_RECURSIVELY_PATTERN_MATCHED

Pattern that when matched from the exec string, the refresh is performed recursively.

See Also:: Constant Field Values

PROPERTY_REFRESH_RECURSIVELY_PATTERN_UNMATCHED

public static final String PROPERTY_REFRESH_RECURSIVELY_PATTERN_UNMATCHED

Pattern that when not matched from the exec string, the refresh is performed recursively.

See Also:: Constant Field Values

PROPERTY_REFRESH_ON_FAIL

public static final String PROPERTY_REFRESH_ON_FAIL

An integer property. If a command fails and some refresh is scheduled after finish of this command, the value of this property will be inspected to find whether the refresh command should be performed. The value of this property can be one of REFRESH_ON_FAIL_FALSE, REFRESH_ON_FAIL_TRUE, REFRESH_ON_FAIL_TRUE_ON_FOLDERS.

See Also:: Constant Field Values

PROPERTY_CLEAN_UNIMPORTANT_FILES_ON_SUCCESS

public static final String PROPERTY_CLEAN_UNIMPORTANT_FILES_ON_SUCCESS

When this property is true, all unimportant files, that are associated with processed files are deleted after the command finish successfully. This is typically used for commands, that remove the version controled files from working directory.

See Also:: Constant Field Values

PROPERTY_CONFIRMATION_MSG

public static final String PROPERTY_CONFIRMATION_MSG

If non empty, the user will be asked to confirm this message prior to command execution.

See Also:: Constant Field Values

PROPERTY_NOTIFICATION_SUCCESS_MSG

public static final String PROPERTY_NOTIFICATION_SUCCESS_MSG

If non empty, the user will be notified, that the command has finished successfully. The content of this message will be displayed.

See Also:: Constant Field Values

PROPERTY_NOTIFICATION_FAIL_MSG

public static final String PROPERTY_NOTIFICATION_FAIL_MSG

If non empty, the user will be notified, that the command has failed. The content of this message will be displayed.

See Also:: Constant Field Values

PROPERTY_COMMANDS_AFTER_SUCCESS

public static final String PROPERTY_COMMANDS_AFTER_SUCCESS

List of comma separated quoted commands, that will be executed after this command succeeds. The value of this property will be expanded with the command's variables, so that it can be decided by the command (or set in it's variable input descriptor) which command names will be used.

See Also:: Constant Field Values

PROPERTY_COMMANDS_AFTER_FAIL

public static final String PROPERTY_COMMANDS_AFTER_FAIL

List of comma separated quoted commands, that will be executed after this command fails. The value of this property will be expanded with the command's variables, so that it can be decided by the command (or set in it's variable input descriptor) which command names will be used.

See Also:: Constant Field Values

PROPERTY_USER_PARAMS

public static final String PROPERTY_USER_PARAMS

Value of this property should be an array of Strings. It is set and filled from user input in the filesystem.

See Also:: Constant Field Values

PROPERTY_DISPLAY_PLAIN_OUTPUT

public static final String PROPERTY_DISPLAY_PLAIN_OUTPUT

A boolean property, if true a window which shows the output of the command will pop-up.

See Also:: Constant Field Values

PROPERTY_DISPLAY_INTERACTIVE_OUTPUT

public static final String PROPERTY_DISPLAY_INTERACTIVE_OUTPUT

A boolean property, if true a window which shows the output of the command with a possibility to enter an input will pop-up.

See Also:: Constant Field Values

PROPERTY_DISPLAY_VISUALIZER

public static final String PROPERTY_DISPLAY_VISUALIZER

A String property that contains the name of the class which represents the GUI visualizer of this command. The class must be an instance of org.netbeans.modules.vcscore.commands.VcsCommandVisualizer

See Also:: Constant Field Values

PROPERTY_MERGE_ERROR_TO_STANDARD_OUTPUT

public static final String PROPERTY_MERGE_ERROR_TO_STANDARD_OUTPUT

A Boolean property indicating whether the error stream should be merged with the standard stream of the command. If true, the error output will be empty. Supported only when running on JDK 1.5 and newer.
This property is ignored when running on JDK 1.4.x

See Also:: Constant Field Values

PROPERTY_PROCESS_ALL_FILES

public static final String PROPERTY_PROCESS_ALL_FILES

Whether to run this command on all files or ignore unimportant. If true, all files including unimportant will be processed, if false only files which are important will be processed.

See Also:: Constant Field Values

PROPERTY_RUN_ON_MULTIPLE_FILES

public static final String PROPERTY_RUN_ON_MULTIPLE_FILES

A boolean property, if true the command can run on multiple files. The executor will be started only once for all selected files.

See Also:: Constant Field Values

PROPERTY_RUN_ON_MULTIPLE_FILES_IN_FOLDER

public static final String PROPERTY_RUN_ON_MULTIPLE_FILES_IN_FOLDER

A boolean property, if true the command can run on multiple files inside a single folder. The executor will be started only once for all selected files in a folder. If this property is true, PROPERTY_RUN_ON_MULTIPLE_FILES has no effect.

See Also:: Constant Field Values

PROPERTY_NEEDS_HIERARCHICAL_ORDER

public static final String PROPERTY_NEEDS_HIERARCHICAL_ORDER

A boolean property, if true the files that are to be processed are sorted by the hierarchical order prior calling the command (the child file never goes before its parent).

See Also:: Constant Field Values

PROPERTY_IGNORE_FAIL

public static final String PROPERTY_IGNORE_FAIL

When true, the command is supposed to return fail status even when it finish normally. The user will not be warned, that this command has failed. I.e. DIFF command fails when it finds some differences, but the user should not be notified, that something has failed.

See Also:: Constant Field Values

PROPERTY_CHECK_FOR_MODIFICATIONS

public static final String PROPERTY_CHECK_FOR_MODIFICATIONS

When true, automatically check the file modification and reload the editor content if necessary without asking the user.

See Also:: Constant Field Values

PROPERTY_NUM_REVISIONS

public static final String PROPERTY_NUM_REVISIONS

An integer property that means the number of revisions the command can be applied. When zero, the command will be applied to the whole version-controlled files. When positive, the command will be applied to the appropriate number of individual revisions. When negative, the command will be applied to any number of individual revisions.

See Also:: Constant Field Values

PROPERTY_CHANGING_NUM_REVISIONS

public static final String PROPERTY_CHANGING_NUM_REVISIONS

Whether the command changes the number of revisions. If true, the command may add or remove some revisions.

See Also:: Constant Field Values

PROPERTY_CHANGING_REVISION

public static final String PROPERTY_CHANGING_REVISION

Whether the command changes one specific revision. If true the command may add or remove not more than one revision. Property PROPERTY_CHANGED_REVISION_VAR_NAME then should specify the number of revision that has changed to speed up the revision update.

See Also:: Constant Field Values

PROPERTY_CHANGED_REVISION_VAR_NAME

public static final String PROPERTY_CHANGED_REVISION_VAR_NAME

The name of the variable that specifies the changed revision. This property is used only when property PROPERTY_CHANGING_REVISION is true.

See Also:: Constant Field Values

PROPERTY_HIDDEN

public static final String PROPERTY_HIDDEN

Whether the command will appear on the actions popup menu.

See Also:: Constant Field Values

PROPERTY_HIDDEN_TEST_EXPRESSION

public static final String PROPERTY_HIDDEN_TEST_EXPRESSION

An expression, which if expands to an empty string, the command will appear on the actions popup menu. If the expanded expression is non empty, the command will not appear on the popup menu.

See Also:: Constant Field Values

PROPERTY_DISABLED_ON_STATUS

public static final String PROPERTY_DISABLED_ON_STATUS

A string property, that can contain a list of file status attributes. If non empty, the command menu item will be disabled on files whose status is one of the listed status attributes in this property value.

See Also:: Constant Field Values

PROPERTY_DISABLED_WHEN_NOT_LOCKED

public static final String PROPERTY_DISABLED_WHEN_NOT_LOCKED

A boolean property, that when true, the command menu item will be disabled on files that are not locked by the user defined in VcsFileSystem.VAR_LOCKER_USER_NAME variable, or locked by the current user if the variable does not exist.

See Also:: Constant Field Values

PROPERTY_SUPPORTS_ADVANCED_MODE

public static final String PROPERTY_SUPPORTS_ADVANCED_MODE

A boolean property that describes if the command supports advanced mode in filesystem. Such commands are marked by a + sign on the popup (when pressing CTRL key) Information wheather the CTRL key was pressed is stored in the variable passed to the executor. (

See Also:: Constant Field Values

PROPERTY_LOAD_ATTRS_TO_VARS

public static final String PROPERTY_LOAD_ATTRS_TO_VARS

This property can contain the array of attribute names and variable names. The variable values will be set to the values of file object attributes. The array should contain triples of , , ; where var1 value will be set to "true" if the attribute value is not null and to an empty string if it is null, var2 value will be set to the String representation of the attribute value.

See Also:: Constant Field Values

PROPERTY_DISTINGUISH_BINARY_FILES

public static final String PROPERTY_DISTINGUISH_BINARY_FILES

This is a boolean property, which should be set to true on commands, that behaves differently on textual and binary files. If this property is set to true, a variable "PROCESSING_BINARY_FILES" is set to a non-empty value if the files, that are to be processed by the command, are recognized as binary. The decission of whether the file is binary or not is based on the FileObject MIME type.

See Also:: Constant Field Values

PROPERTY_GENERAL_COMMAND_ACTION_CLASS_NAME

public static final String PROPERTY_GENERAL_COMMAND_ACTION_CLASS_NAME

This String property contains the name of class of an action, that will run this command. The action has to sublass the GeneralCommandAction class.

See Also:: Constant Field Values

PROPERTY_GENERAL_COMMAND_ACTION_DISPLAY_NAME

public static final String PROPERTY_GENERAL_COMMAND_ACTION_DISPLAY_NAME

This String property contains the display name of an action, that will run this command. This name will be displayed as a tooltip to the action in toolbar or action's menu item name.

See Also:: Constant Field Values

PROPERTY_ASSOCIATED_COMMAND_INTERFACE_NAME

public static final String PROPERTY_ASSOCIATED_COMMAND_INTERFACE_NAME

The String property, that contain the name of an interface, that represents this command. The interface must extend the org.netbeans.api.vcs.commands.Command interface. The values, that are set through String setters of this interface will be transferred to variables, that are passed at the time of execution of this command.

See Also:: Constant Field Values

PROP_NAME_FOR_INTERNAL_USE_ONLY

public static final String PROP_NAME_FOR_INTERNAL_USE_ONLY

Properties wich contains this string in their names can be added to the command by the vcscore or any other module. They should not be interpreted in any way and not stored persistently. Only the module, that set this property is able to interpret it. Modules using this property should append a unique string to this name to minimize a chance of mutual collisions.

See Also:: Constant Field Values

EXEC_CONCURRENT_ALL

public static final int EXEC_CONCURRENT_ALL

All execution of this command can be done concurrently with others.

See Also:: Constant Field Values

EXEC_SERIAL_ON_FILE

public static final int EXEC_SERIAL_ON_FILE

Serial execution is guaranteed on each file. This command will not run on a file if there is another command already running at the same time.

See Also:: Constant Field Values

EXEC_SERIAL_ON_PACKAGE

public static final int EXEC_SERIAL_ON_PACKAGE

Serial execution is guaranteed inside a single package. This command will not run inside a single package if there is another command already running at the same time.

See Also:: Constant Field Values

EXEC_SERIAL_WITH_PARENT

public static final int EXEC_SERIAL_WITH_PARENT

Serial execution of commands with respect to commands running on a parent folders. The command will not run on a child before all commands on parent folders are finished. This flag is necessary i.e. for ADD command.

See Also:: Constant Field Values

EXEC_SERIAL_OF_COMMAND

public static final int EXEC_SERIAL_OF_COMMAND

Serial execution of commands of this name. That means that only one command of this name will run at a given time. It can be restricted to a single file or a single package by using EXEC_SERIAL_ON_FILE or EXEC_SERIAL_ON_PACKAGE properties.

See Also:: Constant Field Values

EXEC_SERIAL_ALL

public static final int EXEC_SERIAL_ALL

Serial execution of all commands. This command will not run if at least one command is already running.

See Also:: Constant Field Values

EXEC_SERIAL_WITH_PENDING

public static final int EXEC_SERIAL_WITH_PENDING

Serial execution even with respect to the pending commands, that are waiting for the actual execution. This flag cause, that all pending commands are considered in addition to the already running commands when evaluating of whether the command can be executed or not.

See Also:: Constant Field Values

EXEC_SERIAL_INERT

public static final int EXEC_SERIAL_INERT

This command is inert with all other commands. When other commands are considered whether they can be executed, commands with inert concurrent execution property are ignored. This can be used for meta commands, that takes care of execution of other commands.

See Also:: Constant Field Values

REFRESH_ON_FAIL_FALSE

public static final Integer REFRESH_ON_FAIL_FALSE

When this constant is the value of PROPERTY_REFRESH_ON_FAIL command property, the refresh command will be performed after the command fails.

REFRESH_ON_FAIL_TRUE

public static final Integer REFRESH_ON_FAIL_TRUE

When this constant is the value of PROPERTY_REFRESH_ON_FAIL command property, the refresh command will be always performed even when the command fails.

REFRESH_ON_FAIL_TRUE_ON_FOLDERS

public static final Integer REFRESH_ON_FAIL_TRUE_ON_FOLDERS

When this constant is the value of PROPERTY_REFRESH_ON_FAIL command property, the refresh command will be performed after the command fails only when the command acts on a folder.

Method Detail

getName

public String getName()

Get the name of the command.

setName

public void setName(String name)

Set the name of the command.

getDisplayName

public String getDisplayName()

Get the display name of the command. It will be visible on the popup menu under this name. When null, the command will not be visible on the popup menu.

setDisplayName

public void setDisplayName(String displayName)

Set the display name of the command. It will be visible on the popup menu under this name. When null, the command will not be visible on the popup menu.

getPropertyNames

public String[] getPropertyNames()

Get the names of all supported properties.

Returns:: the array of properties names

getProperty

public Object getProperty(String propertyName)

Get the additional command property.

Parameters:: propertyName - the name of the property
Returns:: the value of the property

setProperty

public void setProperty(String propertyName,
                        Object value)

Set the additional property to the command.

Parameters:: propertyName - the name of the property; value - the value of the property. The null value should unset the property