org.netbeans.lib.cvsclient.command.annotate

Class AnnotateCommand

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.AnnotateCommand

All Implemented Interfaces:

java.lang.Cloneable, CVSListener

public class AnnotateCommand
extends BasicCommand

The annotate command shows all lines of the file and annotates each line with cvs-related info.

Author:

Milos Kleint

Constructor Summary

Constructors

Constructor and Description
AnnotateCommand() Construct a new diff 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 eventMan) Create a builder for this command.
void	execute(ClientServices client, EventManager em) Execute a command
java.lang.String	getAnnotateByDate() Getter for property annotateByDate.
java.lang.String	getAnnotateByRevision() Getter for property annotateByRevision.
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	isUseHeadIfNotFound() Getter for property useHeadIfNotFound.
void	resetCVSCommand() resets all switches in the command.
void	setAnnotateByDate(java.lang.String annotateByDate) Setter for property annotateByDate.
void	setAnnotateByRevision(java.lang.String annotateByRevision) Setter for property annotateByRevision.
boolean	setCVSCommand(char opt, java.lang.String optArg) takes the arguments and sets the command.
void	setUseHeadIfNotFound(boolean useHeadIfNotFound) Setter for property useHeadIfNotFound.

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

AnnotateCommand

public AnnotateCommand()

Construct a new diff command

Method Detail

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.

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

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 java.lang.String getAnnotateByDate()

Getter for property annotateByDate.

Returns:

Value of property annotateByDate.

setAnnotateByDate

public void setAnnotateByDate(java.lang.String annotateByDate)

Setter for property annotateByDate.

Parameters:

annotateByDate - New value of property annotateByDate.

getAnnotateByRevision

public java.lang.String getAnnotateByRevision()

Getter for property annotateByRevision.

Returns:

Value of property annotateByRevision.

setAnnotateByRevision

public void setAnnotateByRevision(java.lang.String annotateByRevision)

Setter for property annotateByRevision.

Parameters:

annotateByRevision - New value of property annotateByRevision.

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