Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

java.gate.versioning.cmdline
Class SvnRepository

java.lang.Object
  java.gate.versioning.cmdline.AbstractRepository
      java.gate.versioning.cmdline.SvnRepository

class SvnRepository
extends AbstractRepository

SVN repository implementation. The public API of this class is documented on the Repository interface.

see:
gate.versioning.cmdline.Repository

Field Summary
private boolean DEBUG

Debug flag.

 
Fields inherited from class AbstractRepository
DEBUG, commandOutput, nl, root, stderrOutput, stdoutOutput, workingDir
 
Constructor Summary
SvnRepository()

 
Method Summary
boolean add(String fileName)

Add to the repository.

boolean checkin(String fileName, String message)

Commit changes.

boolean create(String dirName)

Create a new repository filetree (i.e. not a new object but a new database/filesystem on disk).

boolean delete(String fileName)

Delete from the repository.

String diff(String fileName)

Get the difference with the repository version.

boolean exists(String moduleName)

Check for the existence of a module (i.e. top-level directory).

String getCommandName()

Returns "svn".

protected List getPostCommand(String fileName, boolean noRoot)

Get the post-subcommand elements of the command (e.g. root).

protected List getPreCommand()

Get the pre-subcommand elements of the command (e.g.

boolean importDir(String dirName)

Import a directory.

boolean isModified(String fileName)

Use the repository's status command to figure out if the file has been locally modified.

boolean isOutOfDate(String fileName)

Use the repository's status command to figure out if the file is out-of-date.

boolean isUnknown(String fileName)

Use the repository's status command to figure out if the file is unknown.

void setRoot(String root)

The root / URL of the repository.

String status(String fileName)

Status.

boolean update(String fileName)

Update.

 
Methods inherited from class AbstractRepository
add, buildCommandArray, buildCommandArray, checkin, checkin, checkout, delete, diff, getCommandName, getCommandOutput, getCommandStderr, getCommandStdout, getPostCommand, getPreCommand, getRepository, getRoot, init, runCommand, runCommand, setRoot, setWorkingDir, status, update
 

Field Detail

DEBUG

private boolean DEBUG
Debug flag.

 
Constructor Detail

SvnRepository

SvnRepository()

 
Method Detail

add

public boolean add(String fileName)
Add to the repository.
param:
fileName the file or directory to work on (should be relative to the repository's working directory, and use "/" as a path separator).
return:
boolean representing success or failure.

checkin

public boolean checkin(String fileName, String message)
Commit changes.
param:
fileName the file or directory to work on (should be relative to the repository's working directory, and use "/" as a path separator).
param:
message a commit message.
return:
boolean representing success or failure.

create

public boolean create(String dirName)
Create a new repository filetree (i.e. not a new object but a new database/filesystem on disk). This method can be called before #init (so that we can create repositories without having an existing one).
param:
dirName the directory to work on, which will be created (should be an absolute path).
return:
boolean representing success or failure.

delete

public boolean delete(String fileName)
Delete from the repository.
param:
fileName the file or directory to work on (should be relative to the repository's working directory, and use "/" as a path separator).
return:
boolean representing success or failure.

diff

public String diff(String fileName)
Get the difference with the repository version.
param:
fileName the file or directory to work on (should be relative to the repository's working directory, and use "/" as a path separator).
return:
a string containing the difference, or "" for no difference, or null for error.

exists

public boolean exists(String moduleName)
Check for the existence of a module (i.e. top-level directory).
param:
moduleName directory to look for.
return:
boolean giving status indication.

getCommandName

public String getCommandName()
Returns "svn".

getPostCommand

protected List getPostCommand(String fileName, boolean noRoot)
Get the post-subcommand elements of the command (e.g. root).

getPreCommand

protected List getPreCommand()
Get the pre-subcommand elements of the command (e.g. -d root).

importDir

public boolean importDir(String dirName)
Import a directory.
param:
dirName the directory to import (this must exist).
return:
boolean representing success or failure.
throws:
GateException when the directory doesn't exist.

isModified

public boolean isModified(String fileName)
Use the repository's status command to figure out if the file has been locally modified.
param:
fileName the file or directory to work on (should be relative to the repository's working directory, and use "/" as a path separator).
return:
boolean giving status indication.

isOutOfDate

public boolean isOutOfDate(String fileName)
Use the repository's status command to figure out if the file is out-of-date.
param:
fileName the file or directory to work on (should be relative to the repository's working directory, and use "/" as a path separator).
return:
boolean giving status indication.

isUnknown

public boolean isUnknown(String fileName)
Use the repository's status command to figure out if the file is unknown.
param:
fileName the file or directory to work on (should be relative to the repository's working directory, and use "/" as a path separator).
return:
boolean giving status indication.

setRoot

public void setRoot(String root)
The root / URL of the repository. SVN doesn't like backslash here (at least on version 1.2.3 Windoze build run from cygwin or via Runtime.exec), so substitute them all for slash.

status

public String status(String fileName)
Status.
param:
fileName the file or directory to work on (should be relative to the repository's working directory, and use "/" as a path separator).
return:
String giving status ouput.

update

public boolean update(String fileName)
Update.
param:
fileName the file or directory to work on (should be relative to the repository's working directory, and use "/" as a path separator).
return:
boolean representing success or failure.

 

Groovy Documentation