org.vishia.util

Class FileList

java.lang.Object

org.vishia.util.FileList

public class FileList
extends java.lang.Object

This class creates a list which information about a file tree and supports change timestamp of given files (touch). A file list can be created from any directory tree. It contains properties of files: timestamp, length, relative path inside this file tree and a CRC checksum of the file content. The list can be used to

• touch the timestamp of files if their length and CRC matches.
• compare files with the content of the list - detect changes, maybe used for version check.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileList.Args

Field Summary

Fields

Modifier and Type	Field and Description
(package private) FileList.Args	args
(package private) java.util.zip.CRC32	crcCalculator
(package private) java.text.SimpleDateFormat	date_Format The data format is ISO 8601 but without 'T' as separator between date and time, a space is better readable.
(package private) java.text.SimpleDateFormat	dateFormat The data format is ISO 8601 but without 'T' as separator between date and time, a space is better readable.
(package private) StringFormatter	formatter
(package private) java.lang.String	spaces
static java.lang.String	sVersion Version, history and license.

Constructor Summary

Constructors

Constructor and Description
FileList(FileList.Args args)

Method Summary

Modifier and Type	Method and Description
protected void	list() Creates a list of all files which's path and mask is given by args.
protected void	list(java.io.File dir, FilepathFilterM filter, int posLocalPath, java.lang.CharSequence localDir, java.io.Writer out, int recurs) Creates a list of all files which's path and mask is given by args.
static void	list(java.lang.String dir, java.lang.String mask, java.lang.String sFilelist) Static method to create a list from any directory maybe with selected files.
static void	main(java.lang.String[] sArgs)
static java.lang.String	smain(java.lang.String[] sArgs) Invocation from another java program without exit the JVM
private static java.lang.String	smain(java.lang.String[] sArgs, boolean shouldExitVM)
void	touch()
void	touch(java.lang.String sFile)
static void	touch(java.lang.String dir, java.lang.String sFilelist, java.lang.Appendable out) Static method to touch all files form a given list.
static void	touch(java.lang.String dir, java.lang.String sFilelist, java.lang.String sFile, java.lang.Appendable out) Static method to touch all files form a given list.
private java.lang.String	touchOneLine(java.lang.String sLine, java.io.File dir, java.lang.String sDirlocal, java.lang.String sFile)
private void	writeDirectoryLine(java.io.Writer out, java.io.File file, java.lang.CharSequence localDir, java.lang.String name)
private void	writeOneFile(java.io.Writer out, java.io.File file, java.lang.CharSequence localDir, java.lang.String name)
protected void	xxxlist() Creates a list of all files which's path and mask is given by args.
private void	xxxwriteOneFile(java.io.Writer out, java.io.File file, java.lang.CharSequence localPath)

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.

• 2020-06-16 Hartmut chg: lesser dependencies, do not use MainCmd, instead Argument.
• 2016-11-13 Hartmut new: touch only one file from a given list possible.
• 2016-11-13 Hartmut chg: The directory line does not contain a date up to now.
• 2016-08-20 Hartmut chg: Other format, better able to read, used for restoring time stamps after git-revert.
• 2014-01-14 Hartmut chg: round up and down to 10 seconds, to ignore second differences on writing.
• 2013-08-09 Hartmut created: The FileList was written by me in 1992..2001 in C++-Language. Now it is available for Java usage. One of the motivation was the necessity of correction of time stamps of reverted files from Bazaar and git.

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

args

final FileList.Args args

dateFormat

final java.text.SimpleDateFormat dateFormat

The data format is ISO 8601 but without 'T' as separator between date and time, a space is better readable.

date_Format

final java.text.SimpleDateFormat date_Format

The data format is ISO 8601 but without 'T' as separator between date and time, a space is better readable.

formatter

final StringFormatter formatter

crcCalculator

final java.util.zip.CRC32 crcCalculator

spaces

java.lang.String spaces

Constructor Detail

FileList

public FileList(FileList.Args args)

Method Detail

list

public static void list(java.lang.String dir,
                        java.lang.String mask,
                        java.lang.String sFilelist)
                 throws java.io.IOException

Static method to create a list from any directory maybe with selected files. TODO if a list exists alread, read the timestamps from there and compare it. If the timestamp differ in a few seconds, take the timestamp from the given list instead. It is possible that the timestamp may differ a few seconds by small differences in the time of the PC.

Parameters:

dir - path to any directory.

mask - Use "*" to select all files.

sFilelist - Name of the file list relative to the dir, can contain a relative path.

Throws:

java.io.IOException

xxxlist

protected void xxxlist()
                throws java.io.IOException

Creates a list of all files which's path and mask is given by args.

Throws:

java.io.IOException

list

protected void list()
             throws java.io.IOException

Creates a list of all files which's path and mask is given by args.

Throws:

java.io.IOException

list

protected void list(java.io.File dir,
                    FilepathFilterM filter,
                    int posLocalPath,
                    java.lang.CharSequence localDir,
                    java.io.Writer out,
                    int recurs)
             throws java.io.IOException

Creates a list of all files which's path and mask is given by args.

Throws:

java.io.IOException

writeOneFile

private void writeOneFile(java.io.Writer out,
                          java.io.File file,
                          java.lang.CharSequence localDir,
                          java.lang.String name)
                   throws java.io.IOException

Throws:

java.io.IOException

writeDirectoryLine

private void writeDirectoryLine(java.io.Writer out,
                                java.io.File file,
                                java.lang.CharSequence localDir,
                                java.lang.String name)
                         throws java.io.IOException

Throws:

java.io.IOException

xxxwriteOneFile

private void xxxwriteOneFile(java.io.Writer out,
                             java.io.File file,
                             java.lang.CharSequence localPath)
                      throws java.io.IOException

Throws:

java.io.IOException

touch

public static void touch(java.lang.String dir,
                         java.lang.String sFilelist,
                         java.lang.String sFile,
                         java.lang.Appendable out)
                  throws java.io.IOException

Static method to touch all files form a given list.

Parameters:

dir - path to any directory.

mask - Use "*" to select all files.

sFile - file with local path, if given only that file will be touched, null: all files to touch.

sFilelist - Name of the file list relative to the dir, can contain a relative path.

Throws:

java.io.IOException

touch

public static void touch(java.lang.String dir,
                         java.lang.String sFilelist,
                         java.lang.Appendable out)
                  throws java.io.IOException

Static method to touch all files form a given list.

Parameters:

dir - path to any directory.

mask - Use "*" to select all files.

sFilelist - Name of the file list relative to the dir, can contain a relative path.

Throws:

java.io.IOException

touch

public void touch()

touch

public void touch(java.lang.String sFile)

touchOneLine

private java.lang.String touchOneLine(java.lang.String sLine,
                                      java.io.File dir,
                                      java.lang.String sDirlocal,
                                      java.lang.String sFile)

main

public static void main(java.lang.String[] sArgs)

smain

public static java.lang.String smain(java.lang.String[] sArgs)

Invocation from another java program without exit the JVM

Parameters:

sArgs - same like main(String[])

Returns:

"" or an error String

smain

private static java.lang.String smain(java.lang.String[] sArgs,
                                      boolean shouldExitVM)