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 callback routine.

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

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

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.
`(package private) static int`	`cmp_content`
`(package private) static int`	`cmp_onlyTimestamp`
`(package private) static int`	`cmp_withoutComment`
`(package private) static int`	`cmp_withoutEndlineComment`
`(package private) static int`	`cmp_withoutLineend`
`private FileCallbackLocalCmp.CompareCtrl`	`cmpCtrl`
`private FileRemote`	`dir1`
`private FileRemote`	`dir2`
`private EventWithDst<FileRemoteProgressEvData,?>`	`evBack` Event instance for user callback.
`(package private) long`	`minDiffTimestamp`
`(package private) int`	`mode`
`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, FileRemoteWalkerCallback callbackUser, EventWithDst<FileRemoteProgressEvData,?> evBack)` Constructs an instance to execute a comparison of directory trees.

Method Summary

All Methods Instance Methods Concrete Methods
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.
    - 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
```
  - minDiffTimestamp
```
long minDiffTimestamp
```
  - cmp_onlyTimestamp
```
static final int cmp_onlyTimestamp
```
    See Also:
    
    Constant Field Values
  - cmp_content
```
static final int cmp_content
```
    See Also:
    
    Constant Field Values
  - cmp_withoutLineend
```
static final int cmp_withoutLineend
```
    See Also:
    
    Constant Field Values
  - cmp_withoutEndlineComment
```
static final int cmp_withoutEndlineComment
```
    See Also:
    
    Constant Field Values
  - cmp_withoutComment
```
static final int cmp_withoutComment
```
    See Also:
    
    Constant Field Values
  - 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,
                            FileRemoteWalkerCallback callbackUser,
                            EventWithDst<FileRemoteProgressEvData,?> evBack)
```
    Constructs an instance to execute a comparison of directory trees.
    
    Parameters:
    
    dir1 - One directory which contains a file tree. All files are compared with dir2
    
    dir2 - The other directory to compare
    
    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.
    
    timeOrderProgress - maybe null. If given this timeOrder 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>

Class FileCallbackLocalCmp

Nested Class Summary

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

Field Summary

Fields inherited from interface org.vishia.util.SortedTreeWalkerCallback

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sVersion

cmpCtrl

dir1

dir2

basepath1

zBasePath1

evBack

progress

callbackUser

mode

minDiffTimestamp

cmp_onlyTimestamp

cmp_content

cmp_withoutLineend

cmp_withoutEndlineComment

cmp_withoutComment

aborted

XXXcallbackMarkSecondAlone

Constructor Detail

FileCallbackLocalCmp

Method Detail

start

offerParentNode

finishedParentNode

offerLeafNode

shouldAborted

compareFile

compareFileContent

readIgnoreComment

finished