Class SVNDiffEditor
- java.lang.Object
-
- org.tmatesoft.svn.core.internal.wc.SVNDiffEditor
-
- All Implemented Interfaces:
ISVNDeltaConsumer
,ISVNEditor
public class SVNDiffEditor extends java.lang.Object implements ISVNEditor
- Version:
- 1.3
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
SVNDiffEditor.SVNDirectoryInfo
private static class
SVNDiffEditor.SVNFileInfo
-
Field Summary
Fields Modifier and Type Field Description private SVNAdminAreaInfo
myAdminInfo
private java.util.Collection
myChangeLists
private SVNDiffEditor.SVNDirectoryInfo
myCurrentDirectory
private SVNDiffEditor.SVNFileInfo
myCurrentFile
private SVNDeltaProcessor
myDeltaProcessor
private SVNDepth
myDepth
private AbstractDiffCallback
myDiffCallback
private boolean
myIsCompareToBase
private boolean
myIsReverseDiff
private boolean
myIsRootOpen
private long
myTargetRevision
private java.io.File
myTempDirectory
private boolean
myUseAncestry
private SVNWCAccess
myWCAccess
private java.lang.String
myWCRootPath
-
Constructor Summary
Constructors Constructor Description SVNDiffEditor(SVNWCAccess wcAccess, SVNAdminAreaInfo info, AbstractDiffCallback callback, boolean useAncestry, boolean reverseDiff, boolean compareToBase, SVNDepth depth, java.util.Collection changeLists)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.private SVNProperties
applyPropChanges(SVNProperties props, SVNProperties propChanges)
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
cleanup()
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 commitPath, java.lang.String textChecksum)
Closes the opened file fixing all properties and/or contents changes.private static SVNProperties
computePropsDiff(SVNProperties props1, SVNProperties props2)
private SVNDiffEditor.SVNDirectoryInfo
createDirInfo(SVNDiffEditor.SVNDirectoryInfo parent, java.lang.String path, boolean added, SVNDepth depth)
private SVNDiffEditor.SVNFileInfo
createFileInfo(SVNDiffEditor.SVNDirectoryInfo parent, java.lang.String path, boolean added)
private java.io.File
createTempFile()
void
deleteEntry(java.lang.String path, long revision)
Deletes an entry.private java.io.File
detranslateFile(SVNAdminArea dir, java.lang.String name)
private void
diffUnversioned(java.io.File root, SVNAdminArea dir, java.lang.String parentRelativePath, boolean anchor, java.util.Set processedFiles)
private AbstractDiffCallback
getDiffCallback()
private java.io.File
getTempDirectory()
private void
localDirectoryDiff(SVNDiffEditor.SVNDirectoryInfo info)
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
reportAddedDir(SVNDiffEditor.SVNDirectoryInfo info)
private void
reportAddedFile(SVNDiffEditor.SVNDirectoryInfo info, java.lang.String path, SVNEntry entry)
private void
reportModifiedFile(SVNDiffEditor.SVNDirectoryInfo dirInfo, SVNEntry entry)
private SVNAdminArea
retrieve(java.lang.String path)
private static void
reversePropChanges(SVNProperties base, SVNProperties diff)
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).
-
-
-
Field Detail
-
myWCAccess
private SVNWCAccess myWCAccess
-
myUseAncestry
private boolean myUseAncestry
-
myIsReverseDiff
private boolean myIsReverseDiff
-
myIsCompareToBase
private boolean myIsCompareToBase
-
myIsRootOpen
private boolean myIsRootOpen
-
myTargetRevision
private long myTargetRevision
-
myCurrentDirectory
private SVNDiffEditor.SVNDirectoryInfo myCurrentDirectory
-
myCurrentFile
private SVNDiffEditor.SVNFileInfo myCurrentFile
-
myDeltaProcessor
private SVNDeltaProcessor myDeltaProcessor
-
myAdminInfo
private SVNAdminAreaInfo myAdminInfo
-
myDepth
private SVNDepth myDepth
-
myTempDirectory
private java.io.File myTempDirectory
-
myDiffCallback
private AbstractDiffCallback myDiffCallback
-
myChangeLists
private java.util.Collection myChangeLists
-
myWCRootPath
private java.lang.String myWCRootPath
-
-
Constructor Detail
-
SVNDiffEditor
public SVNDiffEditor(SVNWCAccess wcAccess, SVNAdminAreaInfo info, AbstractDiffCallback callback, boolean useAncestry, boolean reverseDiff, boolean compareToBase, SVNDepth depth, java.util.Collection changeLists)
-
-
Method Detail
-
targetRevision
public void targetRevision(long revision) throws SVNException
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
-
openRoot
public void openRoot(long revision) throws SVNException
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
public void deleteEntry(java.lang.String path, long revision) throws SVNException
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
-
reportAddedDir
private void reportAddedDir(SVNDiffEditor.SVNDirectoryInfo info) throws SVNException
- Throws:
SVNException
-
reportAddedFile
private void reportAddedFile(SVNDiffEditor.SVNDirectoryInfo info, java.lang.String path, SVNEntry entry) throws SVNException
- Throws:
SVNException
-
reportModifiedFile
private void reportModifiedFile(SVNDiffEditor.SVNDirectoryInfo dirInfo, SVNEntry entry) throws SVNException
- 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
public void openDir(java.lang.String path, long revision) throws SVNException
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
public void changeDirProperty(java.lang.String name, SVNPropertyValue value) throws SVNException
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:
ISVNEditor.openDir(String, long)
-
closeDir
public void closeDir() throws SVNException
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
public void openFile(java.lang.String path, long revision) throws SVNException
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
-
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
-
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
public void textDeltaEnd(java.lang.String path) throws SVNException
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
-
closeFile
public void closeFile(java.lang.String commitPath, java.lang.String textChecksum) throws SVNException
Description copied from interface:ISVNEditor
Closes the opened file fixing all properties and/or contents changes.- Specified by:
closeFile
in interfaceISVNEditor
- Parameters:
commitPath
- 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
public SVNCommitInfo closeEdit() throws SVNException
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
public void abortEdit() throws SVNException
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
-
absentDir
public void absentDir(java.lang.String path) throws SVNException
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
public void absentFile(java.lang.String path) throws SVNException
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
-
cleanup
public void cleanup()
-
applyPropChanges
private SVNProperties applyPropChanges(SVNProperties props, SVNProperties propChanges)
-
localDirectoryDiff
private void localDirectoryDiff(SVNDiffEditor.SVNDirectoryInfo info) throws SVNException
- Throws:
SVNException
-
diffUnversioned
private void diffUnversioned(java.io.File root, SVNAdminArea dir, java.lang.String parentRelativePath, boolean anchor, java.util.Set processedFiles) throws SVNException
- Throws:
SVNException
-
createDirInfo
private SVNDiffEditor.SVNDirectoryInfo createDirInfo(SVNDiffEditor.SVNDirectoryInfo parent, java.lang.String path, boolean added, SVNDepth depth)
-
createFileInfo
private SVNDiffEditor.SVNFileInfo createFileInfo(SVNDiffEditor.SVNDirectoryInfo parent, java.lang.String path, boolean added)
-
detranslateFile
private java.io.File detranslateFile(SVNAdminArea dir, java.lang.String name) throws SVNException
- Throws:
SVNException
-
createTempFile
private java.io.File createTempFile() throws SVNException
- Throws:
SVNException
-
getTempDirectory
private java.io.File getTempDirectory() throws SVNException
- Throws:
SVNException
-
retrieve
private SVNAdminArea retrieve(java.lang.String path) throws SVNException
- Throws:
SVNException
-
getDiffCallback
private AbstractDiffCallback getDiffCallback()
-
reversePropChanges
private static void reversePropChanges(SVNProperties base, SVNProperties diff)
-
computePropsDiff
private static SVNProperties computePropsDiff(SVNProperties props1, SVNProperties props2)
-
-