VCS Command Properties
Each command in a VCS profile has a group of properties that determine things
such as the execution string the IDE uses for the command, what kind of nodes
the command is available for, and how the command output is parsed. The commands
are grouped under three tabs.
Properties Tab
- Label. Indicates the title to be shown in the VCS commands submenu.
- Name. Indicates the internal name used by the command, usually in
uppercase letters. Should be unique.
- Label Mnemonic. Specifies the mnemonic used by the command. Check
to make sure that the mnemonic you use isn't already in use by another command.
- Exec. Specifies an execution string in command-line syntax. You can
also specify a Java class. If you use a class, it must be compiled and must
implement the org.netbeans.modules.vcscore.cmdline.VcsAdditionalCommand
interface.
- Confirmation Message Before Execution. Sets the warning question
the IDE displays before running the command. Can contain variables.
- Notification Message After Success. Sets the informational message
that the IDE displays if the command succeeds. Can contain variables.
- Notification Message After Failure. Sets the message that the IDE
displays if the command fails. Can contain variables.
- Input Descriptor. Defines input dialog before the command is run.
For example, LABEL("Hello!") PROMPT_FOR(NAME,"What's your name?").
- Visible on Files, Folders, and Root. Controls whether the command
is available for file nodes, folder nodes, and root nodes in the Explorer
.
- Run on Multiple Files. If True, runs the command with all files included
in the selection in the Explorer in its arguments. If False, runs the command
separately for each file.
- Run on Multiple Files In Single Folder Only. If this command is run
on files from different directories, and this property is set to True, the
command groups the files by directory and executes separately for each directory.
This property overrides the Can Run on Multiple Files property.
- Refresh Parent Folder, Processed Files, and Current Folder. Controls
which files and directories are refreshed after the command is called.
- Refresh Even If Failed. Refreshes the selected files even if
the command fails.
- Display Output. If True, displays command output in the Output of
VCS Command window.
- Distinguish Binary Files. If True, sorts binary and text files and
executes on each group separately. The command sets the PROCESSING_BINARY_FILES
variable to true for binary files and false for text files.
Expert Tab
- Advanced Name. Localized name of the command as displayed in the
advanced command options dialog box.
- Supports Advanced Mode. If True, the command supports an advanced
command options dialog box.
- Hidden. If True, this command does not appear in the VCS commands
submenu.
- Disabled on Statuses. Set of statuses of nodes for which this command
is to be disabled. Enclose each status name in quotes and delimit them with
commas. For example,
"Current", "Local"
- Process All Files. If True, the command runs on all files represented
by the selected node or nodes. If False, the command runs only on files designated
as important for that type of node. For example, on Java form nodes (
),
.form files and .java files are important, but .class
files are unimportant. On Java source nodes (
),
.java files are important and .class files are unimportant.
- Delete All Local Unimportant Files After Success. If Process All
Files is set to False, commands like Remove do not delete unimportant files
like .class. Set this property to True to delete unimportant files
as well.
- Keep Hierarchical Order of Files. If True, parent directories are
always processed before their children.
- Do Not Warn of Failure. If True, no message appears in the Output
window if the command fails.
- Refresh Recursively When Matched. When this expression is present
in the command execution string, the IDE runs the Refresh Recursively command
after the command executes.
- Refresh Recursively When Not Matched. When this expression is not
present in the command execution string, the IDE runs the Refresh Recursively
command after the command executes.
- Reload Source Editor Content. If any of the files affected by this
command are open in the Source Editor, the IDE refreshes the Source Editor
content after this command executes.
- Data and Error Regex. The regular expression used to parse the command's
data and error outputs line-by-line.
- Global Data and Error Regex. The regular expression used to parse
the command's data and error outputs all at once.
- Input. Data that should be supplied on the standard input of the
process. For example, some commands require you to confirm your action by
entering Y. You can set the command to automatically confirm itself
by setting the Input property to Y.
- Number of File Revisions to Execute On. If this property is set to
zero, the command can run only on the working copy of the file. If this property
is set to a positive value, the command can run on one or more file revision.
- Is Changing File Revisions. If this command creates a new file revision
and this property is set to True, the IDE reflects the new file revision in
the Versioning Explorer.
- General Command Action Class Name. The class name of the action that
runs the command. For Versioning Toolbar buttons, for example, you can use
one of the predefined button classes or write your own class. The class must
subclass GeneralCommandAction.
- General Command Action Display Name. The name that is displayed on
the tool tip for the command's Versioning Toolbar button.
- Commands Executed After Success. The command that the IDE executes
after this command executes successfully. Can contain variables.
- Commands Executed After Failure. The command that the IDE executes
after this command fails. Can contain variables.
Refresh Info Tab
- Index properties. These properties, such as File Index and Status
Index, apply only to the Refresh (LIST) and Refresh Recursively (LIST_SUB)
commands. These two commands use POSIX regular expressions to return status
information in regex form. These index properties refer to the regex to determine
in which sort group of the regex each of these pieces of information can be
found. For example, if the file status information is contained in the second
sort group of the regex, set the Status Index property to 2. If your version
control system does not return information in a given category, set that category's
index property to -1.
- Substitution of Status Strings. If a file status is not literally
named in the command output, you can specify its equivalent in the command
output. Enter substitution patterns as string-value pairs in quotes separated
by commas. For example, when the CVS Commit command executes successfully,
the output ends with Done. To substitute Up-to-date for Done when reading
command output, enter:
"Done", "Up-to-date"
- Read Both Data Outputs. If True, the refresh data is read from both
the standard data output and the error data output. If False, only the standard
data output is read.
Legal Notices