FileMark

java.lang.Object
- org.vishia.util.SelectMask
- - org.vishia.fileRemote.FileMark

All Implemented Interfaces:

MarkMask_ifc
```
public class FileMark
extends SelectMask
```
Class can be associated with a FileRemote to store comparison or mark information.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`cmpAlone` Flags as result of an comparison: the other file does not exist, or any files of an directory does not exists or there are differences.
`static int`	`cmpContentEqual` Flags as result of an comparison: the other file does not exist, or exists only with same length or with same time stamp If 0 and also cmpContentNotEqual is 0, it is not tested.
`static int`	`cmpContentNotEqual` Flags as result of an comparison: the other file does not exist, or exists with other length or other timestamp, or with other content also with same length or with same time stamp If 0 and also cmpContentEqual is 0, it is not tested.
`static int`	`cmpFileDifferences` Flags as result of an comparison: the other file does not exist, or any files of an directory does not exists or there are differences.
`static int`	`cmpLenTimeEqual` Flags as result of an comparison: the other file has the same length and same time stamp, it seems it may be equal, but not tested.
`static int`	`cmpMissingFiles` Flags as result of an comparison: the other file does not exist, or any files of an directory does not exists or there are differences.
`static int`	`cmpTimeGreater` Flags as result of an comparison: this file has a time stamp greater then the other.
`static int`	`cmpTimeLesser` Flags as result of an comparison: this file has a time stamp lesser then the other, the file is older.
`static int`	`ignoreSymbolicLinks` This is not used for mark, used for selection.
`protected FileRemote`	`itsFile`
`static int`	`markDir` Flags means that this file is any directory which is in the mark tree.
`static int`	`markRoot` Flags means that this file is the root of mark.
`static int`	`mCmpFile` mask of all bits for comparison one file.
`static int`	`mSelectMarkBits`
`long`	`nrofBytesSelected`
`int`	`nrofFilesSelected`
`static int`	`orWithSelectString` This is not used for mark, used for selection.
`static int`	`resetMark` This is not used for mark, only for a mark command.
`static int`	`resetNonMarked` This is not used for mark, only for a mark command.
`static int`	`select` Flags is a simple marker for manual selecting for a file, also for a directory, shown in red in Fcmd.
`static int`	`selectForCopy` Flags is a marker for files or the whole dir to copy, select in orange in Fcmd.
`static int`	`selectForCopySomeInDir` Flags is a marker for directory which contains some to copy, select in light orange in Fcmd.
`static int`	`selectSomeInDir` Flags means that some but not all files are marked inside a directory.
`static java.lang.String`	`sVersion` Version, history and license.
`static char`	`XXXcharCmpContentEqual` Flags as result of an comparison: the other file is checked by content maybe with restricitons.
`static char`	`XXXcharCmpContentEqualWithoutComments` Flags as result of an comparison: the other file is checked by content maybe with restricitons.
`static char`	`XXXcharCmpContentEqualWithoutEndlines` Flags as result of an comparison: the other file is checked by content maybe with restricitons.
`static char`	`XXXcharCmpContentEqualwithoutSpaces` Flags as result of an comparison: the other file is checked by content maybe with restricitons.

Fields inherited from class org.vishia.util.SelectMask
selectMask, version

Fields inherited from interface org.vishia.util.MarkMask_ifc
select2, select2Parent, selectParent

Constructor Summary

Constructors
Constructor and Description

FileMark(FileRemote itsFile)

Constructors
Constructor and Description
`FileMark(FileRemote itsFile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`nrofFilesSelected()`
`int`	`setMarked(int mask, java.lang.Object data)` Sets some bits of the mask.
`void`	`setMarkParent(int mask, boolean count)` Sets a mark to all parents of this till the `markRoot` is found.
`int`	`setNonMarkedRecursively(int mask, java.lang.Object data, boolean recursively)`
`java.lang.String`	`toString()`

Methods inherited from class org.vishia.util.SelectMask
getMark, setNonMarked

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - sVersion
```
public static final java.lang.String sVersion
```
    Version, history and license.
    - 2024-02-12 For comparison without content cmpTimeGreater and ~Lesser added.
    - 2023-02-12 Hartmut it has uses constants from MarkMask_ifc de facto, but not documented. Not documented. Enhanced with selectForCopy =^ MarkMask_ifc.select2. Also shown as colors in the org.vishia.gral.widget.GralFileSelector.
    - 2013-05-22 Hartmut created: A FileRemote may have information about a select status or about a comparison result. It is stored in a referred instance of this type. Experience.
    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
  - XXXcharCmpContentEqual
```
public static final char XXXcharCmpContentEqual
```
    Flags as result of an comparison: the other file is checked by content maybe with restricitons.
    
    See Also:
    
    Constant Field Values
  - XXXcharCmpContentEqualWithoutComments
```
public static final char XXXcharCmpContentEqualWithoutComments
```
    Flags as result of an comparison: the other file is checked by content maybe with restricitons.
    
    See Also:
    
    Constant Field Values
  - XXXcharCmpContentEqualWithoutEndlines
```
public static final char XXXcharCmpContentEqualWithoutEndlines
```
    Flags as result of an comparison: the other file is checked by content maybe with restricitons.
    
    See Also:
    
    Constant Field Values
  - XXXcharCmpContentEqualwithoutSpaces
```
public static final char XXXcharCmpContentEqualwithoutSpaces
```
    Flags as result of an comparison: the other file is checked by content maybe with restricitons.
    
    See Also:
    
    Constant Field Values
  - select
```
public static final int select
```
    Flags is a simple marker for manual selecting for a file, also for a directory, shown in red in Fcmd.
    
    See Also:
    
    Constant Field Values
  - selectSomeInDir
```
public static final int selectSomeInDir
```
    Flags means that some but not all files are marked inside a directory.
    
    See Also:
    
    Constant Field Values
  - selectForCopy
```
public static final int selectForCopy
```
    Flags is a marker for files or the whole dir to copy, select in orange in Fcmd.
    
    See Also:
    
    Constant Field Values
  - selectForCopySomeInDir
```
public static final int selectForCopySomeInDir
```
    Flags is a marker for directory which contains some to copy, select in light orange in Fcmd.
    
    See Also:
    
    Constant Field Values
  - markRoot
```
public static final int markRoot
```
    Flags means that this file is the root of mark. It is used for setMarkParent(int, boolean)
    
    See Also:
    
    Constant Field Values
  - markDir
```
public static final int markDir
```
    Flags means that this file is any directory which is in the mark tree.
    
    See Also:
    
    Constant Field Values
  - cmpTimeGreater
```
public static final int cmpTimeGreater
```
    Flags as result of an comparison: this file has a time stamp greater then the other.
    
    See Also:
    
    Constant Field Values
  - cmpTimeLesser
```
public static final int cmpTimeLesser
```
    Flags as result of an comparison: this file has a time stamp lesser then the other, the file is older.
    
    See Also:
    
    Constant Field Values
  - cmpAlone
```
public static final int cmpAlone
```
    Flags as result of an comparison: the other file does not exist, or any files of an directory does not exists or there are differences.
    
    See Also:
    
    Constant Field Values
  - cmpLenTimeEqual
```
public static final int cmpLenTimeEqual
```
    Flags as result of an comparison: the other file has the same length and same time stamp, it seems it may be equal, but not tested.
    
    See Also:
    
    Constant Field Values
  - cmpContentEqual
```
public static final int cmpContentEqual
```
    Flags as result of an comparison: the other file does not exist, or exists only with same length or with same time stamp If 0 and also cmpContentNotEqual is 0, it is not tested.
    
    See Also:
    
    Constant Field Values
  - cmpContentNotEqual
```
public static final int cmpContentNotEqual
```
    Flags as result of an comparison: the other file does not exist, or exists with other length or other timestamp, or with other content also with same length or with same time stamp If 0 and also cmpContentEqual is 0, it is not tested.
    
    See Also:
    
    Constant Field Values
  - mCmpFile
```
public static final int mCmpFile
```
    mask of all bits for comparison one file.
    
    See Also:
    
    Constant Field Values
  - cmpMissingFiles
```
public static final int cmpMissingFiles
```
    Flags as result of an comparison: the other file does not exist, or any files of an directory does not exists or there are differences.
    
    See Also:
    
    Constant Field Values
  - cmpFileDifferences
```
public static final int cmpFileDifferences
```
    Flags as result of an comparison: the other file does not exist, or any files of an directory does not exists or there are differences.
    
    See Also:
    
    Constant Field Values
  - resetNonMarked
```
public static final int resetNonMarked
```
    This is not used for mark, only for a mark command. It means if this bit is set: reset the mark bits of non selected files.
    
    See Also:
    
    Constant Field Values
  - resetMark
```
public static final int resetMark
```
    This is not used for mark, only for a mark command. It means if this bit is set: reset instead set of a mark for selected files.
    
    See Also:
    
    Constant Field Values
  - orWithSelectString
```
public static final int orWithSelectString
```
    This is not used for mark, used for selection. It means if this bit is set: OR relation for selection together with a select mask. If this bit is not set, it is a AND relation with the select mask.
    
    See Also:
    
    Constant Field Values
  - ignoreSymbolicLinks
```
public static final int ignoreSymbolicLinks
```
    This is not used for mark, used for selection. If this bit is set: symbolic links of directories are not selected, should be ignored. This is especially important for copy and compare operations etc.
    
    See Also:
    
    Constant Field Values
  - mSelectMarkBits
```
public static final int mSelectMarkBits
```
    See Also:
    
    Constant Field Values
  - itsFile
```
protected final FileRemote itsFile
```
  - nrofFilesSelected
```
public int nrofFilesSelected
```
  - nrofBytesSelected
```
public long nrofBytesSelected
```
- Constructor Detail
  - FileMark
```
public FileMark(FileRemote itsFile)
```
- Method Detail
  - nrofFilesSelected
```
public int nrofFilesSelected()
```
  - setNonMarkedRecursively
```
public int setNonMarkedRecursively(int mask,
                                   java.lang.Object data,
                                   boolean recursively)
```
  - setMarked
```
public int setMarked(int mask,
                     java.lang.Object data)
```
    Description copied from class: SelectMask
    
    Sets some bits of the mask.
    
    Specified by:
    
    setMarked in interface MarkMask_ifc
    
    Overrides:
    
    setMarked in class SelectMask
    
    Parameters:
    
    mask - This bits of the SelectMask.selectMask will be reseted.
    
    data - not used here.
    
    Returns:
    
    The mark bits before this action is done. If it is 0, this source is the only one which has marks the object.
  - setMarkParent
```
public void setMarkParent(int mask,
                          boolean count)
```
    Sets a mark to all parents of this till the markRoot is found.
    
    Parameters:
    
    mask -
    
    count - TODO
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class FileMark

Field Summary

Fields inherited from class org.vishia.util.SelectMask

Fields inherited from interface org.vishia.util.MarkMask_ifc

Constructor Summary

Method Summary

Methods inherited from class org.vishia.util.SelectMask

Methods inherited from class java.lang.Object

Field Detail

sVersion

XXXcharCmpContentEqual

XXXcharCmpContentEqualWithoutComments

XXXcharCmpContentEqualWithoutEndlines

XXXcharCmpContentEqualwithoutSpaces

select

selectSomeInDir

selectForCopy

selectForCopySomeInDir

markRoot

markDir

cmpTimeGreater

cmpTimeLesser

cmpAlone

cmpLenTimeEqual

cmpContentEqual

cmpContentNotEqual

mCmpFile

cmpMissingFiles

cmpFileDifferences

resetNonMarked

resetMark

orWithSelectString

ignoreSymbolicLinks

mSelectMarkBits

itsFile

nrofFilesSelected

nrofBytesSelected

Constructor Detail

FileMark

Method Detail

nrofFilesSelected

setNonMarkedRecursively

setMarked

setMarkParent

toString