org.netbeans.lib.cvsclient.command

Class BasicCommand

java.lang.Object

org.netbeans.lib.cvsclient.command.Command

org.netbeans.lib.cvsclient.command.BuildableCommand

org.netbeans.lib.cvsclient.command.BasicCommand

All Implemented Interfaces:

java.lang.Cloneable, CVSListener

Direct Known Subclasses:

AnnotateCommand, CheckoutCommand, CommitCommand, DiffCommand, EditCommand, EditorsCommand, LogCommand, RannotateCommand, RemoveCommand, RlogCommand, StatusCommand, TagCommand, UneditCommand, UpdateCommand, WatchCommand, WatchersCommand

public abstract class BasicCommand
extends BuildableCommand

A class that provides common functionality for many of the CVS command that send similar sequences of requests.

Author:

Robert Greig

Constructor Summary

Constructors

Constructor and Description
BasicCommand()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(ClientServices client, EventManager em) Execute a command.
java.io.File	getFileEndingWith(java.lang.String ending)
java.io.File[]	getFiles() Get the files and/or directories specified for this command to operate on.
boolean	getRecursive() Deprecated. use isRecursive instead
java.io.File	getXthFile(int index) Get a single file from the "files" list. returns only files, not directories.
boolean	isRecursive() Gets the value of the recursive option.
void	setFiles(java.io.File[] theFiles) Set the files and/or directories on which to execute the command.
void	setRecursive(boolean recursive) Sets the value of the recursive option.

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

commandTerminated, createBuilder, messageSent, messageSent, setBuilder

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

clone, fileAdded, fileInfoGenerated, fileRemoved, fileToRemove, fileUpdated, getCVSArguments, getCVSCommand, getDisplayName, getGlobalOptions, getLocalDirectory, getLocalPath, getOptString, getRelativeToLocalPathInUnixStyle, hasFailed, moduleExpanded, resetCVSCommand, setCVSCommand, setDisplayName

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicCommand

public BasicCommand()

Method Detail

getRecursive

public boolean getRecursive()

Deprecated. use isRecursive instead

Gets the value of the recursive option.

Returns:

true if recursive, false if not

isRecursive

public boolean isRecursive()

Gets the value of the recursive option.

Returns:

true if recursive, false if not

setRecursive

public void setRecursive(boolean recursive)

Sets the value of the recursive option.

Parameters:

recursive - true if the command should recurse, false otherwise

setFiles

public void setFiles(java.io.File[] theFiles)

Set the files and/or directories on which to execute the command. The way these are processed is:

• Default action (i.e. not setting the files explicitly or setting them to

  null

  ) is to use the directory in which the command was executed (see how directories are treated, below)
• Files are handled how you would expect
• For directories, all files within the directory are sent

Parameters:

theFiles - the files to operate on. May be null to indicate that the local directory specified in the client should be used. Full, absolute canonical pathnames must be supplied.

getFiles

public java.io.File[] getFiles()

Get the files and/or directories specified for this command to operate on.

Returns:

the array of Files

getXthFile

public java.io.File getXthFile(int index)

Get a single file from the "files" list. returns only files, not directories. This method is used from within the builders, because for single file requests, the cvs server doesn't return us enough information to identify what file has been returned. Thus we sort the "files" array (files come before directories. Then the response froms erver comes in the same order and the files can be found this way.

Parameters:

index - the index of the file in the list.

getFileEndingWith

public java.io.File getFileEndingWith(java.lang.String ending)

Parameters:

ending - - the ending part of the file's pathname.. path separator is cvs's default '/'

execute

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

Execute a command. This implementation sends a Root request, followed by as many Directory and Entry requests as is required by the recurse setting and the file arguments that have been set. Subclasses should call this first, and tag on the end of the requests list any further requests and, finally, the actually request that does the command (e.g.

update

,

status

etc.)

Overrides:

execute in class BuildableCommand

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