当前页面: 在线文档首页 > NetBeans API Javadoc 4.1.0

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

All Superinterfaces:

ChainingCommand, Command, FileReaderCommand, RegexOutputCommand, TextOutputCommand

---

public interface VcsDescribedCommand

extends Command, TextOutputCommand, RegexOutputCommand, FileReaderCommand, ChainingCommand

This class represents a command whose behavior is described by VcsCommand.

---

Method Summary
Object	clone()
Map	getAdditionalVariables()           Get additional variables for the command execution.
File[]	getDiskFiles()           Sometimes the FileObject can not be found for a desired file.
VcsCommandExecutor	getExecutor()           Deprecated. This is needed only for the compatibility with the old "API".
String	getPreferredExec()           Get a preferred execution string, which might have some variables or patterns expanded.
StructuredExec	getPreferredStructuredExec()           Get a preferred structured execution property, which might have some variables or patterns expanded.
VcsCommand	getVcsCommand()           Get the VcsCommand instance associated with this command.
VcsCommandVisualizer.Wrapper	getVisualizerWrapper()           Get a wrapper for the visualizer.
void	setAdditionalVariables(Map vars)           Set additional variables for the command execution.
void	setDiskFiles(File[] files)           Sometimes the FileObject can not be found for a desired file.
void	setExecutor(VcsCommandExecutor executor)           Deprecated. This is needed only for the compatibility with the old "API".
void	setPreferredExec(String preferredExec)           Set a preferred execution string, which might have some variables or patterns expanded.
void	setPreferredStructuredExec(StructuredExec preferredSExec)           Set a preferred structured execution property, which might have some variables or patterns expanded.
void	setVcsCommand(VcsCommand cmd)           Set the VcsCommand instance associated with this command.
void	setVisualizerWrapper(VcsCommandVisualizer.Wrapper wrapper)           Set a wrapper for the visualizer.

 

Methods inherited from interface org.netbeans.api.vcs.commands.Command

execute, getApplicableFiles, getDisplayName, getFiles, getName, isExpertMode, isGUIMode, setExpertMode, setFiles, setGUIMode

 

Methods inherited from interface org.netbeans.modules.vcscore.commands.TextOutputCommand

addTextErrorListener, addTextOutputListener, removeTextErrorListener, removeTextOutputListener

 

Methods inherited from interface org.netbeans.modules.vcscore.commands.RegexOutputCommand

addRegexErrorListener, addRegexOutputListener, getErrorRegex, getStandardRegex, removeRegexErrorListener, removeRegexOutputListener, setErrorRegex, setStandardRegex

 

Methods inherited from interface org.netbeans.modules.vcscore.commands.FileReaderCommand

addDirReaderListener, addFileReaderListener, removeDirReaderListener, removeFileReaderListener

 

Methods inherited from interface org.netbeans.modules.vcscore.commands.ChainingCommand

getNextCommand, setNextCommand

 

Method Detail

setVcsCommand

public void setVcsCommand(VcsCommand cmd)

Set the VcsCommand instance associated with this command.

Parameters:

cmd - the VcsCommand.

---

getVcsCommand

public VcsCommand getVcsCommand()

Get the VcsCommand instance associated with this command.

Returns:

The VcsCommand.

---

setAdditionalVariables

public void setAdditionalVariables(Map vars)

Set additional variables for the command execution.

Parameters:

vars - The map of variable names and values.

---

getAdditionalVariables

public Map getAdditionalVariables()

Get additional variables for the command execution.

Returns:

the map of variable names and values.

---

setPreferredExec

public void setPreferredExec(String preferredExec)

Set a preferred execution string, which might have some variables or patterns expanded.

Parameters:

preferredExec - the preferred execution string

---

getPreferredExec

public String getPreferredExec()

Get a preferred execution string, which might have some variables or patterns expanded.

Returns:

the preferred execution string

---

setPreferredStructuredExec

public void setPreferredStructuredExec(StructuredExec preferredSExec)

Set a preferred structured execution property, which might have some variables or patterns expanded.

Parameters:

preferredSExec - the preferred structured execution property

---

getPreferredStructuredExec

public StructuredExec getPreferredStructuredExec()

Get a preferred structured execution property, which might have some variables or patterns expanded.

Returns:

the preferred structured execution property

---

setExecutor

public void setExecutor(VcsCommandExecutor executor)

Deprecated. This is needed only for the compatibility with the old "API".

Set the executor, which was already created to take care about executing of this command.

---

getExecutor

public VcsCommandExecutor getExecutor()

Deprecated. This is needed only for the compatibility with the old "API".

Get the executor, which was already created to take care about executing of this command.

---

setDiskFiles

public void setDiskFiles(File[] files)

Sometimes the FileObject can not be found for a desired file. In this case this method should be used to specify directly the disk files to act on. The command is expected to act on the union of all set FileObjects and java.io.Files.

Some commands require here directories only! TODO assert it rather then leaving them fail for misterious reasons. Typicaly OS 'cd file.txt;' failure.

Parameters:

files - The array of files to act on.

---

getDiskFiles

public File[] getDiskFiles()

Sometimes the FileObject can not be found for a desired file. In this case this method should be used to specify directly the disk files to act on. The command is expected to act on the union of all set FileObjects and java.io.Files.

Returns:

The array of files to act on.

---

setVisualizerWrapper

public void setVisualizerWrapper(VcsCommandVisualizer.Wrapper wrapper)

Set a wrapper for the visualizer. A GUI output of the command (visualizer) will be displayed in this wrapper, if any GUI output is available.

Parameters:

wrapper - The wrapper for the command's GUI visualizer

---

getVisualizerWrapper

public VcsCommandVisualizer.Wrapper getVisualizerWrapper()

Get a wrapper for the visualizer. If there is a wrapper defined, the command visualizer will be displayed in this wrapper.

---

clone

public Object clone()

---

Overview  Package   Class  Use  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

Built on May 4 2005.  |  Portions Copyright 1997-2005 Sun Microsystems, Inc. All rights reserved.