public class FSCommitEditor extends java.lang.Object implements ISVNEditor
Modifier and Type | Class and Description |
---|---|
private static class |
FSCommitEditor.DirBaton |
Modifier and Type | Field and Description |
---|---|
private boolean |
isTxnOwner |
private java.lang.String |
myAuthor |
private java.lang.String |
myBasePath |
private FSCommitter |
myCommitter |
private java.lang.String |
myCurrentFilePath |
private SVNProperties |
myCurrentFileProps |
private FSDeltaConsumer |
myDeltaConsumer |
private java.util.Stack<FSCommitEditor.DirBaton> |
myDirsStack |
private FSFS |
myFSFS |
private java.util.Collection<java.lang.String> |
myLockTokens |
private java.util.Map<java.lang.String,java.lang.String> |
myPathsToLockTokens |
private FSRepository |
myRepository |
private SVNProperties |
myRevProps |
private FSTransactionInfo |
myTxn |
private FSTransactionRoot |
myTxnRoot |
Constructor and Description |
---|
FSCommitEditor(java.lang.String path,
java.util.Map<java.lang.String,java.lang.String> lockTokens,
boolean keepLocks,
FSTransactionInfo txn,
FSFS owner,
FSRepository repository,
SVNProperties revProps) |
FSCommitEditor(java.lang.String path,
java.lang.String logMessage,
java.lang.String userName,
java.util.Map<java.lang.String,java.lang.String> lockTokens,
boolean keepLocks,
FSTransactionInfo txn,
FSFS owner,
FSRepository repository) |
Modifier and Type | Method and Description |
---|---|
void |
abortEdit()
Aborts the current running editor due to errors occured.
|
void |
absentDir(java.lang.String path)
Indicates that a path is present as a subdirectory in the edit source,
but can not be conveyed to the edit consumer (perhaps because of
authorization restrictions).
|
void |
absentFile(java.lang.String path)
Indicates that a path is present as a file in the edit source,
but can not be conveyed to the edit consumer (perhaps because of
authorization restrictions).
|
void |
addDir(java.lang.String path,
java.lang.String copyFromPath,
long copyFromRevision)
Adds a directory.
|
void |
addFile(java.lang.String path,
java.lang.String copyFromPath,
long copyFromRevision)
Adds a file.
|
void |
applyTextDelta(java.lang.String path,
java.lang.String baseChecksum)
Starts applying text delta(s) to an opened file.
|
void |
changeDirProperty(java.lang.String name,
SVNPropertyValue value)
Changes the value of a property of the currently opened/added directory.
|
void |
changeFileProperty(java.lang.String path,
java.lang.String name,
SVNPropertyValue value)
Changes the value of a property of the currently opened/added file.
|
private void |
changeNodeProperties(java.lang.String path,
SVNProperties propNamesToValues) |
void |
closeDir()
Closes the currently opened directory fixing all changes of its
properties and/or entries.
|
SVNCommitInfo |
closeEdit()
Closes this editor finalizing the whole operation the editor
was used for.
|
void |
closeFile(java.lang.String path,
java.lang.String textChecksum)
Closes the opened file fixing all properties and/or contents changes.
|
void |
deleteEntry(java.lang.String path,
long revision)
Deletes an entry.
|
private void |
flushPendingProperties() |
private java.lang.String |
getAuthor() |
private FSDeltaConsumer |
getDeltaConsumer() |
private SVNProperties |
getFilePropertiesStorage() |
void |
openDir(java.lang.String path,
long revision)
Opens a directory.
|
void |
openFile(java.lang.String path,
long revision)
Opens a file.
|
void |
openRoot(long revision)
Opens the root directory on which the operation was invoked.
|
private void |
releaseLocks() |
private void |
releaseLocks(java.util.Map<java.lang.String,java.lang.String> pathsToLockTokens,
boolean breakLocks,
boolean runHooks) |
void |
targetRevision(long revision)
Sets the target revision the operation is running for.
|
java.io.OutputStream |
textDeltaChunk(java.lang.String path,
SVNDiffWindow diffWindow)
Collects a next delta chunk.
|
void |
textDeltaEnd(java.lang.String path)
Finalizes collecting text delta(s).
|
private java.util.Map<java.lang.String,java.lang.String> myPathsToLockTokens
private java.util.Collection<java.lang.String> myLockTokens
private java.lang.String myBasePath
private FSTransactionInfo myTxn
private FSTransactionRoot myTxnRoot
private boolean isTxnOwner
private FSFS myFSFS
private FSRepository myRepository
private java.util.Stack<FSCommitEditor.DirBaton> myDirsStack
private FSDeltaConsumer myDeltaConsumer
private SVNProperties myCurrentFileProps
private java.lang.String myCurrentFilePath
private FSCommitter myCommitter
private SVNProperties myRevProps
private java.lang.String myAuthor
public FSCommitEditor(java.lang.String path, java.lang.String logMessage, java.lang.String userName, java.util.Map<java.lang.String,java.lang.String> lockTokens, boolean keepLocks, FSTransactionInfo txn, FSFS owner, FSRepository repository)
public FSCommitEditor(java.lang.String path, java.util.Map<java.lang.String,java.lang.String> lockTokens, boolean keepLocks, FSTransactionInfo txn, FSFS owner, FSRepository repository, SVNProperties revProps)
public void targetRevision(long revision) throws SVNException
ISVNEditor
targetRevision
in interface ISVNEditor
revision
- a revision numberSVNException
public void openRoot(long revision) throws SVNException
ISVNEditor
ISVNEditor.closeDir()
.openRoot
in interface ISVNEditor
revision
- the revision number of the root directorySVNException
private java.lang.String getAuthor()
public void openDir(java.lang.String path, long revision) throws SVNException
ISVNEditor
openDir
in interface ISVNEditor
path
- a directory path relative to the root
directory opened by openRoot()
revision
- the revision of the directorySVNException
public void deleteEntry(java.lang.String path, long revision) throws SVNException
ISVNEditor
In a commit - deletes an entry from a repository. In an update - deletes an entry locally (since it has been deleted in the repository). In a status - informs that an entry has been deleted.
deleteEntry
in interface ISVNEditor
path
- an entry path relative to the root
directory opened by openRoot()
revision
- the revision number of path
SVNException
public void absentDir(java.lang.String path) throws SVNException
ISVNEditor
absentDir
in interface ISVNEditor
path
- a dir path relative to the root
directory opened by openRoot()
SVNException
public void absentFile(java.lang.String path) throws SVNException
ISVNEditor
absentFile
in interface ISVNEditor
path
- a file path relative to the root
directory opened by openRoot()
SVNException
public void addDir(java.lang.String path, java.lang.String copyFromPath, long copyFromRevision) throws SVNException
ISVNEditor
In a commit - adds a new directory to a repository. In an update - locally adds a directory that was added in the repository. In a status - informs about a new directory scheduled for addition.
If copyFromPath
is not null then it says
that path
is copied from copyFromPath
located in
copyFromRevision
.
addDir
in interface ISVNEditor
path
- a directory path relative to the root
directory opened by openRoot()
copyFromPath
- an ancestor of the added directorycopyFromRevision
- the revision of the ancestorSVNException
public void changeDirProperty(java.lang.String name, SVNPropertyValue value) throws SVNException
ISVNEditor
changeDirProperty
in interface ISVNEditor
name
- the name of a property to be changedvalue
- new property valueSVNException
ISVNEditor.openDir(String, long)
private void changeNodeProperties(java.lang.String path, SVNProperties propNamesToValues) throws SVNException
SVNException
public void closeDir() throws SVNException
ISVNEditor
closeDir
in interface ISVNEditor
SVNException
public void addFile(java.lang.String path, java.lang.String copyFromPath, long copyFromRevision) throws SVNException
ISVNEditor
In a commit - adds a new file to a repository. In an update - locally adds a file that was added in the repository. In a status - informs about a new file scheduled for addition.
If copyFromPath
is not null then it says
that path
is copied from copyFromPath
located in
copyFromRevision
.
addFile
in interface ISVNEditor
path
- a file path relative to the root
directory opened by openRoot()
copyFromPath
- an ancestor of the added filecopyFromRevision
- the revision of the ancestorSVNException
public void openFile(java.lang.String path, long revision) throws SVNException
ISVNEditor
openFile
in interface ISVNEditor
path
- a file path relative to the root
directory opened by openRoot()
revision
- the revision of the fileSVNException
public void applyTextDelta(java.lang.String path, java.lang.String baseChecksum) throws SVNException
ISVNDeltaConsumer
applyTextDelta
in interface ISVNDeltaConsumer
path
- a file path relative to the edit root
directorybaseChecksum
- an MD5 checksum for the base file contents (before the
file is changed)SVNException
- if the calculated base file checksum didn't match the expected
baseChecksum
public java.io.OutputStream textDeltaChunk(java.lang.String path, SVNDiffWindow diffWindow) throws SVNException
ISVNDeltaConsumer
If there are more than one windows for the file, this method is called several times.
textDeltaChunk
in interface ISVNDeltaConsumer
path
- a file path relative to the edit root
directorydiffWindow
- a next diff windowSVNException
public void textDeltaEnd(java.lang.String path) throws SVNException
ISVNDeltaConsumer
textDeltaEnd
in interface ISVNDeltaConsumer
path
- a file path relative to the edit root
directorySVNException
private FSDeltaConsumer getDeltaConsumer()
public void changeFileProperty(java.lang.String path, java.lang.String name, SVNPropertyValue value) throws SVNException
ISVNEditor
changeFileProperty
in interface ISVNEditor
path
- file path relative to the root of this editorname
- property namevalue
- property valueSVNException
private SVNProperties getFilePropertiesStorage()
private void flushPendingProperties() throws SVNException
SVNException
public void closeFile(java.lang.String path, java.lang.String textChecksum) throws SVNException
ISVNEditor
closeFile
in interface ISVNEditor
path
- a file path relative to the root
directory opened by openRoot()
textChecksum
- an MD5 checksum for the modified fileSVNException
- if the calculated upon the actual changed contents
checksum does not match the expected textChecksum
public SVNCommitInfo closeEdit() throws SVNException
ISVNEditor
closeEdit
in interface ISVNEditor
SVNException
private void releaseLocks()
private void releaseLocks(java.util.Map<java.lang.String,java.lang.String> pathsToLockTokens, boolean breakLocks, boolean runHooks)
public void abortEdit() throws SVNException
ISVNEditor
If an exception is thrown from an editor's method, call this method to abort the editor.
abortEdit
in interface ISVNEditor
SVNException