org.vishia.util

Class FileSet

java.lang.Object

org.vishia.util.FileSet

public final class FileSet
extends java.lang.Object

A Fileset instance contains some FilePath maybe with a common path. The method listFiles(List, FilePath, org.vishia.util.FilePath.FilePathEnvAccess, boolean) prepares a List of simple FilePath with resolved access- and common path and resolved variables.

Uml-Notation see Docu_UML_simpleNotation:

                FileSet
                    |------------commonpath------------>FilePath
                    |
                    |------------filesOfFileset-------*>FilePath
                                                        -drive:
                                                        -absPath: boolean
                                                        -basepath
                                                        -localdir
                                                        -name
                                                        -someFiles: boolean
                                                        -ext
 

Field Summary

Fields

Modifier and Type	Field and Description
private FilePath	commonPath From ZBNF basepath = <""?!
private java.util.List<FilePath>	filesOfFileset All entries of the file set how it is given in the users script.
static java.lang.String	sVersion Version, history and license.

Constructor Summary

Constructors

Constructor and Description
FileSet()

Method Summary

Modifier and Type	Method and Description
void	add_filePath(java.lang.String val)
void	listFiles(java.util.List<FilePath> files, FilePath accesspath, FilePath.FilePathEnvAccess env, boolean expandFiles) Builds a list of FilePath from the given fileSet.
private void	listFiles(java.util.List<FilePath> files, FilePath accesspath, FilePath.FilePathEnvAccess env, boolean expandFiles, int recursionCount) Called fro #listFiles(List, FilePath, FilePathEnvAccess, boolean)
void	set_commonPath(java.lang.String val)
java.lang.String	toString()

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.

• 2017-09-01 Hartmut new: A FilePath can refer a FileSet variable or especially a JZtxtcmdFileset variable. Then it is not a FileSet but it is a reference to an included FileSet. On FileSet#listFiles(List, FilePath, FilePathEnvAccess, boolean) it will be recognized and unpacked. It is on runtime. Note: On script compilation time the variable content may not existent yet. The variable is only given as String.
• 2014-06-22 Hartmut chg: creation of FileSet as extra class from JZtxtcmdFileset.
• 2014-03-07 created. From srcJava_Zbnf/org/vishia/zmake/ZmakeUserScript.UserFileset.

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

commonPath

private FilePath commonPath

From ZBNF basepath = <""?!prepSrcpath>. It is a part of the base path anyway. It may be absolute, but usually relative. If null then unused.

filesOfFileset

private final java.util.List<FilePath> filesOfFileset

All entries of the file set how it is given in the users script.

Constructor Detail

FileSet

public FileSet()

Method Detail

set_commonPath

public void set_commonPath(java.lang.String val)

add_filePath

public void add_filePath(java.lang.String val)

listFiles

public void listFiles(java.util.List<FilePath> files,
                      FilePath accesspath,
                      FilePath.FilePathEnvAccess env,
                      boolean expandFiles)
               throws java.lang.NoSuchFieldException

Builds a list of FilePath from the given fileSet. The new FilePath in files are absolute without a FilePath.scriptVariable and without FilePath.varChars and FilePath.varFileset. This relations are dissolved. if a file set is detect inside this fileset, it is expanded too. Only 100 nested filesets are possible (typically 1 or 2)

Parameters:

files - The new FilePath are added here.

accesspath - The access path is an additional part of a base path.

env - Access to variables and currDir of a JZtxtcmdExecuter or other environment

expandFiles - expands wildcards, if false, the wildcard remain in the path paprts.

Throws:

java.lang.NoSuchFieldException

listFiles

private void listFiles(java.util.List<FilePath> files,
                       FilePath accesspath,
                       FilePath.FilePathEnvAccess env,
                       boolean expandFiles,
                       int recursionCount)
                throws java.lang.NoSuchFieldException

Called fro #listFiles(List, FilePath, FilePathEnvAccess, boolean)

Parameters:

recursionCount - max. 100 recursions.

Throws:

java.lang.NoSuchFieldException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object