org.netbeans.lib.cvsclient.command.log
Class RlogCommand

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.log.RlogCommand
All Implemented Interfaces:
java.lang.Cloneable, CVSListener

public class RlogCommand
extends BasicCommand

The rlog command is similar to log, 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
RlogCommand()
           
 
Method Summary
protected  boolean assumeLocalPathWhenUnspecified()
          Don't send status of local files prior to executing command, as it's not needed.
 void clearModules()
          clears the list of modules for export.
 Builder createBuilder(EventManager eventMan)
          Create a builder for this command.
 void execute(ClientServices client, EventManager em)
          Execute this command.
 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 getDateFilter()
          Getter for property dateFilter, equals the command-line CVS switch "-d".
 java.lang.String[] getModules()
           
 java.lang.String getOptString()
          String returned by this method defines which options are available for this particular command
 java.lang.String getRevisionFilter()
          Getter for property revisionFilter, equals the command-line CVS switch "-r".
 java.lang.String getStateFilter()
          Getter for property stateFilter, equals the command-line CVS switch "-s".
 java.lang.String getUserFilter()
          Getter for property userFilter, equals the command-line CVS switch "-w".
 boolean isDefaultBranch()
          Getter for property defaultBranch, equals the command-line CVS switch "-b".
 boolean isHeaderAndDescOnly()
          Getter for property headerAndDescOnly, equals the command-line CVS switch "-t".
 boolean isHeaderOnly()
          Getter for property headerOnly, equals the command-line CVS switch "-h".
 boolean isNoTags()
          Getter for property noTags, equals the command-line CVS switch "-N".
 boolean isSuppressHeader()
          Getter for property suppressHeader, equals the command-line CVS switch "-S".
 void resetCVSCommand()
          Resets all switches in the command to the default behaviour.
 boolean setCVSCommand(char opt, java.lang.String optArg)
          Takes the arguments and sets the command.
 void setDateFilter(java.lang.String dateFilter)
          Setter for property dateFilter, equals the command-line CVS switch "-d".
 void setDefaultBranch(boolean defaultBranch)
          Setter for property defaultBranch, equals the command-line CVS switch "-b".
 void setHeaderAndDescOnly(boolean headerAndDescOnly)
          Setter for property headerAndDescOnly, equals the command-line CVS switch "-t".
 void setHeaderOnly(boolean headerOnly)
          Setter for property headerOnly, equals the command-line CVS switch "-h".
 void setModule(java.lang.String module)
          Set the modules to export.
 void setModules(java.lang.String[] modules)
          Set the modules to export.
 void setNoTags(boolean noTags)
          Setter for property noTags, equals the command-line CVS switch "-N".
 void setRevisionFilter(java.lang.String revisionFilter)
          Setter for property revisionFilter, equals the command-line CVS switch "-r".
 void setStateFilter(java.lang.String stateFilter)
          Setter for property stateFilter, equals the command-line CVS switch "-s".
 void setSuppressHeader(boolean suppressHeader)
          Setter for property headerOnly, equals the command-line CVS switch "-S".
 void setUserFilter(java.lang.String userFilter)
          Setter for property userFilter, equals the command-line CVS switch "-w".
 
Methods inherited from class org.netbeans.lib.cvsclient.command.BasicCommand
addArgumentRequest, addArgumentRequests, addDirectoryRequest, addRequest, addRequestForFile, addRequestForWorkingDirectory, addRequestsForDirectory, addRequestsForFile, appendFileArguments, doesCheckFileTime, getFileEndingWith, getFiles, getRecursive, getXthFile, isRecursive, sendEntryAndModifiedRequests, setFiles, setRecursive
 
Methods inherited from class org.netbeans.lib.cvsclient.command.BuildableCommand
commandTerminated, 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

RlogCommand

public RlogCommand()
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()

isDefaultBranch

public boolean isDefaultBranch()
Getter for property defaultBranch, equals the command-line CVS switch "-b".

Returns:
Value of property defaultBranch.

setDefaultBranch

public void setDefaultBranch(boolean defaultBranch)
Setter for property defaultBranch, equals the command-line CVS switch "-b".

Parameters:
defaultBranch - New value of property defaultBranch.

getDateFilter

public java.lang.String getDateFilter()
Getter for property dateFilter, equals the command-line CVS switch "-d".

Returns:
Value of property dateFilter.

setDateFilter

public void setDateFilter(java.lang.String dateFilter)
Setter for property dateFilter, equals the command-line CVS switch "-d".

Parameters:
dateFilter - New value of property dateFilter.

isHeaderOnly

public boolean isHeaderOnly()
Getter for property headerOnly, equals the command-line CVS switch "-h".

Returns:
Value of property headerOnly.

setHeaderOnly

public void setHeaderOnly(boolean headerOnly)
Setter for property headerOnly, equals the command-line CVS switch "-h".

Parameters:
headerOnly - New value of property headerOnly.

isSuppressHeader

public boolean isSuppressHeader()
Getter for property suppressHeader, equals the command-line CVS switch "-S".

Returns:
Value of property suppressHeader.

setSuppressHeader

public void setSuppressHeader(boolean suppressHeader)
Setter for property headerOnly, equals the command-line CVS switch "-S".

Parameters:
suppressHeader - New value of property suppressHeader.

isNoTags

public boolean isNoTags()
Getter for property noTags, equals the command-line CVS switch "-N".

Returns:
Value of property noTags.

setNoTags

public void setNoTags(boolean noTags)
Setter for property noTags, equals the command-line CVS switch "-N".

Parameters:
noTags - New value of property noTags.

getRevisionFilter

public java.lang.String getRevisionFilter()
Getter for property revisionFilter, equals the command-line CVS switch "-r".

Returns:
Value of property revisionFilter.

setRevisionFilter

public void setRevisionFilter(java.lang.String revisionFilter)
Setter for property revisionFilter, equals the command-line CVS switch "-r".

Parameters:
revisionFilter - New value of property revisionFilter. empty string means latest revision of default branch.

getStateFilter

public java.lang.String getStateFilter()
Getter for property stateFilter, equals the command-line CVS switch "-s".

Returns:
Value of property stateFilter.

setStateFilter

public void setStateFilter(java.lang.String stateFilter)
Setter for property stateFilter, equals the command-line CVS switch "-s".

Parameters:
stateFilter - New value of property stateFilter.

getUserFilter

public java.lang.String getUserFilter()
Getter for property userFilter, equals the command-line CVS switch "-w".

Returns:
Value of property userFilter, empty string means the current user.

setUserFilter

public void setUserFilter(java.lang.String userFilter)
Setter for property userFilter, equals the command-line CVS switch "-w".

Parameters:
userFilter - New value of property userFilter.

isHeaderAndDescOnly

public boolean isHeaderAndDescOnly()
Getter for property headerAndDescOnly, equals the command-line CVS switch "-t".

Returns:
Value of property headerAndDescOnly.

setHeaderAndDescOnly

public void setHeaderAndDescOnly(boolean headerAndDescOnly)
Setter for property headerAndDescOnly, equals the command-line CVS switch "-t".

Parameters:
headerAndDescOnly - New value of property headerAndDescOnly.

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

assumeLocalPathWhenUnspecified

protected boolean assumeLocalPathWhenUnspecified()
Don't send status of local files prior to executing command, as it's not needed.

Overrides:
assumeLocalPathWhenUnspecified in class BasicCommand

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.

 

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