org.netbeans.lib.cvsclient.command.annotate
Class RannotateCommand

java.lang.Object
  extended by org.netbeans.lib.cvsclient.command.Command
      extended by org.netbeans.lib.cvsclient.command.BuildableCommand
          extended by org.netbeans.lib.cvsclient.command.BasicCommand
              extended by org.netbeans.lib.cvsclient.command.annotate.RannotateCommand
All Implemented Interfaces:
java.lang.Cloneable, CVSListener

public class RannotateCommand
extends BasicCommand

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


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
RannotateCommand()
           
 
Method Summary
 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.
 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[] getModules()
           
 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 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(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 setModule(java.lang.String module)
          Set the modules to export.
 void setModules(java.lang.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(java.lang.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(java.lang.String[] modules)
Set the modules to export.

Parameters:
theModules - the names of the modules to export

getModules

public java.lang.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 java.lang.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 java.lang.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,
                             java.lang.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 java.lang.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 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.

 

Built on August 7 2008.  |  Portions Copyright 1997-2005 Sun Microsystems, Inc. All rights reserved.