org.netbeans.lib.cvsclient.command

Class RepositoryCommand

java.lang.Object

org.netbeans.lib.cvsclient.command.Command

org.netbeans.lib.cvsclient.command.BuildableCommand

org.netbeans.lib.cvsclient.command.RepositoryCommand

All Implemented Interfaces:

Serializable, Cloneable, CVSListener

Direct Known Subclasses:

ExportCommand, RtagCommand

public abstract class RepositoryCommand
extends BuildableCommand

A class that provides common functionality for CVS commands that operate upon the repository.

Author:

Martin Entlicher

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ClientServices	clientServices The client services that are provided to this command.
protected List<String>	expandedModules The expanded modules.
protected List<String>	modules The modules to process.
protected List<Request>	requests The requests that are sent and processed.

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
RepositoryCommand()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addArgumentRequest(boolean value, String argument) If the specified value is true, add a ArgumentRequest for the specified argument.
protected void	addArgumentRequests() Add the argument requests.
void	addModule(String module) Add a module to process.
protected void	addRequest(Request request) Adds the specified request to the request list.
protected void	addRequestForWorkingDirectory(ClientServices clientServices) Adds the request for the current working directory.
protected void	appendModuleArguments(StringBuffer buffer) Appends the file's names to the specified buffer.
void	clearModules() Clear the list of modules.
void	execute(ClientServices client, EventManager em) Execute this command.
String[]	getModules() Get the array of modules that are set to be processed.
boolean	isRecursive() Gets the value of the recursive option.
void	moduleExpanded(ModuleExpansionEvent e) This is called when the server has responded to an expand-modules request.
protected abstract void	postExpansionExecute(ClientServices client, EventManager em) Execute this command
void	setModules(String[] modules) Set the modules to process.
void	setRecursive(boolean recursive) Sets the value of the recursive option.

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

commandTerminated, createBuilder, isBuilderSet, 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, getTrimmedString, hasFailed, resetCVSCommand, setCVSCommand, setDisplayName, setLocalDirectory

Methods inherited from class java.lang.Object

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

Field Detail

requests

protected List<Request> requests

The requests that are sent and processed.

clientServices

protected ClientServices clientServices

The client services that are provided to this command.

modules

protected final List<String> modules

The modules to process. These names are unexpanded and will be passed to a module-expansion request.

expandedModules

protected final List<String> expandedModules

The expanded modules.

Constructor Detail

RepositoryCommand

public RepositoryCommand()

Method Detail

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:

r - true if the command should recurse, false otherwise

addModule

public void addModule(String module)

Add a module to process.

Parameters:

module - the name of the module to process

setModules

public void setModules(String[] modules)

Set the modules to process.

Parameters:

modules - the names of the modules to process

getModules

public String[] getModules()

Get the array of modules that are set to be processed.

clearModules

public void clearModules()

Clear the list of modules.

addArgumentRequests

protected final void addArgumentRequests()

Add the argument requests. The argument requests are created using the expanded set of modules passed in. Subclasses of this class should call this method at the appropriate point in their postExpansionExecute() method. Note that arguments are appended to the list.

moduleExpanded

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

execute

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

Execute this command. This method sends the ExpandModulesRequest in order to expand the modules that were set. The actual execution is performed by postExpansionExecute(org.netbeans.lib.cvsclient.ClientServices, org.netbeans.lib.cvsclient.event.EventManager) method.

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

postExpansionExecute

protected abstract void postExpansionExecute(ClientServices client,
                        EventManager em)
                                      throws CommandException,
                                             AuthenticationException

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

addRequest

protected final void addRequest(Request request)

Adds the specified request to the request list.

addRequestForWorkingDirectory

protected final void addRequestForWorkingDirectory(ClientServices clientServices)
                                            throws IOException

Adds the request for the current working directory.

Throws:

IOException

addArgumentRequest

protected final void addArgumentRequest(boolean value,
                      String argument)

If the specified value is true, add a ArgumentRequest for the specified argument.

appendModuleArguments

protected final void appendModuleArguments(StringBuffer buffer)

Appends the file's names to the specified buffer.