org.netbeans.lib.cvsclient.command.export

Class ExportCommand

java.lang.Object

org.netbeans.lib.cvsclient.command.Command

org.netbeans.lib.cvsclient.command.BuildableCommand

org.netbeans.lib.cvsclient.command.RepositoryCommand

org.netbeans.lib.cvsclient.command.export.ExportCommand

All Implemented Interfaces:

Serializable, Cloneable, CVSListener

public class ExportCommand
extends RepositoryCommand

The export command exports the projects (modules in the repository) to the local directory structure.

Author:

MIlos Kleint

See Also:

Serialized Form

Field Summary

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

clientServices, expandedModules, modules, 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
ExportCommand()

Method Summary

Methods

Modifier and Type	Method and Description
Builder	createBuilder(EventManager eventManager) Creates the ExportBuilder.
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	getExportByDate() Getter for property exportByDate.
String	getExportByRevision() Getter for property exportByRevision.
String	getExportDirectory() Getter for property exportDirectory.
KeywordSubstitutionOptions	getKeywordSubstitutionOptions() Returns the keyword substitution option.
String	getOptString() Returns a String that defines which options are available for this particular command.
boolean	isNotRunModuleProgram() Getter for property notRunModuleProgram.
boolean	isNotShortenPaths() Getter for property notShortenPaths.
boolean	isPruneDirectories() Get whether to prune directories.
boolean	isUseHeadIfNotFound() Getter for property useHeadIfNotFound.
void	messageSent(MessageEvent e) Called when the server wants to send a message to be displayed to the user.
protected void	postExpansionExecute(ClientServices client, EventManager em) Execute this command
void	resetCVSCommand() Resets all switches in the command to the default behaviour.
boolean	setCVSCommand(char opt, String optArg) Takes the arguments and sets the command.
void	setExportByDate(String exportByDate) Setter for property exportByDate.
void	setExportByRevision(String exportByRevision) Setter for property exportByRevision.
void	setExportDirectory(String exportDirectory) Setter for property exportDirectory.
void	setKeywordSubstitutionOptions(KeywordSubstitutionOptions keywordSubstitutionOptions) Sets the keywords substitution option.
void	setNotRunModuleProgram(boolean notRunModuleProgram) Setter for property notRunModuleProgram.
void	setNotShortenPaths(boolean notShortenPaths) Setter for property notShortenPaths.
void	setPruneDirectories(boolean pruneDirectories) Set whether to prune directories.
void	setUseHeadIfNotFound(boolean useHeadIfNotFound) Setter for property useHeadIfNotFound.

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

addArgumentRequest, addArgumentRequests, addModule, addRequest, addRequestForWorkingDirectory, appendModuleArguments, clearModules, execute, getModules, isRecursive, moduleExpanded, setModules, setRecursive

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

commandTerminated, isBuilderSet, 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, setDisplayName, setLocalDirectory

Methods inherited from class java.lang.Object

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

Constructor Detail

ExportCommand

public ExportCommand()

Method Detail

getKeywordSubstitutionOptions

public KeywordSubstitutionOptions getKeywordSubstitutionOptions()

Returns the keyword substitution option.

setKeywordSubstitutionOptions

public void setKeywordSubstitutionOptions(KeywordSubstitutionOptions keywordSubstitutionOptions)

Sets the keywords substitution option.

setPruneDirectories

public void setPruneDirectories(boolean pruneDirectories)

Set whether to prune directories. This is the -P option in the command-line CVS.

isPruneDirectories

public boolean isPruneDirectories()

Get whether to prune directories.

Returns:

true if directories should be removed if they contain no files, false otherwise.

postExpansionExecute

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

Execute this command

Specified by:

postExpansionExecute in class RepositoryCommand

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

getCVSCommand

public 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 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,
                    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 String getOptString()

Description copied from class: Command

Returns a String that defines which options are available for this particular command.

Specified by:

getOptString in class Command

createBuilder

public Builder createBuilder(EventManager eventManager)

Creates the ExportBuilder.

Overrides:

createBuilder in class BuildableCommand

messageSent

public void messageSent(MessageEvent e)

Called when the server wants to send a message to be displayed to the user. The message is only for information purposes and clients can choose to ignore these messages if they wish.

Specified by:

messageSent in interface CVSListener

Overrides:

messageSent in class BuildableCommand

Parameters:

e - the event

getExportByDate

public String getExportByDate()

Getter for property exportByDate.

Returns:

Value of property exportByDate.

setExportByDate

public void setExportByDate(String exportByDate)

Setter for property exportByDate.

Parameters:

exportByDate - New value of property exportByDate.

getExportByRevision

public String getExportByRevision()

Getter for property exportByRevision.

Returns:

Value of property exportByRevision.

setExportByRevision

public void setExportByRevision(String exportByRevision)

Setter for property exportByRevision.

Parameters:

exportByRevision - New value of property exportByRevision.

getExportDirectory

public String getExportDirectory()

Getter for property exportDirectory.

Returns:

Value of property exportDirectory.

setExportDirectory

public void setExportDirectory(String exportDirectory)

Setter for property exportDirectory.

Parameters:

exportDirectory - New value of property exportDirectory.

isUseHeadIfNotFound

public boolean isUseHeadIfNotFound()

Getter for property useHeadIfNotFound.

Returns:

Value of property useHeadIfNotFound.

setUseHeadIfNotFound

public void setUseHeadIfNotFound(boolean useHeadIfNotFound)

Setter for property useHeadIfNotFound.

Parameters:

useHeadIfNotFound - New value of property useHeadIfNotFound.

isNotShortenPaths

public boolean isNotShortenPaths()

Getter for property notShortenPaths.

Returns:

Value of property notShortenPaths.

setNotShortenPaths

public void setNotShortenPaths(boolean notShortenPaths)

Setter for property notShortenPaths.

Parameters:

notShortenPaths - New value of property notShortenPaths.

isNotRunModuleProgram

public boolean isNotRunModuleProgram()

Getter for property notRunModuleProgram.

Returns:

Value of property notRunModuleProgram.

setNotRunModuleProgram

public void setNotRunModuleProgram(boolean notRunModuleProgram)

Setter for property notRunModuleProgram.

Parameters:

notRunModuleProgram - New value of property notRunModuleProgram.