org.vishia.util

Class FilepathFilter

java.lang.Object

org.vishia.util.FilepathFilter

All Implemented Interfaces:

java.io.FilenameFilter

public class FilepathFilter
extends java.lang.Object
implements java.io.FilenameFilter

This class helps to check whether a String given path and name matches to a mask String. It can be used for file paths especially but for any other path too. It is similar to FilenameFilter or java.io.FilenFilter but deals with CharSequences exclusively. The constructor prepares a String given path mask (with wild cards). The methods

• checkDir(CharSequence)
• checkName(String)

checks whether a path matches to the mask.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	FilepathFilter.NameFilter
(package private) static class	FilepathFilter.PathFilter

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	bAllTree If set then the path contains path/before/** /path/after.
(package private) java.util.List<FilepathFilter.NameFilter>	listExcludeNameFilter One or more entries for checking excluding the file name or null to exlude nothing.
(package private) java.util.List<FilepathFilter.NameFilter>	listNameFilter One or more entries for checking the file name or null to accept all names.
(package private) FilepathFilter.NameFilter	nameFilter Only one name possiblity.
(package private) FilepathFilter.PathFilter	pathFilter
static java.lang.String	version Version, history and license.

Constructor Summary

Constructors

Constructor and Description
FilepathFilter(java.lang.CharSequence mask) Creates an instance which can check whether any path or name matches to the given path.

Method Summary

Modifier and Type	Method and Description
boolean	accept(java.io.File dir, java.lang.String name)
private static void	check(boolean result)
boolean	checkDir(java.lang.CharSequence sPath) Checks whether a given directory path matches to the mask.
boolean	checkName(java.lang.String name) Checks whether a given name matches to the mask.
static void	test() This routine tests some examples.

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final java.lang.String version

Version, history and license.

• 2015-09-06 Hartmut created, The concept of such an filter was born for C programming since about 1990. The "filelist.exe" has used such an adequate algorithm. The method FileFunctions.addFileToList(String, List) and its derived methods have used an adequate algorithm. The idea to mark a deeper directory tree with "/** /" is an old idea. Now this algorithm has a frame in a class.

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

pathFilter

final FilepathFilter.PathFilter pathFilter

nameFilter

final FilepathFilter.NameFilter nameFilter

Only one name possiblity. Let the listNameFilter null, saves memory and time.

listNameFilter

final java.util.List<FilepathFilter.NameFilter> listNameFilter

One or more entries for checking the file name or null to accept all names.

listExcludeNameFilter

final java.util.List<FilepathFilter.NameFilter> listExcludeNameFilter

One or more entries for checking excluding the file name or null to exlude nothing.

bAllTree

final boolean bAllTree

If set then the path contains path/before/** /path/after. It means more levels are accepted (like 'recursively')

Constructor Detail

FilepathFilter

public FilepathFilter(java.lang.CharSequence mask)

Creates an instance which can check whether any path or name matches to the given path. The mask can contain:

• A directory and a name part. The name part is all after the last "/".
• If the mask ends with "/" then checkName(String) returns true for any name. All names matches.
• If the mask does not contain a "/" it can only check names. The checkDir(CharSequence) returns true in an case.
• The name part can contain up to two wildcards in form of "*". It separates the name in a start, middle and end part.
  • path/start*middle*end
  • path/*middle*end
  • path/*end
  • path/start*
  • path/start*end
  A name matches if it starts with the start, contains the middle after the start and before the end part, and ends with the end. If one of the parts are empty, it is not tested.
  • Example *.txt: The name should end with ".txt".
  • Example my*year*.txt: The name "myear_1984.txt" does not match. It starts with "my", contains "year" but it should contain "year" after "my".
• The name part can contain of several possibilities. Then the name part should start with : , any further name part should start with a next : . It is possible to write or not write a space before and after ':' for better readability.
  • path/ : *.txt : *.log: 2 possibilities of names.
  • : *.txt : *.log: 2 possibilities of names, no directory path.
• A name part can start with a second :, then it is an exclusive mask. The second ':' should be written without following space!
  • : save* : :*.bak: All files "save*" but not "*.bak"-files.
  • : :*.bak: All files exclusively "*.bak"
• The path can contain a wildcard in form path/part**end/end, usual in form start/** /end:
  • ** /name: All directories in the tree.
  • projectX/** /src* /name: All directories below "projectX" which starts with "src"

Parameters:

mask -

Method Detail

checkName

public boolean checkName(java.lang.String name)

Checks whether a given name matches to the mask. It use only the name part of the mask.

Parameters:

name - given name

Returns:

true if it matches.

checkDir

public boolean checkDir(java.lang.CharSequence sPath)

Checks whether a given directory path matches to the mask. It does not use the name part of the mask.

Parameters:

sPath -

Returns:

true if it matches.

accept

public boolean accept(java.io.File dir,
                      java.lang.String name)

Specified by:

accept in interface java.io.FilenameFilter

check

private static void check(boolean result)

test

public static void test()

This routine tests some examples. It is able to start with a JZcmd script contained in this file: Invoke

 JZcmd /path/to/srcJava_vishiaBase/org/vishia/util/FilepathFilter.java