org.tmatesoft.svn.cli

Class AbstractSVNCommandEnvironment

java.lang.Object

org.tmatesoft.svn.cli.AbstractSVNCommandEnvironment

All Implemented Interfaces:

ISVNCanceller

Direct Known Subclasses:

SVNAdminCommandEnvironment, SVNCommandEnvironment, SVNDumpFilterCommandEnvironment, SVNLookCommandEnvironment, SVNSyncCommandEnvironment, SVNVersionCommandEnvironment

public abstract class AbstractSVNCommandEnvironment
extends Object
implements ISVNCanceller

Version:

1.3

Author:

TMate Software Ltd.

Field Summary

Fields inherited from interface org.tmatesoft.svn.core.ISVNCanceller

NULL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSVNCommandEnvironment(String programName, PrintStream out, PrintStream err, InputStream in)

Method Summary

Modifier and Type	Method and Description
void	checkCancelled() Checks if the current operation is cancelled (somehow interrupted) and should throw an SVNCancelException or notify the handler if exists.
List<String>	combineTargets(Collection targets, boolean warnReserved)
protected abstract ISVNAuthenticationManager	createClientAuthenticationManager()
SVNClientManager	createClientManager()
protected abstract DefaultSVNOptions	createClientOptions()
void	dispose()
List	getArguments()
SVNClientManager	getClientManager()
AbstractSVNCommand	getCommand()
protected abstract String	getCommandLineClientName()
String	getCommandName()
protected String	getCommandName(SVNCommandLine commandLine)
PrintStream	getErr()
InputStream	getIn()
DefaultSVNOptions	getOptions()
PrintStream	getOut()
String	getProgramName()
String	getRelativePath(File file)
SVNURL	getURLFromTarget(String target)
void	handleError(SVNErrorMessage err)
boolean	handleWarning(SVNErrorMessage err, SVNErrorCode[] warningCodes, boolean quiet)
void	init(SVNCommandLine commandLine)
void	initClientManager()
protected void	initCommand(SVNCommandLine commandLine)
protected abstract void	initOption(SVNOptionValue optionValue)
protected void	initOptions(SVNCommandLine commandLine)
boolean	isVersioned(String target)
SVNRevision[]	parseRevision(String revStr)
String	popArgument()
void	printCommitInfo(SVNCommitInfo info)
byte[]	readFromFile(File file)
protected abstract String	refineCommandName(String commandName, SVNCommandLine commandLine)
boolean	run()
protected void	setArguments(List newArguments)
void	setCancelled()
protected void	validateOptions(SVNCommandLine commandLine)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSVNCommandEnvironment

protected AbstractSVNCommandEnvironment(String programName,
                                        PrintStream out,
                                        PrintStream err,
                                        InputStream in)

Method Detail

getProgramName

public String getProgramName()

getOut

public PrintStream getOut()

getErr

public PrintStream getErr()

getIn

public InputStream getIn()

getClientManager

public SVNClientManager getClientManager()

getOptions

public DefaultSVNOptions getOptions()

getArguments

public List getArguments()

getCommand

public AbstractSVNCommand getCommand()

getCommandName

public String getCommandName()

popArgument

public String popArgument()

setArguments

protected void setArguments(List newArguments)

init

public void init(SVNCommandLine commandLine)
          throws SVNException

Throws:

SVNException

run

public boolean run()

initOptions

protected void initOptions(SVNCommandLine commandLine)
                    throws SVNException

Throws:

SVNException

initOption

protected abstract void initOption(SVNOptionValue optionValue)
                            throws SVNException

Throws:

SVNException

validateOptions

protected void validateOptions(SVNCommandLine commandLine)
                        throws SVNException

Throws:

SVNException

initCommand

protected void initCommand(SVNCommandLine commandLine)
                    throws SVNException

Throws:

SVNException

getCommandName

protected String getCommandName(SVNCommandLine commandLine)
                         throws SVNException

Throws:

SVNException

refineCommandName

protected abstract String refineCommandName(String commandName,
                                            SVNCommandLine commandLine)
                                     throws SVNException

Throws:

SVNException

createClientOptions

protected abstract DefaultSVNOptions createClientOptions()
                                                  throws SVNException

Throws:

SVNException

createClientAuthenticationManager

protected abstract ISVNAuthenticationManager createClientAuthenticationManager()

getCommandLineClientName

protected abstract String getCommandLineClientName()

initClientManager

public void initClientManager()
                       throws SVNException

Throws:

SVNException

dispose

public void dispose()

combineTargets

public List<String> combineTargets(Collection targets,
                                   boolean warnReserved)
                            throws SVNException

Throws:

SVNException

parseRevision

public SVNRevision[] parseRevision(String revStr)

readFromFile

public byte[] readFromFile(File file)
                    throws SVNException

Throws:

SVNException

handleError

public void handleError(SVNErrorMessage err)

handleWarning

public boolean handleWarning(SVNErrorMessage err,
                             SVNErrorCode[] warningCodes,
                             boolean quiet)
                      throws SVNException

Throws:

SVNException

getRelativePath

public String getRelativePath(File file)

getURLFromTarget

public SVNURL getURLFromTarget(String target)
                        throws SVNException

Throws:

SVNException

isVersioned

public boolean isVersioned(String target)
                    throws SVNException

Throws:

SVNException

printCommitInfo

public void printCommitInfo(SVNCommitInfo info)

checkCancelled

public void checkCancelled()
                    throws SVNCancelException

Description copied from interface: ISVNCanceller

Checks if the current operation is cancelled (somehow interrupted) and should throw an SVNCancelException or notify the handler if exists.

This method is often called during iterations when processing trees of versioned items. This way the entire operation may be interrupted without waiting till the iteration run out.

Specified by:

checkCancelled in interface ISVNCanceller

Throws:

SVNCancelException

setCancelled

public void setCancelled()

createClientManager

public SVNClientManager createClientManager()