org.tmatesoft.svn.core.internal.wc

Class SVNUpdateEditor

java.lang.Object

org.tmatesoft.svn.core.internal.wc.SVNUpdateEditor

All Implemented Interfaces:

ISVNCleanupHandler, ISVNUpdateEditor, ISVNDeltaConsumer, ISVNEditor

public class SVNUpdateEditor
extends java.lang.Object
implements ISVNUpdateEditor, ISVNCleanupHandler

Version:

1.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	SVNUpdateEditor.SVNDirectoryInfo
private class	SVNUpdateEditor.SVNEntryInfo
private class	SVNUpdateEditor.SVNFileInfo

Field Summary

Fields

Modifier and Type	Field and Description
private SVNAdminAreaInfo	myAdminInfo
private SVNUpdateEditor.SVNDirectoryInfo	myCurrentDirectory
private SVNUpdateEditor.SVNFileInfo	myCurrentFile
private java.util.Collection	myDeletedTrees
private SVNDeltaProcessor	myDeltaProcessor
private java.lang.String[]	myExtensionPatterns
private ISVNFileFetcher	myFileFetcher
private boolean	myIsDepthSticky
private boolean	myIsLockOnDemand
private boolean	myIsRootOpen
private boolean	myIsTargetDeleted
private boolean	myIsUnversionedObstructionsAllowed
private SVNDepth	myRequestedDepth
private java.lang.String	myRootURL
private java.util.Collection	mySkippedTrees
private java.lang.String	mySwitchURL
private java.lang.String	myTarget
private long	myTargetRevision
private java.lang.String	myTargetURL
private SVNWCAccess	myWCAccess

Constructor Summary

Constructors

Modifier	Constructor and Description
private	SVNUpdateEditor(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

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).
private void	absentEntry(java.lang.String path, SVNNodeKind kind)
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).
private void	addDeletedTree(java.io.File path)
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 SVNUpdateEditor.SVNFileInfo	addFile(SVNUpdateEditor.SVNDirectoryInfo parent, java.lang.String path, java.lang.String copyFromPath, long copyFromRevision)
private SVNUpdateEditor.SVNFileInfo	addFileWithHistory(SVNUpdateEditor.SVNDirectoryInfo parent, SVNUpdateEditor.SVNFileInfo info, java.lang.String copyFromPath, long copyFromRevision)
private void	addSkippedTree(java.io.File path)
private java.io.File	alreadyInTreeConflict(java.io.File path)
void	applyTextDelta(java.lang.String commitPath, 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 commitPath, java.lang.String name, SVNPropertyValue value) Changes the value of a property of the currently opened/added file.
private void	changeFileProperty(java.lang.String name, SVNPropertyValue value, SVNUpdateEditor.SVNFileInfo fileInfo)
private void	checkIfPathIsUnderRoot(java.lang.String path)
private SVNTreeConflictDescription	checkTreeConflict(java.io.File path, SVNEntry entry, SVNAdminArea parentArea, SVNLog log, SVNConflictAction action, SVNNodeKind theirKind, SVNURL theirURL)
void	cleanup(SVNAdminArea area)
private void	clearWCProperty(SVNAdminArea adminArea, java.lang.String target)
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 void	closeFile(java.lang.String textChecksum, SVNUpdateEditor.SVNFileInfo fileInfo, SVNUpdateEditor.SVNDirectoryInfo dirInfo)
private void	completeDirectory(SVNUpdateEditor.SVNDirectoryInfo dirInfo)
private SVNUpdateEditor.SVNDirectoryInfo	createDirectoryInfo(SVNUpdateEditor.SVNDirectoryInfo parent, java.lang.String path, boolean added)
private SVNUpdateEditor.SVNFileInfo	createFileInfo(SVNUpdateEditor.SVNDirectoryInfo parent, java.lang.String path, boolean added)
static SVNUpdateEditor	createUpdateEditor(SVNAdminAreaInfo info, java.lang.String switchURL, boolean allowUnversionedObstructions, boolean depthIsSticky, SVNDepth depth, java.lang.String[] preservedExtensions, ISVNFileFetcher fileFetcher, boolean lockOnDemand)
void	deleteEntry(java.lang.String path, long revision) Deletes an entry.
private void	doDeleteEntry(java.lang.String path, SVNAdminArea parentArea, SVNUpdateEditor.SVNDirectoryInfo parent, SVNURL theirURL)
private boolean	entryHasLocalModifications(SVNAdminArea adminArea, java.io.File path, SVNNodeKind kind, java.lang.String schedule)
private java.util.Collection	getDeletedTrees()
private java.util.Collection	getSkippedTrees()
long	getTargetRevision()
private SVNProperties	getTreeConflictCreationAttributes(SVNAdminArea adminArea, SVNTreeConflictDescription treeConflict)
private void	handleDuplicateEntries()
private void	handleLeftLocalModificationsError(SVNException originalError)
private boolean	inDeletedTree(java.io.File path, boolean includeRoot)
private boolean	inSkippedTree(java.io.File path)
private SVNEntry	locateCopyFrom(java.lang.String copyFromPath, long copyFromRevision, java.io.File dstDir, SVNEntry dstEntry)
private void	maybeBumpDirInfo(SVNUpdateEditor.SVNDirectoryInfo dirInfo)
void	openDir(java.lang.String path, long revision) Opens a directory.
void	openFile(java.lang.String path, long revision) Opens a file.
SVNUpdateEditor.SVNFileInfo	openFile(java.lang.String path, SVNUpdateEditor.SVNDirectoryInfo parent)
void	openRoot(long revision) Opens the root directory on which the operation was invoked.
private void	scheduleExistingEntryForReAdd(SVNEntry entry, java.io.File path, SVNURL theirURL, boolean modifyCopyFrom)
void	targetRevision(long revision) Sets the target revision the operation is running for.
java.io.OutputStream	textDeltaChunk(java.lang.String commitPath, SVNDiffWindow diffWindow) Collects a next delta chunk.
void	textDeltaEnd(java.lang.String commitPath) Finalizes collecting text delta(s).
boolean	treeHasLocalModifications(SVNAdminArea adminArea, boolean[] allModsAreDeletes)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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 SVNUpdateEditor.SVNDirectoryInfo myCurrentDirectory

myCurrentFile

private SVNUpdateEditor.SVNFileInfo myCurrentFile

myTargetRevision

private long myTargetRevision

myIsRootOpen

private boolean myIsRootOpen

myIsTargetDeleted

private boolean myIsTargetDeleted

myIsUnversionedObstructionsAllowed

private boolean myIsUnversionedObstructionsAllowed

myIsDepthSticky

private boolean myIsDepthSticky

mySkippedTrees

private java.util.Collection mySkippedTrees

myDeletedTrees

private java.util.Collection myDeletedTrees

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

SVNUpdateEditor

private SVNUpdateEditor(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

getSkippedTrees

private java.util.Collection getSkippedTrees()

getDeletedTrees

private java.util.Collection getDeletedTrees()

addSkippedTree

private void addSkippedTree(java.io.File path)

addDeletedTree

private void addDeletedTree(java.io.File path)

inSkippedTree

private boolean inSkippedTree(java.io.File path)

inDeletedTree

private boolean inDeletedTree(java.io.File path,
                              boolean includeRoot)

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 interface ISVNEditor

Parameters:

revision - a revision number

Throws:

SVNException

getTargetRevision

public long getTargetRevision()

Specified by:

getTargetRevision in interface ISVNUpdateEditor

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 calling ISVNEditor.closeDir().

Specified by:

openRoot in interface ISVNEditor

Parameters:

revision - the revision number of the root directory

Throws:

SVNException

doDeleteEntry

private void doDeleteEntry(java.lang.String path,
                           SVNAdminArea parentArea,
                           SVNUpdateEditor.SVNDirectoryInfo parent,
                           SVNURL theirURL)
                    throws SVNException

Throws:

SVNException

alreadyInTreeConflict

private java.io.File alreadyInTreeConflict(java.io.File path)
                                    throws SVNException

Throws:

SVNException

checkTreeConflict

private SVNTreeConflictDescription checkTreeConflict(java.io.File path,
                                                     SVNEntry entry,
                                                     SVNAdminArea parentArea,
                                                     SVNLog log,
                                                     SVNConflictAction action,
                                                     SVNNodeKind theirKind,
                                                     SVNURL theirURL)
                                              throws SVNException

Throws:

SVNException

treeHasLocalModifications

public boolean treeHasLocalModifications(SVNAdminArea adminArea,
                                         boolean[] allModsAreDeletes)
                                  throws SVNException

Throws:

SVNException

entryHasLocalModifications

private boolean entryHasLocalModifications(SVNAdminArea adminArea,
                                           java.io.File path,
                                           SVNNodeKind kind,
                                           java.lang.String schedule)
                                    throws SVNException

Throws:

SVNException

scheduleExistingEntryForReAdd

private void scheduleExistingEntryForReAdd(SVNEntry entry,
                                           java.io.File path,
                                           SVNURL theirURL,
                                           boolean modifyCopyFrom)
                                    throws SVNException

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 interface ISVNEditor

Parameters:

path - an entry path relative to the root directory opened by openRoot()

revision - the revision number of path

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 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 that path is copied from copyFromPath located in copyFromRevision.

Specified by:

addDir in interface ISVNEditor

Parameters:

path - a directory path relative to the root directory opened by openRoot()

copyFromPath - an ancestor of the added directory

copyFromRevision - 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 interface ISVNEditor

Parameters:

path - a directory path relative to the root directory opened by openRoot()

revision - the revision of the directory

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 interface ISVNEditor

Parameters:

path - a dir path relative to the root directory opened by openRoot()

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 interface ISVNEditor

Parameters:

path - a file path relative to the root directory opened by openRoot()

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 SVNException

Description copied from interface: ISVNEditor

Changes the value of a property of the currently opened/added directory.

Specified by:

changeDirProperty in interface ISVNEditor

Parameters:

name - the name of a property to be changed

value - 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 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 interface ISVNEditor

Throws:

SVNException

handleDuplicateEntries

private void handleDuplicateEntries()
                             throws SVNException

Throws:

SVNException

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 interface ISVNEditor

Returns:

a committed revision information

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 that path is copied from copyFromPath located in copyFromRevision.

Specified by:

addFile in interface ISVNEditor

Parameters:

path - a file path relative to the root directory opened by openRoot()

copyFromPath - an ancestor of the added file

copyFromRevision - 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 interface ISVNEditor

Parameters:

path - a file path relative to the root directory opened by openRoot()

revision - the revision of the file

Throws:

SVNException

changeFileProperty

public void changeFileProperty(java.lang.String commitPath,
                               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 interface ISVNEditor

Parameters:

commitPath - file path relative to the root of this editor

name - property name

value - property value

Throws:

SVNException

applyTextDelta

public void applyTextDelta(java.lang.String commitPath,
                           java.lang.String baseChecksum)
                    throws SVNException

Description copied from interface: ISVNDeltaConsumer

Starts applying text delta(s) to an opened file.

Specified by:

applyTextDelta in interface ISVNDeltaConsumer

Parameters:

commitPath - a file path relative to the edit root directory

baseChecksum - 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 expected baseChecksum

textDeltaChunk

public java.io.OutputStream textDeltaChunk(java.lang.String commitPath,
                                           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 interface ISVNDeltaConsumer

Parameters:

commitPath - a file path relative to the edit root directory

diffWindow - a next diff window

Returns:

an output stream

Throws:

SVNException

textDeltaEnd

public void textDeltaEnd(java.lang.String commitPath)
                  throws SVNException

Description copied from interface: ISVNDeltaConsumer

Finalizes collecting text delta(s).

Specified by:

textDeltaEnd in interface ISVNDeltaConsumer

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 SVNException

Description copied from interface: ISVNEditor

Closes the opened file fixing all properties and/or contents changes.

Specified by:

closeFile in interface ISVNEditor

Parameters:

commitPath - a file path relative to the root directory opened by openRoot()

textChecksum - an MD5 checksum for the modified file

Throws:

SVNException - if the calculated upon the actual changed contents checksum does not match the expected textChecksum

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 interface ISVNEditor

Throws:

SVNException

checkIfPathIsUnderRoot

private void checkIfPathIsUnderRoot(java.lang.String path)
                             throws SVNException

Throws:

SVNException

maybeBumpDirInfo

private void maybeBumpDirInfo(SVNUpdateEditor.SVNDirectoryInfo dirInfo)
                       throws SVNException

Throws:

SVNException

completeDirectory

private void completeDirectory(SVNUpdateEditor.SVNDirectoryInfo dirInfo)
                        throws SVNException

Throws:

SVNException

addFile

private SVNUpdateEditor.SVNFileInfo addFile(SVNUpdateEditor.SVNDirectoryInfo parent,
                                            java.lang.String path,
                                            java.lang.String copyFromPath,
                                            long copyFromRevision)
                                     throws SVNException

Throws:

SVNException

addFileWithHistory

private SVNUpdateEditor.SVNFileInfo addFileWithHistory(SVNUpdateEditor.SVNDirectoryInfo parent,
                                                       SVNUpdateEditor.SVNFileInfo info,
                                                       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,
                                SVNUpdateEditor.SVNFileInfo fileInfo)

openFile

public SVNUpdateEditor.SVNFileInfo openFile(java.lang.String path,
                                            SVNUpdateEditor.SVNDirectoryInfo parent)
                                     throws SVNException

Throws:

SVNException

getTreeConflictCreationAttributes

private SVNProperties getTreeConflictCreationAttributes(SVNAdminArea adminArea,
                                                        SVNTreeConflictDescription treeConflict)
                                                 throws SVNException

Throws:

SVNException

closeFile

private void closeFile(java.lang.String textChecksum,
                       SVNUpdateEditor.SVNFileInfo fileInfo,
                       SVNUpdateEditor.SVNDirectoryInfo dirInfo)
                throws SVNException

Throws:

SVNException

createFileInfo

private SVNUpdateEditor.SVNFileInfo createFileInfo(SVNUpdateEditor.SVNDirectoryInfo parent,
                                                   java.lang.String path,
                                                   boolean added)
                                            throws SVNException

Throws:

SVNException

createDirectoryInfo

private SVNUpdateEditor.SVNDirectoryInfo createDirectoryInfo(SVNUpdateEditor.SVNDirectoryInfo parent,
                                                             java.lang.String path,
                                                             boolean added)

createUpdateEditor

public static SVNUpdateEditor 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:

cleanup in interface ISVNCleanupHandler

Throws:

SVNException