org.netbeans.lib.cvsclient.command.status

Class StatusCommand

java.lang.Object

org.netbeans.lib.cvsclient.command.Command

org.netbeans.lib.cvsclient.command.BuildableCommand

org.netbeans.lib.cvsclient.command.BasicCommand

org.netbeans.lib.cvsclient.command.status.StatusCommand

All Implemented Interfaces:

java.lang.Cloneable, CVSListener

public class StatusCommand
extends BasicCommand

The status command looks up the status of files in the repository

Author:

Robert Greig

Constructor Summary

Constructors

Constructor and Description
StatusCommand() Construct a new status command

Method Summary

Methods

Modifier and Type	Method and Description
void	commandTerminated(TerminationEvent e) called when server responses with "ok" or "error", (when the command finishes)
Builder	createBuilder(EventManager eventManager) Create a builder for this command.
void	execute(ClientServices client, EventManager em) Execute a command
java.lang.String	getCVSArguments() Returns the arguments of the command in the command-line style.
java.lang.String	getCVSCommand() This method returns how the command would looklike when typed on the command line.
java.lang.String	getOptString() String returned by this method defines which options are available for this particular command
boolean	isIncludeTags() Getter for property includeTags.
void	resetCVSCommand() resets all switches in the command.
boolean	setCVSCommand(char opt, java.lang.String optArg) takes the arguments and sets the command.
void	setIncludeTags(boolean inclTags) Setter for property includeTags.

Methods inherited from class org.netbeans.lib.cvsclient.command.BasicCommand

getFileEndingWith, getFiles, getRecursive, getXthFile, isRecursive, setFiles, setRecursive

Methods inherited from class org.netbeans.lib.cvsclient.command.BuildableCommand

messageSent, messageSent, setBuilder

Methods inherited from class org.netbeans.lib.cvsclient.command.Command

clone, fileAdded, fileInfoGenerated, fileRemoved, fileToRemove, fileUpdated, getDisplayName, getGlobalOptions, getLocalDirectory, getLocalPath, getRelativeToLocalPathInUnixStyle, hasFailed, moduleExpanded, setDisplayName

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusCommand

public StatusCommand()

Construct a new status command

Method Detail

createBuilder

public Builder createBuilder(EventManager eventManager)

Create a builder for this command.

Overrides:

createBuilder in class BuildableCommand

Parameters:

eventMan - the event manager used to receive events.

execute

public void execute(ClientServices client,
           EventManager em)
             throws CommandException,
                    AuthenticationException

Execute a command

Overrides:

execute in class BasicCommand

Parameters:

client - the client services object that provides any necessary services to this command, including the ability to actually process all the requests.

Throws:

CommandException - if an error occurs executing the command

AuthenticationException

isIncludeTags

public boolean isIncludeTags()

Getter for property includeTags.

Returns:

Value of property includeTags.

setIncludeTags

public void setIncludeTags(boolean inclTags)

Setter for property includeTags.

Parameters:

includeTags - New value of property includeTags.

commandTerminated

public void commandTerminated(TerminationEvent e)

called when server responses with "ok" or "error", (when the command finishes)

Specified by:

commandTerminated in interface CVSListener

Overrides:

commandTerminated in class BuildableCommand

getCVSCommand

public java.lang.String getCVSCommand()

This method returns how the command would looklike when typed on the command line. Each command is responsible for constructing this information.

Specified by:

getCVSCommand in class Command

setCVSCommand

public boolean setCVSCommand(char opt,
                    java.lang.String optArg)

takes the arguments and sets the command. To be mainly used for automatic settings (like parsing the .cvsrc file)

Specified by:

setCVSCommand in class Command

Returns:

true if the option (switch) was recognized and set

getOptString

public java.lang.String getOptString()

String returned by this method defines which options are available for this particular command

Specified by:

getOptString in class Command

resetCVSCommand

public void resetCVSCommand()

resets all switches in the command. After calling this method, the command should have no switches defined and should behave defaultly.

Specified by:

resetCVSCommand in class Command

getCVSArguments

public java.lang.String getCVSArguments()

Returns the arguments of the command in the command-line style. Similar to getCVSCommand() however without the files and command's name

Specified by:

getCVSArguments in class Command