org.vishia.fileLocalAccessor

Class FileCallbackLocalCmp

java.lang.Object

org.vishia.fileLocalAccessor.FileCallbackLocalCmp

All Implemented Interfaces:

FileRemoteWalkerCallback, SortedTreeWalkerCallback<FileRemote,FileRemoteCmdEventData>

public class FileCallbackLocalCmp
extends java.lang.Object
implements FileRemoteWalkerCallback

This class supports comparison of files in a tree. It is a callback class for the File Walker. It works with FileRemote instances. The result of comparison is set in any file in FileRemote.setMarked(int) whereby the argument is an int as mask with one of the bits in

• FileMark.cmpAlone if the second file is not existing.
• FileMark.cmpContentEqual if both files are compared by content and have equal content, whereby comments etc. are maybe ignored.
• FileMark.cmpContentNotEqual if both files are compared with different content.
• FileMark.cmpLenTimeEqual if both files have the same length and time stamp. They can be differ though! But the difference is not detected if mode have the bit FileCompare.onlyTimestamp is set.
• FileMark.cmpFileDifferences if the length is differ.
• FileMark.cmpTimeGreater or FileMark.cmpTimeLesser if there are time differences. Note that it is possible that the files have also set FileMark.cmpContentEqual if only the timestamp is touched.

The directory till the root is marked with

• FileMark.selectSomeInDir if any differences are in the dir and sub directories
• FileMark.cmpMissingFiles if some files are missing in the dir and sub directories

That information are displayed by the org.vishia.gral.widget.GralFileSelector#setCmpFileResult(int) see there.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	FileCallbackLocalCmp.CompareCtrl

Nested classes/interfaces inherited from interface org.vishia.util.SortedTreeWalkerCallback

SortedTreeWalkerCallback.Result

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	aborted
private java.lang.String	basepath1
private FileRemoteWalkerCallback	callbackUser Event to walk through the second tree.
private FileCallbackLocalCmp.CompareCtrl	cmpCtrl
private FileRemote	dir1
private FileRemote	dir2
private EventWithDst<FileRemoteProgressEvData,?>	evBack Event instance for user callback.
(package private) long	minDiffTimestamp Files with a lesser difference in time (2 sec) are seen as equal in time stamp.
(package private) int	mode one of the bits FileCompare.onlyTimestamp = FileCompare.withoutLineend = FileCompare.withoutEndlineComment = FileCompare.withoutComment = used for the comparison itself.
private FileRemoteProgressEvData	progress
static java.lang.String	sVersion Version, history and license.
(package private) FileRemoteWalkerCallback	XXXcallbackMarkSecondAlone Callback to mark all files of the second directory as 'alone' on open directory.
private int	zBasePath1

Fields inherited from interface org.vishia.util.SortedTreeWalkerCallback

callbackTemplate

Constructor Summary

Constructors

Constructor and Description
FileCallbackLocalCmp(FileRemote dir1, FileRemote dir2, int cmpMode, FileRemoteWalkerCallback callbackUser, EventWithDst<FileRemoteProgressEvData,?> evBack) Constructs an instance to execute a comparison of directory trees.

Method Summary

Modifier and Type	Method and Description
(package private) int	compareFile(FileRemote file1, FileRemote file2) Compare two files.
(package private) boolean	compareFileContent(FileRemote file1, FileRemote file2) Compare two files.
void	finished(FileRemote startDir) Invoked after finishing the walking through.
SortedTreeWalkerCallback.Result	finishedParentNode(FileRemote file, java.lang.Object data, java.lang.Object oWalkInfo) Checks whether all files are compared or whether there are alone files.
SortedTreeWalkerCallback.Result	offerLeafNode(FileRemote file, java.lang.Object info) Invoked for any node which has no children or which is not processed because the depth of walking through the tree is reached.
SortedTreeWalkerCallback.Result	offerParentNode(FileRemote dir, java.lang.Object oPath, java.lang.Object oWalkInfo) Invoked on start on walking through a parent node which have children.
private java.lang.String	readIgnoreComment(java.io.BufferedReader reader)
boolean	shouldAborted() Returns true if the tree walking should be terminated respectively aborted.
void	start(FileRemote startDir, FileRemoteCmdEventData co) On start of comparison it refreshes the second dir tree.

Methods inherited from class java.lang.Object

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

Field Detail

sVersion

public static final java.lang.String sVersion

Version, history and license.

• 2024-04-08 offerParentNode(FileRemote, Object, Object) do not skip but enter empty directories, because the files intern should be also marked with FileMark.cmpAlone.
• 2024-02-12 Comparison of file trees now also in mode fast, without content:
  • The cmp_onlyTimestamp etc. are removed here, instead used FileCompare.onlyTimestamp etc. They are the same values. Unique!
  • FileCallbackLocalCmp(FileRemote, FileRemote, int, FileRemoteWalkerCallback, EventWithDst) has a new argument cmpMode
• 2023-07-14 Hartmut adapted because cleanup of FileRemote
• 2023-02-10 Hartmut new concept with the FileRemoteProgressEvData: remove progress.show(...) because it is called in the timer thread instead. Independent of continue the process here.
• 2016-12-20 Hartmut bugfix: readIgnoreComment(BufferedReader): The second line after //line is ignored too. In a rarely case it was the only one line which was different, and the comparison has failed.
• 2014-12-12 Hartmut bugfix: compareFileContent(FileRemote, FileRemote): if the 2. file is longer, it is a difference!
• 2014-12-12 Hartmut new: FileCallbackLocalCmp.CompareCtrl: Comparison with suppressed parts especially comments.
• 2013-09-19 created. Comparison in callback routine of walkThroughFiles instead in the graphic thread.

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

cmpCtrl

private final FileCallbackLocalCmp.CompareCtrl cmpCtrl

dir1

private final FileRemote dir1

dir2

private final FileRemote dir2

basepath1

private final java.lang.String basepath1

zBasePath1

private final int zBasePath1

evBack

private final EventWithDst<FileRemoteProgressEvData,?> evBack

Event instance for user callback.

progress

private final FileRemoteProgressEvData progress

callbackUser

private final FileRemoteWalkerCallback callbackUser

Event to walk through the second tree.

mode

int mode

one of the bits
FileCompare.onlyTimestamp =
FileCompare.withoutLineend =
FileCompare.withoutEndlineComment =
FileCompare.withoutComment = used for the comparison itself.

minDiffTimestamp

long minDiffTimestamp

Files with a lesser difference in time (2 sec) are seen as equal in time stamp.

aborted

boolean aborted

XXXcallbackMarkSecondAlone

final FileRemoteWalkerCallback XXXcallbackMarkSecondAlone

Callback to mark all files of the second directory as 'alone' on open directory. If the files are found in the first directory after them, there are marked as 'equal' or 'non equal' then, and this selection will be removed. This callback will be used in the routine #offerParentNode(FileRemote) on any directory in the dir1. A new dir is searched in the dir2 tree, then the children in 1 level are marked.

Constructor Detail

FileCallbackLocalCmp

public FileCallbackLocalCmp(FileRemote dir1,
                            FileRemote dir2,
                            int cmpMode,
                            FileRemoteWalkerCallback callbackUser,
                            EventWithDst<FileRemoteProgressEvData,?> evBack)

Constructs an instance to execute a comparison of directory trees. since 2024-02: If cmpMode has set the bit FileCompare.onlyTimestamp then full content comparison is not done. The comparison is very more faster (seen 10 times).

Parameters:

dir1 - One directory which contains a file tree. All files are compared with dir2

dir2 - The other directory to compare

cmpMode - can contain the bits FileCompare.onlyTimestamp, FileCompare.withoutLineend, FileCompare.withoutEndlineComment, FileCompare.withoutComment,

callbackUser - Maybe null. If given, on each directory entry, exit and file the callback will be invoked with the handled directory or file. The second argument is an boxed Integer, which contains the bits from FileMark to inform what is with that file.

evBack - maybe null. If given this back event is used to show the progression of the comparison. The timeOrder is set with data

Method Detail

start

public void start(FileRemote startDir,
                  FileRemoteCmdEventData co)

On start of comparison it refreshes the second dir tree. Secondly it resets all mark bits in the known files. Don't use the java.nio.file walker, Only do it for the given files. It are lesser. The other FileRemote instances are not known till now. This is a fast operation because it does not access the file system.

Specified by:

start in interface SortedTreeWalkerCallback<FileRemote,FileRemoteCmdEventData>

offerParentNode

public SortedTreeWalkerCallback.Result offerParentNode(FileRemote dir,
                                                       java.lang.Object oPath,
                                                       java.lang.Object oWalkInfo)

Description copied from interface: SortedTreeWalkerCallback

Invoked on start on walking through a parent node which have children. It may be a directory inside a file tree. If this method is invoked for a node, the #offerLeafNode(TypeNode) is not invoked.

Specified by:

offerParentNode in interface SortedTreeWalkerCallback<FileRemote,FileRemoteCmdEventData>

oPath - Specific data presentation of the node

oWalkInfo - internal possible information about walking, depending on usage.

Returns:

information to abort, maybe boolean.

finishedParentNode

public SortedTreeWalkerCallback.Result finishedParentNode(FileRemote file,
                                                          java.lang.Object data,
                                                          java.lang.Object oWalkInfo)

Checks whether all files are compared or whether there are alone files.

Specified by:

finishedParentNode in interface SortedTreeWalkerCallback<FileRemote,FileRemoteCmdEventData>

Parameters:

file - the node which was walked through

data - Specific data presentation of the node

oWalkInfo - internal possible information about walking, depending on usage.

offerLeafNode

public SortedTreeWalkerCallback.Result offerLeafNode(FileRemote file,
                                                     java.lang.Object info)

Description copied from interface: SortedTreeWalkerCallback

Invoked for any node which has no children or which is not processed because the depth of walking through the tree is reached. It is called in opposite to #offerLeafNode(Object), only one of both is called for a node. For example it is invoked for a sub directory only if the depth is reached and #offerParentNode(TypeNode) is not called.

Specified by:

offerLeafNode in interface SortedTreeWalkerCallback<FileRemote,FileRemoteCmdEventData>

Returns:

information to abort or continue.

shouldAborted

public boolean shouldAborted()

Description copied from interface: SortedTreeWalkerCallback

Returns true if the tree walking should be terminated respectively aborted. This routine should be called in any walk tree routine. The aborted state should be set from outside in the implementation classes.

Specified by:

shouldAborted in interface SortedTreeWalkerCallback<FileRemote,FileRemoteCmdEventData>

Returns:

true if should terminated.

compareFile

int compareFile(FileRemote file1,
                FileRemote file2)

Compare two files.

Parameters:

file1 -

file2 - both file should be exist. It is tested before.

Returns:

either FileMark.cmpContentEqual or

Since:

2015-09-05 returns comparison result, does not set bits in the file mask. Done on calling level.

compareFileContent

boolean compareFileContent(FileRemote file1,
                           FileRemote file2)
                    throws java.io.IOException

Compare two files.

Parameters:

file -

Throws:

java.io.FileNotFoundException

java.io.IOException

readIgnoreComment

private java.lang.String readIgnoreComment(java.io.BufferedReader reader)
                                    throws java.io.IOException

Throws:

java.io.IOException

finished

public void finished(FileRemote startDir)

Description copied from interface: SortedTreeWalkerCallback

Invoked after finishing the walking through.

Specified by:

finished in interface SortedTreeWalkerCallback<FileRemote,FileRemoteCmdEventData>