org.netbeans.lib.cvsclient.command.importcmd

Class ImportCommand

java.lang.Object

org.netbeans.lib.cvsclient.command.Command

org.netbeans.lib.cvsclient.command.BuildableCommand

org.netbeans.lib.cvsclient.command.importcmd.ImportCommand

All Implemented Interfaces:

Serializable, Cloneable, CVSListener

public class ImportCommand
extends BuildableCommand

The import command imports local directory structures into the repository.

Author:

Thomas Singer

See Also:

Serialized Form

Field Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addIgnoredFile(String ignoredFileName) Add a file name that is to be ignored by the import.
void	addWrapper(String filenamePattern, KeywordSubstitutionOptions keywordSubstitutionOptions)
void	addWrapper(StringPattern filenamePattern, KeywordSubstitutionOptions keywordSubstitutionOptions)
Builder	createBuilder(EventManager eventManager) Creates the ImportBuilder.
void	execute(ClientServices client, EventManager eventManager) Executes thiz command using the set options.
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.
List<String>	getIgnoreFiles() Get a list of files that are ignored by import.
String	getImportDirectory()
KeywordSubstitutionOptions	getKeywordSubstitutionOptions() Returns the keyword substitution option.
String	getLogMessage() Returns the log message.
String	getModule() Returns the module (the in-repository path, where the files should be stored.
String	getOptString() Returns a String that defines which options are available for this particular command.
String	getReleaseTag() Returns the release tag.
String	getVendorBranch() Returns the vendor branch.
String	getVendorTag() Returns the vendor tag.
Map<StringPattern,KeywordSubstitutionOptions>	getWrappers() Returns a map with all wrappers.
boolean	isUseFileModifTime() Tells, whether the file modification time is to be used as the time of the import.
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	setImportDirectory(String directory) Pints to directoty to import.
void	setKeywordSubstitutionOptions(KeywordSubstitutionOptions keywordSubstitutionOptions) Sets the keywords substitution option.
void	setLogMessage(String logMessage) Sets the log message.
void	setModule(String module) Sets the module (the in-repository path, where the files should be stored).
void	setReleaseTag(String releaseTag) Sets the necessary release tag.
void	setUseFileModifTime(boolean useFileModifTime) Sets whether the file modification time is to be used as the time of the import.
void	setVendorBranch(String vendorBranch) Sets the vendor branch.
void	setVendorTag(String vendorTag) Sets the necessary vendor tag.
void	setWrappers(Map<StringPattern,KeywordSubstitutionOptions> wrapperMap) Compliant method to addWrapper.

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

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

ImportCommand

public ImportCommand()

Method Detail

addWrapper

public void addWrapper(String filenamePattern,
              KeywordSubstitutionOptions keywordSubstitutionOptions)

addWrapper

public void addWrapper(StringPattern filenamePattern,
              KeywordSubstitutionOptions keywordSubstitutionOptions)

setWrappers

public void setWrappers(Map<StringPattern,KeywordSubstitutionOptions> wrapperMap)

Compliant method to addWrapper. It replaces the whole list of cvswrappers. The Map's structure should be following: Key: instance of StringPattern(fileName wildpattern) Value: instance of KeywordSubstitutionOptions

getWrappers

public Map<StringPattern,KeywordSubstitutionOptions> getWrappers()

Returns a map with all wrappers. For map descriptions see setWrapper()

getKeywordSubstitutionOptions

public KeywordSubstitutionOptions getKeywordSubstitutionOptions()

Returns the keyword substitution option.

setKeywordSubstitutionOptions

public void setKeywordSubstitutionOptions(KeywordSubstitutionOptions keywordSubstitutionOptions)

Sets the keywords substitution option.

getReleaseTag

public String getReleaseTag()

Returns the release tag.

setReleaseTag

public void setReleaseTag(String releaseTag)

Sets the necessary release tag.

getLogMessage

public String getLogMessage()

Returns the log message.

setLogMessage

public void setLogMessage(String logMessage)

Sets the log message.

getModule

public String getModule()

Returns the module (the in-repository path, where the files should be stored.

setModule

public void setModule(String module)

Sets the module (the in-repository path, where the files should be stored).

setImportDirectory

public void setImportDirectory(String directory)

Pints to directoty to import.

getImportDirectory

public String getImportDirectory()

getVendorBranch

public String getVendorBranch()

Returns the vendor branch.

setVendorBranch

public void setVendorBranch(String vendorBranch)

Sets the vendor branch. If null is set, the default branch 1.1.1 is used automatically.

getVendorTag

public String getVendorTag()

Returns the vendor tag.

setVendorTag

public void setVendorTag(String vendorTag)

Sets the necessary vendor tag.

isUseFileModifTime

public boolean isUseFileModifTime()

Tells, whether the file modification time is to be used as the time of the import.

setUseFileModifTime

public void setUseFileModifTime(boolean useFileModifTime)

Sets whether the file modification time is to be used as the time of the import.

getIgnoreFiles

public List<String> getIgnoreFiles()

Get a list of files that are ignored by import.

addIgnoredFile

public void addIgnoredFile(String ignoredFileName)

Add a file name that is to be ignored by the import.

execute

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

Executes thiz command using the set options.

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

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

Overrides:

createBuilder in class BuildableCommand