org.vishia.cmd

Class JZtxtcmdFileset

java.lang.Object

org.vishia.cmd.JZtxtcmdFileset

public class JZtxtcmdFileset
extends java.lang.Object

A Fileset instance in a JZcmd script especially for zmake. It is assigned to a script variable with the syntax (See JZtxtcmdSyntax)

 Fileset myFileset = ( filepath1, filepath2 );
 

If the fileset is used in a target, it is associated to the target to get the absolute paths of the files temporary while processing that target.

The Zbnf syntax for parsing is defined as

 fileset::= { basepath =  |  ? , }.
 

It refers a FileSet.

See Also:

JZtxtcmdAccessFileset}. That class refers this and contains an access path, used as argument in a zmake call or as Argument build with call ...( name = Fileset accesspath&FilesetVariable) in a JZcmd script.

Field Summary

Fields

Modifier and Type	Field and Description
JZtxtcmdScript.UserFileset	data
static java.lang.String	sVersion Version, history and license.
(package private) JZtxtcmdExecuter.ExecuteLevel	zgenlevel

Constructor Summary

Constructors

Constructor and Description
JZtxtcmdFileset(JZtxtcmdExecuter.ExecuteLevel zgenlevel, JZtxtcmdScript.UserFileset data)

Method Summary

Modifier and Type	Method and Description
java.util.List<JZtxtcmdFilepath>	listFiles() Returns a new list of all JZtxtcmdFilepath with all files which are found in the file system in the given environment.
java.util.List<JZtxtcmdFilepath>	listFiles(JZtxtcmdFilepath accesspath, boolean expandFiles) Returns a new list of all JZtxtcmdFilepath with all files which are found in the file system in the given environment.
(package private) void	listFiles(java.util.List<JZtxtcmdFilepath> files, JZtxtcmdFilepath zgenAccesspath, boolean expandFiles)
java.util.List<JZtxtcmdFilepath>	listFilesExpanded() Returns a new list of all JZtxtcmdFilepath with all files which are found in the file system in the given environment.
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.

• 2014-06-22 Hartmut chg: creation of FileSet as extra class.
• 2014-06-14 Hartmut chg: ExecuteLevel implements FilePath.FilePathEnvAccess now, therewith a #listFiles(List, JZtxtcmdFilepath, boolean, org.vishia.util.FilePath.FilePathEnvAccess) does not need an accessPath, it may be empty respectively null.
• 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

zgenlevel

final JZtxtcmdExecuter.ExecuteLevel zgenlevel

data

public final JZtxtcmdScript.UserFileset data

Constructor Detail

JZtxtcmdFileset

public JZtxtcmdFileset(JZtxtcmdExecuter.ExecuteLevel zgenlevel,
                       JZtxtcmdScript.UserFileset data)

Method Detail

listFiles

void listFiles(java.util.List<JZtxtcmdFilepath> files,
               JZtxtcmdFilepath zgenAccesspath,
               boolean expandFiles)
        throws java.lang.NoSuchFieldException

Throws:

java.lang.NoSuchFieldException

listFiles

public java.util.List<JZtxtcmdFilepath> listFiles(JZtxtcmdFilepath accesspath,
                                                  boolean expandFiles)
                                           throws java.lang.NoSuchFieldException

Returns a new list of all JZtxtcmdFilepath with all files which are found in the file system in the given environment. The base path and local path is build from the members of the fileset and the #accesspath in that kind, that the shortest given local path is valid.

Parameters:

accesspath - The access path to the members of this fileset.

expandFiles - true then

Returns:

Throws:

java.lang.NoSuchFieldException

listFiles

public java.util.List<JZtxtcmdFilepath> listFiles()
                                           throws java.lang.NoSuchFieldException

Returns a new list of all JZtxtcmdFilepath with all files which are found in the file system in the given environment. The base path and local path is build from the members of the fileset in that kind, that the shortest given local path is valid.

Returns:

Throws:

java.lang.NoSuchFieldException

listFilesExpanded

public java.util.List<JZtxtcmdFilepath> listFilesExpanded()
                                                   throws java.lang.NoSuchFieldException

Returns a new list of all JZtxtcmdFilepath with all files which are found in the file system in the given environment. The base path and local path is build from the members of the fileset in that kind, that the shortest given local path is valid.

Returns:

Throws:

java.lang.NoSuchFieldException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object