org.netbeans.lib.cvsclient.command.annotate

Class RannotateCommand

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.annotate.RannotateCommand

All Implemented Interfaces:

Serializable, Cloneable, CVSListener

public class RannotateCommand
extends BasicCommand

The rannotate command is similar to anootate, but doens't operate on currently checked out sources.

Author:

MIlos Kleint

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
RannotateCommand()

Method Summary

Methods

Modifier and Type	Method and Description
void	clearModules() clears the list of modules for export.
void	commandTerminated(TerminationEvent e) called when server responses with "ok" or "error", (when the command finishes)
Builder	createBuilder(EventManager eventMan) Create a builder for this command.
void	execute(ClientServices client, EventManager em) Execute this command.
String	getAnnotateByDate() Getter for property annotateByDate.
String	getAnnotateByRevision() Getter for property annotateByRevision.
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[]	getModules()
String	getOptString() String returned by this method defines which options are available for this particular command
boolean	isUseHeadIfNotFound() Getter for property useHeadIfNotFound.
void	moduleExpanded(ModuleExpansionEvent e) This is called when the server has responded to an expand-modules request.
void	resetCVSCommand() Resets all switches in the command to the default behaviour.
void	setAnnotateByDate(String annotateByDate) Setter for property annotateByDate.
void	setAnnotateByRevision(String annotateByRevision) Setter for property annotateByRevision.
boolean	setCVSCommand(char opt, String optArg) Takes the arguments and sets the command.
void	setModule(String module) Set the modules to export.
void	setModules(String[] modules) Set the modules to export.
void	setUseHeadIfNotFound(boolean useHeadIfNotFound) Setter for property useHeadIfNotFound.

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RannotateCommand

public RannotateCommand()

Method Detail

setModule

public void setModule(String module)

Set the modules to export.

Parameters:

theModules - the names of the modules to export

clearModules

public void clearModules()

clears the list of modules for export.

setModules

public void setModules(String[] modules)

Set the modules to export.

Parameters:

theModules - the names of the modules to export

getModules

public String[] getModules()

execute

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

Execute 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

moduleExpanded

public void moduleExpanded(ModuleExpansionEvent e)

This is called when the server has responded to an expand-modules request.

Specified by:

moduleExpanded in interface CVSListener

Overrides:

moduleExpanded in class Command

getCVSCommand

public String getCVSCommand()

Description copied from class: Command

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

getCVSArguments

public String getCVSArguments()

Description copied from class: Command

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

setCVSCommand

public boolean setCVSCommand(char opt,
                    String optArg)

Description copied from class: Command

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

resetCVSCommand

public void resetCVSCommand()

Description copied from class: Command

Resets all switches in the command to the default behaviour. After calling this method, the command should behave defaultly.

Specified by:

resetCVSCommand in class Command

getOptString

public String getOptString()

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

Specified by:

getOptString in class Command

createBuilder

public Builder createBuilder(EventManager eventMan)

Create a builder for this command.

Overrides:

createBuilder in class BuildableCommand

Parameters:

eventMan - the event manager used to receive events.

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

isUseHeadIfNotFound

public boolean isUseHeadIfNotFound()

Getter for property useHeadIfNotFound.

Returns:

Value of property useHeadIfNotFound.

setUseHeadIfNotFound

public void setUseHeadIfNotFound(boolean useHeadIfNotFound)

Setter for property useHeadIfNotFound.

Parameters:

useHeadIfNotFound - New value of property useHeadIfNotFound.

getAnnotateByDate

public String getAnnotateByDate()

Getter for property annotateByDate.

Returns:

Value of property annotateByDate.

setAnnotateByDate

public void setAnnotateByDate(String annotateByDate)

Setter for property annotateByDate.

Parameters:

annotateByDate - New value of property annotateByDate.

getAnnotateByRevision

public String getAnnotateByRevision()

Getter for property annotateByRevision.

Returns:

Value of property annotateByRevision.

setAnnotateByRevision

public void setAnnotateByRevision(String annotateByRevision)

Setter for property annotateByRevision.

Parameters:

annotateByRevision - New value of property annotateByRevision.