org.netbeans.lib.cvsclient.command.tag

Class TagCommand

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.tag.TagCommand

All Implemented Interfaces:

Serializable, Cloneable, CVSListener

public class TagCommand
extends BasicCommand

The tag command adds or deleted a tag to the specified files/directories.

Author:

Thomas Singer

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
TagCommand() Construct a new tag 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 eventManager) Creates the TagBuilder.
boolean	doesCheckThatUnmodified() Deprecated.
boolean	doesDeleteTag() Deprecated.
boolean	doesMakeBranchTag() Deprecated.
boolean	doesOverrideExistingTag() Deprecated.
void	execute(ClientServices client, EventManager eventManager) Execute the command.
String	getCVSArguments() Returns the arguments of the command in the command-line style.
String	getCVSCommand() This method returns how the tag command would looklike when typed on the command line.
String	getOptString() String returned by this method defines which options are available for this command.
String	getTag() Returns the tag that should be added or deleted.
String	getTagByDate() Returns the latest date of a revision to be tagged.
String	getTagByRevision() Sets the latest date of a revision to be tagged.
boolean	isCheckThatUnmodified() Returns true if checking for unmodified files is enabled.
boolean	isDeleteTag() Returnes true if the tag should be deleted (otherwise added).
boolean	isMakeBranchTag() Returns true if the tag should be a branch tag.
boolean	isMatchHeadIfRevisionNotFound()
boolean	isOverrideExistingTag() Returns true to indicate that existing tag will be overridden.
void	resetCVSCommand() Resets all switches in the command.
void	setCheckThatUnmodified(boolean checkThatUnmodified) Enabled the check for unmodified files.
boolean	setCVSCommand(char opt, String optArg) Takes the arguments and sets the command.
void	setDeleteTag(boolean deleteTag) Sets whether the tag should be deleted (true) or added (false).
void	setMakeBranchTag(boolean makeBranchTag) Sets whether the tag should be a branch tag.
void	setMatchHeadIfRevisionNotFound(boolean matchHeadIfRevisionNotFound)
void	setOverrideExistingTag(boolean overrideExistingTag) Sets whether existing tags should be overridden.
void	setTag(String tag) Sets the tag that should be added or deleted.
void	setTagByDate(String tagDate) Sets the latest date of a revision to be tagged.
void	setTagByRevision(String tagRevision) Sets the latest date of a revision to be tagged.

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TagCommand

public TagCommand()

Construct a new tag command.

Method Detail

createBuilder

public Builder createBuilder(EventManager eventManager)

Creates the TagBuilder.

Overrides:

createBuilder in class BuildableCommand

Parameters:

eventManager - the event manager used to received cvs events

doesCheckThatUnmodified

@Deprecated
public boolean doesCheckThatUnmodified()

Deprecated.

Returns true if checking for unmodified files is enabled.

isCheckThatUnmodified

public boolean isCheckThatUnmodified()

Returns true if checking for unmodified files is enabled.

setCheckThatUnmodified

public void setCheckThatUnmodified(boolean checkThatUnmodified)

Enabled the check for unmodified files.

doesDeleteTag

@Deprecated
public boolean doesDeleteTag()

Deprecated.

Returnes true if the tag should be deleted (otherwise added).

isDeleteTag

public boolean isDeleteTag()

Returnes true if the tag should be deleted (otherwise added).

setDeleteTag

public void setDeleteTag(boolean deleteTag)

Sets whether the tag should be deleted (true) or added (false).

doesMakeBranchTag

@Deprecated
public boolean doesMakeBranchTag()

Deprecated.

Returns true if the tag should be a branch tag.

isMakeBranchTag

public boolean isMakeBranchTag()

Returns true if the tag should be a branch tag.

setMakeBranchTag

public void setMakeBranchTag(boolean makeBranchTag)

Sets whether the tag should be a branch tag.

doesOverrideExistingTag

@Deprecated
public boolean doesOverrideExistingTag()

Deprecated.

Returns true to indicate that existing tag will be overridden.

isOverrideExistingTag

public boolean isOverrideExistingTag()

Returns true to indicate that existing tag will be overridden.

setOverrideExistingTag

public void setOverrideExistingTag(boolean overrideExistingTag)

Sets whether existing tags should be overridden.

isMatchHeadIfRevisionNotFound

public boolean isMatchHeadIfRevisionNotFound()

setMatchHeadIfRevisionNotFound

public void setMatchHeadIfRevisionNotFound(boolean matchHeadIfRevisionNotFound)

getTag

public String getTag()

Returns the tag that should be added or deleted.

setTag

public void setTag(String tag)

Sets the tag that should be added or deleted.

getTagByDate

public String getTagByDate()

Returns the latest date of a revision to be tagged.

Returns:

date value. the latest Revision not later ten date is tagged.

setTagByDate

public void setTagByDate(String tagDate)

Sets the latest date of a revision to be tagged.

Parameters:

tagDate - New value of property tagDate.

getTagByRevision

public String getTagByRevision()

Sets the latest date of a revision to be tagged. Can be both a number and a tag.

Returns:

Value of property tagRevision.

setTagByRevision

public void setTagByRevision(String tagRevision)

Sets the latest date of a revision to be tagged. Can be both a number and a tag.

Parameters:

tagRevision - New value of property tagRevision.

execute

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

Execute the 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

getCVSCommand

public String getCVSCommand()

This method returns how the tag command would looklike when typed on the command line.

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