Class SVNCommitEditor
- All Implemented Interfaces:
ISVNDeltaConsumer
,ISVNEditor
- Version:
- 1.3
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static final class
static interface
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate SVNConnection
private int
private java.util.Stack
private java.util.Map
private boolean
private int
private SVNRepositoryImpl
-
Constructor Summary
ConstructorsConstructorDescriptionSVNCommitEditor
(SVNRepositoryImpl location, SVNConnection connection, SVNCommitEditor.ISVNCommitCallback closeCallback) -
Method Summary
Modifier and TypeMethodDescriptionvoid
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.void
closeDir()
Closes the currently opened directory fixing all changes of its properties and/or entries.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 static java.lang.Long
getRevisionObject
(long rev) 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.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).Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
myConnection
-
myRepository
-
myCloseCallback
-
myDirsStack
private java.util.Stack myDirsStack -
myNextToken
private int myNextToken -
myFilesToTokens
private java.util.Map myFilesToTokens -
myDiffWindowCount
private int myDiffWindowCount -
myIsAborted
private boolean myIsAborted
-
-
Constructor Details
-
SVNCommitEditor
public SVNCommitEditor(SVNRepositoryImpl location, SVNConnection connection, SVNCommitEditor.ISVNCommitCallback closeCallback)
-
-
Method Details
-
targetRevision
Description copied from interface:ISVNEditor
Sets the target revision the operation is running for. For example, the target revision to which an update is running.- Specified by:
targetRevision
in interfaceISVNEditor
- Parameters:
revision
- a revision number- Throws:
SVNException
-
absentDir
Description copied from interface:ISVNEditor
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).- Specified by:
absentDir
in interfaceISVNEditor
- Parameters:
path
- a dir path relative to the root directory opened byopenRoot()
- Throws:
SVNException
-
absentFile
Description copied from interface:ISVNEditor
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).- Specified by:
absentFile
in interfaceISVNEditor
- Parameters:
path
- a file path relative to the root directory opened byopenRoot()
- Throws:
SVNException
-
openRoot
Description copied from interface:ISVNEditor
Opens the root directory on which the operation was invoked. All property changes as well as entries adding/deletion will be applied to this root directory. When coming back up to this root (after traversing the entire tree) you should close the root by callingISVNEditor.closeDir()
.- Specified by:
openRoot
in interfaceISVNEditor
- Parameters:
revision
- the revision number of the root directory- Throws:
SVNException
-
deleteEntry
Description copied from interface:ISVNEditor
Deletes an entry.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.
- Specified by:
deleteEntry
in interfaceISVNEditor
- Parameters:
path
- an entry path relative to the root directory opened byopenRoot()
revision
- the revision number ofpath
- Throws:
SVNException
-
addDir
public void addDir(java.lang.String path, java.lang.String copyFromPath, long copyFromRevision) throws SVNException Description copied from interface:ISVNEditor
Adds a directory.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 thatpath
is copied fromcopyFromPath
located incopyFromRevision
.- Specified by:
addDir
in interfaceISVNEditor
- Parameters:
path
- a directory path relative to the root directory opened byopenRoot()
copyFromPath
- an ancestor of the added directorycopyFromRevision
- the revision of the ancestor- Throws:
SVNException
-
openDir
Description copied from interface:ISVNEditor
Opens a directory. All property changes as well as entries adding/deletion can be applied to this directory.- Specified by:
openDir
in interfaceISVNEditor
- Parameters:
path
- a directory path relative to the root directory opened byopenRoot()
revision
- the revision of the directory- Throws:
SVNException
-
changeDirProperty
Description copied from interface:ISVNEditor
Changes the value of a property of the currently opened/added directory.- Specified by:
changeDirProperty
in interfaceISVNEditor
- Parameters:
name
- the name of a property to be changedvalue
- new property value- Throws:
SVNException
- See Also:
-
closeDir
Description copied from interface:ISVNEditor
Closes the currently opened directory fixing all changes of its properties and/or entries. Closing a directory picks up an editor to a parent directory.- Specified by:
closeDir
in interfaceISVNEditor
- Throws:
SVNException
-
addFile
public void addFile(java.lang.String path, java.lang.String copyFromPath, long copyFromRevision) throws SVNException Description copied from interface:ISVNEditor
Adds a file.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 thatpath
is copied fromcopyFromPath
located incopyFromRevision
.- Specified by:
addFile
in interfaceISVNEditor
- Parameters:
path
- a file path relative to the root directory opened byopenRoot()
copyFromPath
- an ancestor of the added filecopyFromRevision
- the revision of the ancestor- Throws:
SVNException
-
openFile
Description copied from interface:ISVNEditor
Opens a file. After it's opened, apply delta to its contents or change the file properties.- Specified by:
openFile
in interfaceISVNEditor
- Parameters:
path
- a file path relative to the root directory opened byopenRoot()
revision
- the revision of the file- Throws:
SVNException
-
applyTextDelta
public void applyTextDelta(java.lang.String path, java.lang.String baseChecksum) throws SVNException Description copied from interface:ISVNDeltaConsumer
Starts applying text delta(s) to an opened file.- Specified by:
applyTextDelta
in interfaceISVNDeltaConsumer
- Parameters:
path
- a file path relative to the edit root directorybaseChecksum
- an MD5 checksum for the base file contents (before the file is changed)- Throws:
SVNException
- if the calculated base file checksum didn't match the expectedbaseChecksum
-
textDeltaChunk
public java.io.OutputStream textDeltaChunk(java.lang.String path, SVNDiffWindow diffWindow) throws SVNException Description copied from interface:ISVNDeltaConsumer
Collects a next delta chunk. The return type is nomore relevant and is left only for backward compatibility. So, the return value may be just null. Otherwise if it's not null, the stream will be immediately closed.If there are more than one windows for the file, this method is called several times.
- Specified by:
textDeltaChunk
in interfaceISVNDeltaConsumer
- Parameters:
path
- a file path relative to the edit root directorydiffWindow
- a next diff window- Returns:
- an output stream
- Throws:
SVNException
-
textDeltaEnd
Description copied from interface:ISVNDeltaConsumer
Finalizes collecting text delta(s).- Specified by:
textDeltaEnd
in interfaceISVNDeltaConsumer
- Parameters:
path
- a file path relative to the edit root directory- Throws:
SVNException
-
changeFileProperty
public void changeFileProperty(java.lang.String path, java.lang.String name, SVNPropertyValue value) throws SVNException Description copied from interface:ISVNEditor
Changes the value of a property of the currently opened/added file.- Specified by:
changeFileProperty
in interfaceISVNEditor
- Parameters:
path
- file path relative to the root of this editorname
- property namevalue
- property value- Throws:
SVNException
-
closeFile
Description copied from interface:ISVNEditor
Closes the opened file fixing all properties and/or contents changes.- Specified by:
closeFile
in interfaceISVNEditor
- Parameters:
path
- a file path relative to the root directory opened byopenRoot()
textChecksum
- an MD5 checksum for the modified file- Throws:
SVNException
- if the calculated upon the actual changed contents checksum does not match the expectedtextChecksum
-
closeEdit
Description copied from interface:ISVNEditor
Closes this editor finalizing the whole operation the editor was used for. In a commit - sends collected data to commit a transaction.- Specified by:
closeEdit
in interfaceISVNEditor
- Returns:
- a committed revision information
- Throws:
SVNException
-
abortEdit
Description copied from interface:ISVNEditor
Aborts the current running editor due to errors occured.If an exception is thrown from an editor's method, call this method to abort the editor.
- Specified by:
abortEdit
in interfaceISVNEditor
- Throws:
SVNException
-
getRevisionObject
private static java.lang.Long getRevisionObject(long rev)
-