Class SVNUpdateEditor15
- java.lang.Object
-
- org.tmatesoft.svn.core.internal.wc.SVNUpdateEditor15
-
- All Implemented Interfaces:
ISVNCleanupHandler,ISVNUpdateEditor,ISVNDeltaConsumer,ISVNEditor
public class SVNUpdateEditor15 extends java.lang.Object implements ISVNUpdateEditor, ISVNCleanupHandler
- Version:
- 1.3
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private classSVNUpdateEditor15.SVNDirectoryInfoprivate classSVNUpdateEditor15.SVNEntryInfoprivate classSVNUpdateEditor15.SVNFileInfo
-
Field Summary
Fields Modifier and Type Field Description private SVNAdminAreaInfomyAdminInfoprivate SVNUpdateEditor15.SVNDirectoryInfomyCurrentDirectoryprivate SVNUpdateEditor15.SVNFileInfomyCurrentFileprivate SVNDeltaProcessormyDeltaProcessorprivate java.lang.String[]myExtensionPatternsprivate ISVNFileFetchermyFileFetcherprivate booleanmyIsDepthStickyprivate booleanmyIsLockOnDemandprivate booleanmyIsRootOpenprivate booleanmyIsTargetDeletedprivate booleanmyIsUnversionedObstructionsAllowedprivate SVNDepthmyRequestedDepthprivate java.lang.StringmyRootURLprivate java.util.CollectionmySkippedPathsprivate java.lang.StringmySwitchURLprivate java.lang.StringmyTargetprivate longmyTargetRevisionprivate java.lang.StringmyTargetURLprivate SVNWCAccessmyWCAccess
-
Constructor Summary
Constructors Modifier Constructor Description privateSVNUpdateEditor15(SVNAdminAreaInfo info, java.lang.String switchURL, boolean allowUnversionedObstructions, boolean depthIsSticky, SVNDepth depth, java.lang.String[] preservedExtensions, java.lang.String targetURL, java.lang.String rootURL, ISVNFileFetcher fileFetcher, boolean lockOnDemand)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidabortEdit()Aborts the current running editor due to errors occured.voidabsentDir(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).private voidabsentEntry(java.lang.String path, SVNNodeKind kind)voidabsentFile(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).voidaddDir(java.lang.String path, java.lang.String copyFromPath, long copyFromRevision)Adds a directory.voidaddFile(java.lang.String path, java.lang.String copyFromPath, long copyFromRevision)Adds a file.private SVNUpdateEditor15.SVNFileInfoaddFile(SVNUpdateEditor15.SVNDirectoryInfo parent, java.lang.String path, java.lang.String copyFromPath, long copyFromRevision)private SVNUpdateEditor15.SVNFileInfoaddFileWithHistory(SVNUpdateEditor15.SVNDirectoryInfo parent, java.lang.String path, java.lang.String copyFromPath, long copyFromRevision)voidapplyTextDelta(java.lang.String commitPath, java.lang.String baseChecksum)Starts applying text delta(s) to an opened file.voidchangeDirProperty(java.lang.String name, SVNPropertyValue value)Changes the value of a property of the currently opened/added directory.voidchangeFileProperty(java.lang.String commitPath, java.lang.String name, SVNPropertyValue value)Changes the value of a property of the currently opened/added file.private voidchangeFileProperty(java.lang.String name, SVNPropertyValue value, SVNUpdateEditor15.SVNFileInfo fileInfo)private voidcheckIfPathIsUnderRoot(java.lang.String path)voidcleanup(SVNAdminArea area)private voidclearWCProperty(SVNAdminArea adminArea, java.lang.String target)voidcloseDir()Closes the currently opened directory fixing all changes of its properties and/or entries.SVNCommitInfocloseEdit()Closes this editor finalizing the whole operation the editor was used for.voidcloseFile(java.lang.String commitPath, java.lang.String textChecksum)Closes the opened file fixing all properties and/or contents changes.private voidcloseFile(java.lang.String textChecksum, SVNUpdateEditor15.SVNFileInfo fileInfo, SVNUpdateEditor15.SVNDirectoryInfo dirInfo)private voidcompleteDirectory(SVNUpdateEditor15.SVNDirectoryInfo dirInfo)private SVNUpdateEditor15.SVNDirectoryInfocreateDirectoryInfo(SVNUpdateEditor15.SVNDirectoryInfo parent, java.lang.String path, boolean added)private SVNUpdateEditor15.SVNFileInfocreateFileInfo(SVNUpdateEditor15.SVNDirectoryInfo parent, java.lang.String path, boolean added)static SVNUpdateEditor15createUpdateEditor(SVNAdminAreaInfo info, java.lang.String switchURL, boolean allowUnversionedObstructions, boolean depthIsSticky, SVNDepth depth, java.lang.String[] preservedExtensions, ISVNFileFetcher fileFetcher, boolean lockOnDemand)voiddeleteEntry(java.lang.String path, long revision)Deletes an entry.private java.util.CollectiongetSkippedPaths()longgetTargetRevision()private voidhandleLeftLocalModificationsError(SVNException originalError)private SVNEntrylocateCopyFrom(java.lang.String copyFromPath, long copyFromRevision, java.io.File dstDir, SVNEntry dstEntry)private voidmaybeBumpDirInfo(SVNUpdateEditor15.SVNDirectoryInfo dirInfo)voidopenDir(java.lang.String path, long revision)Opens a directory.voidopenFile(java.lang.String path, long revision)Opens a file.private SVNUpdateEditor15.SVNFileInfoopenFile(java.lang.String path, SVNUpdateEditor15.SVNDirectoryInfo parent)voidopenRoot(long revision)Opens the root directory on which the operation was invoked.voidtargetRevision(long revision)Sets the target revision the operation is running for.java.io.OutputStreamtextDeltaChunk(java.lang.String commitPath, SVNDiffWindow diffWindow)Collects a next delta chunk.voidtextDeltaEnd(java.lang.String commitPath)Finalizes collecting text delta(s).
-
-
-
Field Detail
-
mySwitchURL
private java.lang.String mySwitchURL
-
myTarget
private java.lang.String myTarget
-
myTargetURL
private java.lang.String myTargetURL
-
myRootURL
private java.lang.String myRootURL
-
myAdminInfo
private SVNAdminAreaInfo myAdminInfo
-
myCurrentDirectory
private SVNUpdateEditor15.SVNDirectoryInfo myCurrentDirectory
-
myCurrentFile
private SVNUpdateEditor15.SVNFileInfo myCurrentFile
-
myTargetRevision
private long myTargetRevision
-
myIsRootOpen
private boolean myIsRootOpen
-
myIsTargetDeleted
private boolean myIsTargetDeleted
-
myIsUnversionedObstructionsAllowed
private boolean myIsUnversionedObstructionsAllowed
-
myIsDepthSticky
private boolean myIsDepthSticky
-
mySkippedPaths
private java.util.Collection mySkippedPaths
-
myWCAccess
private SVNWCAccess myWCAccess
-
myDeltaProcessor
private SVNDeltaProcessor myDeltaProcessor
-
myRequestedDepth
private SVNDepth myRequestedDepth
-
myExtensionPatterns
private java.lang.String[] myExtensionPatterns
-
myFileFetcher
private ISVNFileFetcher myFileFetcher
-
myIsLockOnDemand
private boolean myIsLockOnDemand
-
-
Constructor Detail
-
SVNUpdateEditor15
private SVNUpdateEditor15(SVNAdminAreaInfo info, java.lang.String switchURL, boolean allowUnversionedObstructions, boolean depthIsSticky, SVNDepth depth, java.lang.String[] preservedExtensions, java.lang.String targetURL, java.lang.String rootURL, ISVNFileFetcher fileFetcher, boolean lockOnDemand)
-
-
Method Detail
-
targetRevision
public void targetRevision(long revision) throws SVNExceptionDescription copied from interface:ISVNEditorSets the target revision the operation is running for. For example, the target revision to which an update is running.- Specified by:
targetRevisionin interfaceISVNEditor- Parameters:
revision- a revision number- Throws:
SVNException
-
getTargetRevision
public long getTargetRevision()
- Specified by:
getTargetRevisionin interfaceISVNUpdateEditor
-
openRoot
public void openRoot(long revision) throws SVNExceptionDescription copied from interface:ISVNEditorOpens 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:
openRootin interfaceISVNEditor- Parameters:
revision- the revision number of the root directory- Throws:
SVNException
-
deleteEntry
public void deleteEntry(java.lang.String path, long revision) throws SVNExceptionDescription copied from interface:ISVNEditorDeletes 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:
deleteEntryin interfaceISVNEditor- Parameters:
path- an entry path relative to the root directory opened byopenRoot()revision- the revision number ofpath- Throws:
SVNException
-
handleLeftLocalModificationsError
private void handleLeftLocalModificationsError(SVNException originalError) throws SVNException
- Throws:
SVNException
-
addDir
public void addDir(java.lang.String path, java.lang.String copyFromPath, long copyFromRevision) throws SVNExceptionDescription copied from interface:ISVNEditorAdds 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
copyFromPathis not null then it says thatpathis copied fromcopyFromPathlocated incopyFromRevision.- Specified by:
addDirin 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 SVNExceptionDescription copied from interface:ISVNEditorOpens a directory. All property changes as well as entries adding/deletion can be applied to this directory.- Specified by:
openDirin interfaceISVNEditor- Parameters:
path- a directory path relative to the root directory opened byopenRoot()revision- the revision of the directory- Throws:
SVNException
-
getSkippedPaths
private java.util.Collection getSkippedPaths()
-
absentDir
public void absentDir(java.lang.String path) throws SVNExceptionDescription copied from interface:ISVNEditorIndicates 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:
absentDirin interfaceISVNEditor- Parameters:
path- a dir path relative to the root directory opened byopenRoot()- Throws:
SVNException
-
absentFile
public void absentFile(java.lang.String path) throws SVNExceptionDescription copied from interface:ISVNEditorIndicates 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:
absentFilein interfaceISVNEditor- Parameters:
path- a file path relative to the root directory opened byopenRoot()- Throws:
SVNException
-
absentEntry
private void absentEntry(java.lang.String path, SVNNodeKind kind) throws SVNException- Throws:
SVNException
-
changeDirProperty
public void changeDirProperty(java.lang.String name, SVNPropertyValue value) throws SVNExceptionDescription copied from interface:ISVNEditorChanges the value of a property of the currently opened/added directory.- Specified by:
changeDirPropertyin interfaceISVNEditor- Parameters:
name- the name of a property to be changedvalue- new property value- Throws:
SVNException- See Also:
ISVNEditor.openDir(String, long)
-
clearWCProperty
private void clearWCProperty(SVNAdminArea adminArea, java.lang.String target) throws SVNException
- Throws:
SVNException
-
closeDir
public void closeDir() throws SVNExceptionDescription copied from interface:ISVNEditorCloses 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:
closeDirin interfaceISVNEditor- Throws:
SVNException
-
closeEdit
public SVNCommitInfo closeEdit() throws SVNException
Description copied from interface:ISVNEditorCloses this editor finalizing the whole operation the editor was used for. In a commit - sends collected data to commit a transaction.- Specified by:
closeEditin interfaceISVNEditor- Returns:
- a committed revision information
- Throws:
SVNException
-
addFile
public void addFile(java.lang.String path, java.lang.String copyFromPath, long copyFromRevision) throws SVNExceptionDescription copied from interface:ISVNEditorAdds 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
copyFromPathis not null then it says thatpathis copied fromcopyFromPathlocated incopyFromRevision.- Specified by:
addFilein 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 SVNExceptionDescription copied from interface:ISVNEditorOpens a file. After it's opened, apply delta to its contents or change the file properties.- Specified by:
openFilein 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 commitPath, java.lang.String name, SVNPropertyValue value) throws SVNExceptionDescription copied from interface:ISVNEditorChanges the value of a property of the currently opened/added file.- Specified by:
changeFilePropertyin interfaceISVNEditor- Parameters:
commitPath- file path relative to the root of this editorname- property namevalue- property value- Throws:
SVNException
-
applyTextDelta
public void applyTextDelta(java.lang.String commitPath, java.lang.String baseChecksum) throws SVNExceptionDescription copied from interface:ISVNDeltaConsumerStarts applying text delta(s) to an opened file.- Specified by:
applyTextDeltain interfaceISVNDeltaConsumer- Parameters:
commitPath- 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 commitPath, SVNDiffWindow diffWindow) throws SVNExceptionDescription copied from interface:ISVNDeltaConsumerCollects 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:
textDeltaChunkin interfaceISVNDeltaConsumer- Parameters:
commitPath- 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 commitPath) throws SVNExceptionDescription copied from interface:ISVNDeltaConsumerFinalizes collecting text delta(s).- Specified by:
textDeltaEndin interfaceISVNDeltaConsumer- Parameters:
commitPath- a file path relative to the edit root directory- Throws:
SVNException
-
closeFile
public void closeFile(java.lang.String commitPath, java.lang.String textChecksum) throws SVNExceptionDescription copied from interface:ISVNEditorCloses the opened file fixing all properties and/or contents changes.- Specified by:
closeFilein 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
-
abortEdit
public void abortEdit() throws SVNExceptionDescription copied from interface:ISVNEditorAborts 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:
abortEditin interfaceISVNEditor- Throws:
SVNException
-
checkIfPathIsUnderRoot
private void checkIfPathIsUnderRoot(java.lang.String path) throws SVNException- Throws:
SVNException
-
maybeBumpDirInfo
private void maybeBumpDirInfo(SVNUpdateEditor15.SVNDirectoryInfo dirInfo) throws SVNException
- Throws:
SVNException
-
completeDirectory
private void completeDirectory(SVNUpdateEditor15.SVNDirectoryInfo dirInfo) throws SVNException
- Throws:
SVNException
-
addFile
private SVNUpdateEditor15.SVNFileInfo addFile(SVNUpdateEditor15.SVNDirectoryInfo parent, java.lang.String path, java.lang.String copyFromPath, long copyFromRevision) throws SVNException
- Throws:
SVNException
-
addFileWithHistory
private SVNUpdateEditor15.SVNFileInfo addFileWithHistory(SVNUpdateEditor15.SVNDirectoryInfo parent, java.lang.String path, java.lang.String copyFromPath, long copyFromRevision) throws SVNException
- Throws:
SVNException
-
locateCopyFrom
private SVNEntry locateCopyFrom(java.lang.String copyFromPath, long copyFromRevision, java.io.File dstDir, SVNEntry dstEntry) throws SVNException
- Throws:
SVNException
-
changeFileProperty
private void changeFileProperty(java.lang.String name, SVNPropertyValue value, SVNUpdateEditor15.SVNFileInfo fileInfo)
-
openFile
private SVNUpdateEditor15.SVNFileInfo openFile(java.lang.String path, SVNUpdateEditor15.SVNDirectoryInfo parent) throws SVNException
- Throws:
SVNException
-
closeFile
private void closeFile(java.lang.String textChecksum, SVNUpdateEditor15.SVNFileInfo fileInfo, SVNUpdateEditor15.SVNDirectoryInfo dirInfo) throws SVNException- Throws:
SVNException
-
createFileInfo
private SVNUpdateEditor15.SVNFileInfo createFileInfo(SVNUpdateEditor15.SVNDirectoryInfo parent, java.lang.String path, boolean added) throws SVNException
- Throws:
SVNException
-
createDirectoryInfo
private SVNUpdateEditor15.SVNDirectoryInfo createDirectoryInfo(SVNUpdateEditor15.SVNDirectoryInfo parent, java.lang.String path, boolean added)
-
createUpdateEditor
public static SVNUpdateEditor15 createUpdateEditor(SVNAdminAreaInfo info, java.lang.String switchURL, boolean allowUnversionedObstructions, boolean depthIsSticky, SVNDepth depth, java.lang.String[] preservedExtensions, ISVNFileFetcher fileFetcher, boolean lockOnDemand) throws SVNException
- Throws:
SVNException
-
cleanup
public void cleanup(SVNAdminArea area) throws SVNException
- Specified by:
cleanupin interfaceISVNCleanupHandler- Throws:
SVNException
-
-