org.netbeans.lib.cvsclient.command.watch

Class WatchCommand

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.watch.WatchCommand

All Implemented Interfaces:

java.lang.Cloneable, CVSListener

public class WatchCommand
extends BasicCommand

Author:

Thomas Singer

Constructor Summary

Constructors

Constructor and Description
WatchCommand() Construct a new WatchCommand.

Method Summary

Methods

Modifier and Type	Method and Description
void	commandTerminated(TerminationEvent e) If a builder was set-up, it's outputDone() method is called.
void	execute(ClientServices client, EventManager eventManager) Executes this command.
java.lang.String	getCVSArguments() Returns the arguments of the command in the command-line style.
java.lang.String	getCVSCommand() Returns how this command would look like when typed on the command line.
java.lang.String	getOptString() String returned by this method defines which options are available for this command.
Watch	getWatch() Returns the watch.
WatchMode	getWatchMode() Returns the WatchMode.
void	resetCVSCommand() Resets all switches in this command.
boolean	setCVSCommand(char opt, java.lang.String optArg) Uses the specified argument to set the appropriate properties.
void	setWatch(Watch watch) Sets the watch.
void	setWatchMode(WatchMode watchMode) Sets the WatchMode.

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

createBuilder, 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

WatchCommand

public WatchCommand()

Construct a new WatchCommand.

Method Detail

execute

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

Executes this 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

eventManager - the EventManager used for sending events

Throws:

java.lang.IllegalStateException - if the commands options aren't set correctly

AuthenticationException - if the connection could not be established

CommandException - if some other thing gone wrong

commandTerminated

public void commandTerminated(TerminationEvent e)

If a builder was set-up, it's outputDone() method is called. This method is called, when the server responses with "ok" or "error" (== when the command finishes).

Specified by:

commandTerminated in interface CVSListener

Overrides:

commandTerminated in class BuildableCommand

setCVSCommand

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

Uses the specified argument to set the appropriate properties. To be mainly used for automatic settings (like parsing the .cvsrc file)

Specified by:

setCVSCommand in class Command

Returns:

whether 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 command.

Specified by:

getOptString in class Command

resetCVSCommand

public void resetCVSCommand()

Resets all switches in this command. After calling this method, the command behaves like newly created.

Specified by:

resetCVSCommand in class Command

getCVSCommand

public java.lang.String getCVSCommand()

Returns how this command would look like when typed on the command line.

Specified by:

getCVSCommand 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

getWatchMode

public WatchMode getWatchMode()

Returns the WatchMode.

setWatchMode

public void setWatchMode(WatchMode watchMode)

Sets the WatchMode.

getWatch

public Watch getWatch()

Returns the watch.

setWatch

public void setWatch(Watch watch)

Sets the watch. If the WatchMode ADD or REMOVE is used, null is the same as Watch.ALL. If the WatchMode ON or OFF is used, this option isn't used at all.