org.netbeans.lib.cvsclient.command.watchers

Class WatchersCommand

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.watchers.WatchersCommand

All Implemented Interfaces:

Serializable, Cloneable, CVSListener

public class WatchersCommand
extends BasicCommand

The watchers command looks up who is watching this file, who is interested in it.

Author:

Milos Kleint, Thomas Singer

See Also:

Serialized Form

Field Summary

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

clientServices, files, requests

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

builder

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

localDirectory

Constructor Summary

Constructors

Constructor and Description
WatchersCommand() Construct a new watchers 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) Creates and returns the WatchersBuilder.
void	execute(ClientServices client, EventManager eventManager) Executes this command.
String	getCVSArguments() Returns the arguments of the command in the command-line style.
String	getCVSCommand() This method returns how the command would looklike when typed on the command line.
String	getOptString() String returned by this method defines which options are available for this particular command
void	resetCVSCommand() resets all switches in the command.
boolean	setCVSCommand(char opt, String optArg) takes the arguments and sets the command.

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

addArgumentRequest, addArgumentRequests, addDirectoryRequest, addRequest, addRequestForFile, addRequestForWorkingDirectory, addRequestsForDirectory, addRequestsForFile, appendFileArguments, assumeLocalPathWhenUnspecified, doesCheckFileTime, getFileEndingWith, getFiles, getRecursive, getXthFile, isRecursive, sendEntryAndModifiedRequests, setFiles, setRecursive

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

isBuilderSet, messageSent, messageSent, setBuilder

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

WatchersCommand

public WatchersCommand()

Construct a new watchers command.

Method Detail

createBuilder

public Builder createBuilder(EventManager eventManager)

Creates and returns the WatchersBuilder.

Overrides:

createBuilder in class BuildableCommand

Parameters:

eventMan - the event manager used to receive events.

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

Throws:

CommandException - if an error occurs executing the command

AuthenticationException

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