org.netbeans.lib.cvsclient.command.history

Class HistoryCommand

java.lang.Object

org.netbeans.lib.cvsclient.command.Command

org.netbeans.lib.cvsclient.command.history.HistoryCommand

All Implemented Interfaces:

Serializable, Cloneable, CVSListener

public class HistoryCommand
extends Command

The history command provides information history of activities in repository.

Author:

Milos Kleint

See Also:

Serialized Form

Field Summary

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

localDirectory

Constructor Summary

Constructors

Constructor and Description
HistoryCommand() Construct a new history command

Method Summary

Methods

Modifier and Type	Method and Description
void	addForUsers(String forUser)
void	addLastEventForFile(String newFile)
void	addReportLastEventForModule(String newModule)
void	addReportOnModule(String newReportOnModule)
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
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[]	getForUsers() Getter for property forUsers.
String[]	getLastEventForFile() Getter for property lastEventForFile.
String	getOptString() String returned by this method defines which options are available for this particular command
String	getReportEventType() Getter for property reportEventType.
String[]	getReportLastEventForModule() Getter for property reportLastEventForModule.
String[]	getReportOnModule() Getter for property reportOnModule.
String	getShowBackToRecordContaining() Getter for property goBackToRecord.
String	getSinceDate() Getter for property sinceDate.
String	getSinceRevision() Getter for property sinceRevision.
String	getSinceTag() Getter for property sinceTag.
String	getTimeZone() Getter for property timeZone.
boolean	isForAllUsers() Getter for property forAllUsers.
boolean	isForWorkingDirectory() Getter for property forWorkingDirectory.
boolean	isLastEventOfProject() Getter for property lastEventOfProject.
boolean	isReportCheckouts() Getter for property reportCheckout.
boolean	isReportCommits() Getter for property reportCommits.
boolean	isReportEverything() Getter for property reportEverything.
boolean	isReportTags() Getter for property reportTags.
void	resetCVSCommand() resets all switches in the command.
boolean	setCVSCommand(char opt, String optArg) takes the arguments and sets the command.
void	setForAllUsers(boolean forAllUsers) Setter for property forAllUsers.
void	setForUsers(String[] forUsers) Setter for property forUsers.
void	setForWorkingDirectory(boolean forWorkingDirectory) Setter for property forWorkingDirectory.
void	setLastEventForFile(String[] lastEventForFile) Setter for property lastEventForFile.
void	setLastEventOfProject(boolean lastEventOfProject) Setter for property lastEventOfProject.
void	setReportCheckouts(boolean reportCheckout) Setter for property reportCheckout.
void	setReportCommits(boolean reportCommits) Setter for property reportCommits.
void	setReportEventType(String reportEventType) Setter for property reportEventType.
void	setReportEverything(boolean reportEverything) Setter for property reportEverything.
void	setReportLastEventForModule(String[] reportLastEventForModule) Setter for property reportLastEventForModule.
void	setReportOnModule(String[] reportOnModule) Setter for property reportOnModule.
void	setReportTags(boolean reportTags) Setter for property reportTags.
void	setShowBackToRecordContaining(String goBackToRecord) Setter for property goBackToRecord.
void	setSinceDate(String sinceDate) Setter for property sinceDate.
void	setSinceRevision(String sinceRevision) Setter for property sinceRevision.
void	setSinceTag(String sinceTag) Setter for property sinceTag.
void	setTimeZone(String timeZone) Setter for property timeZone.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryCommand

public HistoryCommand()

Construct a new history command

Method Detail

createBuilder

public Builder createBuilder(EventManager eventMan)

Create a builder for this command.

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 Command

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

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 Command

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

isForAllUsers

public boolean isForAllUsers()

Getter for property forAllUsers. (cvs switch -a)

Returns:

Value of property forAllUsers.

setForAllUsers

public void setForAllUsers(boolean forAllUsers)

Setter for property forAllUsers. (cvs switch -a)

Parameters:

forAllUsers - New value of property forAllUsers.

getShowBackToRecordContaining

public String getShowBackToRecordContaining()

Getter for property goBackToRecord. (cvs switch -b)

Returns:

Value of property goBackToRecord.

setShowBackToRecordContaining

public void setShowBackToRecordContaining(String goBackToRecord)

Setter for property goBackToRecord. (cvs switch -b)

Parameters:

goBackToRecord - New value of property goBackToRecord.

isReportCommits

public boolean isReportCommits()

Getter for property reportCommits. (cvs switch -c)

Returns:

Value of property reportCommits.

setReportCommits

public void setReportCommits(boolean reportCommits)

Setter for property reportCommits. (cvs switch -b)

Parameters:

reportCommits - New value of property reportCommits.

getSinceDate

public String getSinceDate()

Getter for property sinceDate. (cvs switch -D)

Returns:

Value of property sinceDate.

setSinceDate

public void setSinceDate(String sinceDate)

Setter for property sinceDate. (cvs switch -D)

Parameters:

sinceDate - New value of property sinceDate.

isReportEverything

public boolean isReportEverything()

Getter for property reportEverything. (cvs switch -e)

Returns:

Value of property reportEverything.

setReportEverything

public void setReportEverything(boolean reportEverything)

Setter for property reportEverything. (cvs switch -e)

Parameters:

reportEverything - New value of property reportEverything.

isLastEventOfProject

public boolean isLastEventOfProject()

Getter for property lastEventOfProject. (cvs switch -l)

Returns:

Value of property lastEventOfProject.

setLastEventOfProject

public void setLastEventOfProject(boolean lastEventOfProject)

Setter for property lastEventOfProject. (cvs switch -l)

Parameters:

lastEventOfProject - New value of property lastEventOfProject.

isReportCheckouts

public boolean isReportCheckouts()

Getter for property reportCheckout. (cvs switch -o)

Returns:

Value of property reportCheckout.

setReportCheckouts

public void setReportCheckouts(boolean reportCheckout)

Setter for property reportCheckout. (cvs switch -o)

Parameters:

reportCheckout - New value of property reportCheckout.

getSinceRevision

public String getSinceRevision()

Getter for property sinceRevision. (cvs switch -r)

Returns:

Value of property sinceRevision.

setSinceRevision

public void setSinceRevision(String sinceRevision)

Setter for property sinceRevision. (cvs switch -r)

Parameters:

sinceRevision - New value of property sinceRevision.

isReportTags

public boolean isReportTags()

Getter for property reportTags. (cvs switch -T)

Returns:

Value of property reportTags.

setReportTags

public void setReportTags(boolean reportTags)

Setter for property reportTags. (cvs switch -T)

Parameters:

reportTags - New value of property reportTags.

getSinceTag

public String getSinceTag()

Getter for property sinceTag. (cvs switch -t)

Returns:

Value of property sinceTag.

setSinceTag

public void setSinceTag(String sinceTag)

Setter for property sinceTag. (cvs switch -t)

Parameters:

sinceTag - New value of property sinceTag.

isForWorkingDirectory

public boolean isForWorkingDirectory()

Getter for property forWorkingDirectory. (cvs switch -w)

Returns:

Value of property forWorkingDirectory.

setForWorkingDirectory

public void setForWorkingDirectory(boolean forWorkingDirectory)

Setter for property forWorkingDirectory. (cvs switch -w)

Parameters:

forWorkingDirectory - New value of property forWorkingDirectory.

getReportEventType

public String getReportEventType()

Getter for property reportEventType. (cvs switch -x)

Returns:

Value of property reportEventType.

setReportEventType

public void setReportEventType(String reportEventType)

Setter for property reportEventType. (cvs switch -x)

Parameters:

reportEventType - New value of property reportEventType.

getTimeZone

public String getTimeZone()

Getter for property timeZone. (cvs switch -z)

Returns:

Value of property timeZone.

setTimeZone

public void setTimeZone(String timeZone)

Setter for property timeZone. (cvs switch -z)

Parameters:

timeZone - New value of property timeZone.

getLastEventForFile

public String[] getLastEventForFile()

Getter for property lastEventForFile. (cvs switch -f)

Returns:

Value of property lastEventForFile.

setLastEventForFile

public void setLastEventForFile(String[] lastEventForFile)

Setter for property lastEventForFile. (cvs switch -f)

Parameters:

lastEventForFile - New value of property lastEventForFile.

addLastEventForFile

public void addLastEventForFile(String newFile)

getReportOnModule

public String[] getReportOnModule()

Getter for property reportOnModule. (cvs switch -m)

Returns:

Value of property reportOnModule.

setReportOnModule

public void setReportOnModule(String[] reportOnModule)

Setter for property reportOnModule. (cvs switch -m)

Parameters:

reportOnModule - New value of property reportOnModule.

addReportOnModule

public void addReportOnModule(String newReportOnModule)

getReportLastEventForModule

public String[] getReportLastEventForModule()

Getter for property reportLastEventForModule. (cvs switch -n)

Returns:

Value of property reportLastEventForModule.

setReportLastEventForModule

public void setReportLastEventForModule(String[] reportLastEventForModule)

Setter for property reportLastEventForModule. (cvs switch -n)

Parameters:

reportLastEventForModule - New value of property reportLastEventForModule.

addReportLastEventForModule

public void addReportLastEventForModule(String newModule)

getForUsers

public String[] getForUsers()

Getter for property forUsers. (cvs switch -u)

Returns:

Value of property forUsers.

setForUsers

public void setForUsers(String[] forUsers)

Setter for property forUsers. (cvs switch -u)

Parameters:

forUsers - New value of property forUsers.

addForUsers

public void addForUsers(String forUser)