org.vishia.cmd

Class JZtxtcmdFilepath

java.lang.Object

org.vishia.cmd.JZtxtcmdFilepath

public final class JZtxtcmdFilepath
extends java.lang.Object

This class describes a Filepath instance in an executer level of JZcmd. The file entity can contain wild cards. It can refer to a variable which contains the base path. It may be a absolute or a relative path. It can have a base path and a local path part. This class contains the reference to the JZtxtcmdExecuter.ExecuteLevel where this variable is located and a reference to the JZtxtcmdScript.Filepath. The last one contains all information about the file entity. This class is used to get all presentation possibilities of the file. Therefore the current directory should be known which is given in the JZcmd executer level.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) FilePath	data
static int	version Version, history and license.
private JZtxtcmdExecuter.ExecuteLevel	zgenlevel Aggregation to a given UserFileset where this is member of.

Constructor Summary

Constructors

Constructor and Description
JZtxtcmdFilepath(JZtxtcmdExecuter.ExecuteLevel zgenlevel, FilePath filepath) Creates an instance with given data.
JZtxtcmdFilepath(JZtxtcmdExecuter.ExecuteLevel zgenlevel, JZtxtcmdFilepath src, JZtxtcmdFilepath commonPath, JZtxtcmdFilepath accessPath) Creates a JZcmdFilepath entry with an additonal pathbase.
JZtxtcmdFilepath(JZtxtcmdExecuter.ExecuteLevel zgenlevel, java.lang.String filepath) Creates an instance with given data.

Method Summary

Modifier and Type	Method and Description
java.lang.CharSequence	absbasepath() Assembles and returns the designated part from this Filepath as String or StringBuilder:: <&absbasepath()>.
java.lang.CharSequence	absbasepathW()
java.lang.CharSequence	absdir() Assembles and returns the designated part from this Filepath as String or StringBuilder:: <&path.absdir()>.
java.lang.CharSequence	absdirW()
java.lang.CharSequence	absfile() Assembles and returns the designated part from this Filepath as String or StringBuilder: <&path.absfile()>.
(package private) java.lang.CharSequence	absfileReplwildcard(FilePath replWildc) Returns the local file with replaced wildcard in the local dir.
java.lang.CharSequence	absfileW()
java.lang.CharSequence	absname() Assembles and returns the designated part from this Filepath as String or StringBuilder: <&data.absname()>.
java.lang.CharSequence	absnameW()
boolean	allTree() Returns true if the local path contains (ends with) "/**"
java.lang.CharSequence	base_localdir() Assembles and returns the designated part from this Filepath as String or StringBuilder: <&data.base_localdir()>.
java.lang.CharSequence	base_localdirW()
java.lang.CharSequence	base_localfile() Assembles and returns the designated part from this Filepath as String or StringBuilder: <&data.base_localfile()>.
java.lang.CharSequence	base_localfileW()
java.lang.CharSequence	basepath() Assembles and returns the designated part from this Filepath as String or StringBuilder: <&basepath()>.
java.lang.CharSequence	basepathW()
java.lang.CharSequence	dir() Assembles and returns the designated part from this Filepath as String or StringBuilder: <&path.dir()>.
java.lang.CharSequence	dirW()
java.lang.String	ext() Assembles and returns the extension from this Filepath as String..
java.lang.CharSequence	file() Assembles and returns the designated part from this Filepath as String or StringBuilder: <&data.file()>.
java.lang.CharSequence	file(java.lang.StringBuilder uRet, FilePath commonPath, FilePath accesspath)
java.lang.CharSequence	fileW()
java.lang.CharSequence	fileW(java.lang.StringBuilder uRet, FilePath commonPath, FilePath accesspath)
java.lang.CharSequence	localdir() Assembles and returns the designated part from this Filepath as String or StringBuilder: <&path.localdir()>.
java.lang.CharSequence	localdirW() Assembles and returns the designated part from this Filepath as String or StringBuilder: <&path.localDir()>.
java.lang.CharSequence	localfile() Assembles and returns the designated part from this Filepath as String or StringBuilder: <&path.localfile()>.
java.lang.CharSequence	localfileReplwildcard(java.lang.StringBuilder uRet, JZtxtcmdFilepath replWildc)
java.lang.CharSequence	localfileW()
java.lang.CharSequence	localname() Assembles and returns the designated part from this Filepath as String or StringBuilder: <&path.localname()>.
java.lang.CharSequence	localnameW()
java.lang.CharSequence	name() Returns the name from this Filepath as String.
java.lang.CharSequence	namext() Assembles and returns the designated part from this Filepath as String or StringBuilder: <&path.namext()>.
java.lang.CharSequence	pathname() Assembles and returns the designated part from this Filepath as String or StringBuilder: <&data.pathname()>.
java.lang.CharSequence	pathnameW()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final int version

Version, history and license.

• 2014-06-10 Hartmut chg: ExecuteLevel implements FilePath.FilePathEnvAccess now instead this, therewith a JZtxtcmdFileset#listFiles(List, JZtxtcmdFilepath, boolean, org.vishia.util.FilePath.FilePathEnvAccess) does not need an accessPath, it may be empty respectively null.
• 2014-03-07 Hartmut new: All capabilities from Zmake are joined here. Only one concept! This file was copied from srcJava_Zbnf/org/vishia/zmake/Userfilepath. The data of a file are referenced with data. The original fields are contained in JZtxtcmdScript.Filepath. Both are separated because the parts in JZcmdScript are set completely by parsing the script. This class contains the access methods which uses the reference zgenlevel.
• 2013-03-10 Hartmut new: FileFunctions.normalizePath(CharSequence) called in #absbasepath(CharSequence) offers the normalize path for all absolute file paths.
• 2013-03-10 Hartmut new: Replace wildcards: #absfile(JZtxtcmdFilepath) (TODO for some more access methods)
• 2013-02-12 Hartmut chg: dissolved from inner class in ZmakeUserScript

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 ist 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

private final JZtxtcmdExecuter.ExecuteLevel zgenlevel

Aggregation to a given UserFileset where this is member of. A UserFileset#commonBasepath which is valid for all files of the #itsFileset is gotten from there, if it is given (not null).
This aggregation can be null, especially if this is a member of a list returned from UserTarget#allInputFiles() if more as one fileSets are used as the target's input or an accessPath is given. In that kind the UserFileset#filesOfFileset are cloned without this aggregation and the commonBasePath and the accessPath are part of the basepath() of this.

data

final FilePath data

Constructor Detail

JZtxtcmdFilepath

JZtxtcmdFilepath(JZtxtcmdExecuter.ExecuteLevel zgenlevel,
                 FilePath filepath)

Creates an instance with given data.

Parameters:

zgenlevel -

filepath - given data

JZtxtcmdFilepath

JZtxtcmdFilepath(JZtxtcmdExecuter.ExecuteLevel zgenlevel,
                 java.lang.String filepath)

Creates an instance with given data. Note: it is package private because only used from JZtxtcmdExecuter. Use there the construct Filepath: < stringexpression>

Parameters:

zgenlevel -

filepath - given data

JZtxtcmdFilepath

JZtxtcmdFilepath(JZtxtcmdExecuter.ExecuteLevel zgenlevel,
                 JZtxtcmdFilepath src,
                 JZtxtcmdFilepath commonPath,
                 JZtxtcmdFilepath accessPath)
          throws java.lang.NoSuchFieldException

Creates a JZcmdFilepath entry with an additonal pathbase. if the basepath of src is given and the pathbase0 is given, both are joined: pathbase0/src.pathbase.

Parameters:

zgenlevel - Reference to the zgenlevel, necessary for the current directory

src - The source (clone source)

basepath - An additional basepath usual stored as basepath=path, ... in a fileset, maybe null

pathbase0 - additional pre-pathbase before base, maybe null

Throws:

java.lang.NoSuchFieldException - if the basepath contains a scriptvariable and this scriptvariable was not found.

Method Detail

absbasepath

public java.lang.CharSequence absbasepath()
                                   throws java.lang.NoSuchFieldException

Assembles and returns the designated part from this Filepath as String or StringBuilder:: <&absbasepath()>.

Returns:

the whole path inclusive a given general path in a UserFileSet as absolute path.

Throws:

java.lang.NoSuchFieldException - if the basepath contains a scriptvariable and this scriptvariable was not found.

absbasepathW

public java.lang.CharSequence absbasepathW()
                                    throws java.lang.NoSuchFieldException

Throws:

java.lang.NoSuchFieldException

absdir

public java.lang.CharSequence absdir()
                              throws java.lang.NoSuchFieldException

Assembles and returns the designated part from this Filepath as String or StringBuilder:: <&path.absdir()>.

Returns:

the whole path to the parent of this file inclusive a given general path in a UserFileSet. The path is absolute. If it is given as relative path, the general current directory of the script is used.

Throws:

java.lang.NoSuchFieldException - if the basepath contains a scriptvariable and this scriptvariable was not found.

absdirW

public java.lang.CharSequence absdirW()
                               throws java.lang.NoSuchFieldException

Throws:

java.lang.NoSuchFieldException

absname

public java.lang.CharSequence absname()
                               throws java.lang.NoSuchFieldException

Assembles and returns the designated part from this Filepath as String or StringBuilder: <&data.absname()>.

Returns:

the whole path with file name but without extension inclusive a given general path in a UserFileSet. Either as absolute or as relative path.

Throws:

java.lang.NoSuchFieldException - if the basepath contains a scriptvariable and this scriptvariable was not found.

absnameW

public java.lang.CharSequence absnameW()
                                throws java.lang.NoSuchFieldException

Throws:

java.lang.NoSuchFieldException

absfile

public java.lang.CharSequence absfile()
                               throws java.lang.NoSuchFieldException

Assembles and returns the designated part from this Filepath as String or StringBuilder: <&path.absfile()>.

Returns:

the whole path inclusive a given general path . The path is absolute. If it is given as relative path, the general current directory of the script is used.

Throws:

java.lang.NoSuchFieldException - if the basepath contains a scriptvariable and this scriptvariable was not found.

absfileW

public java.lang.CharSequence absfileW()
                                throws java.lang.NoSuchFieldException

Throws:

java.lang.NoSuchFieldException

basepath

public java.lang.CharSequence basepath()
                                throws java.lang.NoSuchFieldException

Assembles and returns the designated part from this Filepath as String or StringBuilder: <&basepath()>.

Returns:

the whole base path inclusive a given general path in a UserFileSet. till a ':' in the input path or an empty string. Either as absolute or as relative path how it is given.

Throws:

java.lang.NoSuchFieldException - if the basepath contains a scriptvariable and this scriptvariable was not found.

basepathW

public java.lang.CharSequence basepathW()
                                 throws java.lang.NoSuchFieldException

Throws:

java.lang.NoSuchFieldException

dir

public java.lang.CharSequence dir()
                           throws java.lang.NoSuchFieldException

Assembles and returns the designated part from this Filepath as String or StringBuilder: <&path.dir()>.

Returns:

the whole path to the parent of this file inclusive a given general path in a UserFileSet. The path is absolute or relative like it is given.

Throws:

java.lang.NoSuchFieldException - if the basepath contains a scriptvariable and this scriptvariable was not found.

dirW

public java.lang.CharSequence dirW()
                            throws java.lang.NoSuchFieldException

Throws:

java.lang.NoSuchFieldException

pathname

public java.lang.CharSequence pathname()
                                throws java.lang.NoSuchFieldException

Assembles and returns the designated part from this Filepath as String or StringBuilder: <&data.pathname()>.

Returns:

the whole path with file name but without extension inclusive a given general path in a UserFileSet. The path is absolute or relative like it is given.

Throws:

java.lang.NoSuchFieldException - if the basepath contains a scriptvariable and this scriptvariable was not found.

pathnameW

public java.lang.CharSequence pathnameW()
                                 throws java.lang.NoSuchFieldException

Throws:

java.lang.NoSuchFieldException

file

public java.lang.CharSequence file()
                            throws java.lang.NoSuchFieldException

Assembles and returns the designated part from this Filepath as String or StringBuilder: <&data.file()>.

Returns:

the whole path with file name and extension. The path is absolute or relative like it is given.

Throws:

java.lang.NoSuchFieldException - if the basepath contains a scriptvariable and this scriptvariable was not found.

fileW

public java.lang.CharSequence fileW()
                             throws java.lang.NoSuchFieldException

Throws:

java.lang.NoSuchFieldException

file

public java.lang.CharSequence file(java.lang.StringBuilder uRet,
                                   FilePath commonPath,
                                   FilePath accesspath)
                            throws java.lang.NoSuchFieldException

Throws:

java.lang.NoSuchFieldException

fileW

public java.lang.CharSequence fileW(java.lang.StringBuilder uRet,
                                    FilePath commonPath,
                                    FilePath accesspath)
                             throws java.lang.NoSuchFieldException

Throws:

java.lang.NoSuchFieldException

base_localdir

public java.lang.CharSequence base_localdir()
                                     throws java.lang.NoSuchFieldException

Assembles and returns the designated part from this Filepath as String or StringBuilder: <&data.base_localdir()>.

Returns:

the basepath:localpath in a UserFileSet with given wildcards inclusive a given general path. The path is absolute or relative like it is given.

Throws:

java.lang.NoSuchFieldException - if the basepath contains a scriptvariable and this scriptvariable was not found.

base_localdirW

public java.lang.CharSequence base_localdirW()
                                      throws java.lang.NoSuchFieldException

Throws:

java.lang.NoSuchFieldException

base_localfile

public java.lang.CharSequence base_localfile()
                                      throws java.lang.NoSuchFieldException

Assembles and returns the designated part from this Filepath as String or StringBuilder: <&data.base_localfile()>.

Returns:

the basepath:localpath/name.ext in a UserFileSet with given wildcards inclusive a given general path. The path is absolute or relative like it is given.

Throws:

java.lang.NoSuchFieldException - if the basepath contains a scriptvariable and this scriptvariable was not found.

base_localfileW

public java.lang.CharSequence base_localfileW()
                                       throws java.lang.NoSuchFieldException

Throws:

java.lang.NoSuchFieldException

localdir

public java.lang.CharSequence localdir()
                                throws java.lang.NoSuchFieldException

Assembles and returns the designated part from this Filepath as String or StringBuilder: <&path.localdir()>.

Returns:

the local path part of the directory of the file without ending slash. If no directory is given in the local part, it returns ".".

Throws:

java.lang.NoSuchFieldException - if the basepath contains a scriptvariable and this scriptvariable was not found.

localdirW

public java.lang.CharSequence localdirW()
                                 throws java.lang.NoSuchFieldException

Assembles and returns the designated part from this Filepath as String or StringBuilder: <&path.localDir()>.

Returns:

the local path part with file without extension.

Throws:

java.lang.NoSuchFieldException - if the basepath contains a scriptvariable and this scriptvariable was not found.

localname

public java.lang.CharSequence localname()
                                 throws java.lang.NoSuchFieldException

Assembles and returns the designated part from this Filepath as String or StringBuilder: <&path.localname()>.

Returns:

the local path part with file without extension.

Throws:

java.lang.NoSuchFieldException - if the basepath contains a scriptvariable and this scriptvariable was not found.

localnameW

public java.lang.CharSequence localnameW()
                                  throws java.lang.NoSuchFieldException

Throws:

java.lang.NoSuchFieldException

localfile

public java.lang.CharSequence localfile()
                                 throws java.lang.NoSuchFieldException

Assembles and returns the designated part from this Filepath as String or StringBuilder: <&path.localfile()>.

Returns:

the local path to this file inclusive name and extension of the file.

Throws:

java.lang.NoSuchFieldException

localfileW

public java.lang.CharSequence localfileW()
                                  throws java.lang.NoSuchFieldException

Throws:

java.lang.NoSuchFieldException

allTree

public boolean allTree()

Returns true if the local path contains (ends with) "/**"

Returns:

absfileReplwildcard

java.lang.CharSequence absfileReplwildcard(FilePath replWildc)
                                    throws java.lang.NoSuchFieldException

Returns the local file with replaced wildcard in the local dir. See {@link #addLocalNameReplwildcard(StringBuilder, FilePath).

Parameters:

replWildc - With them localdir and name a wildcard in this.localdir and this.name is replaced.

Returns:

the whole path inclusive a given general path . The path is absolute. If it is given as relative path, the general current directory of the script is used.

Throws:

java.lang.NoSuchFieldException

localfileReplwildcard

public java.lang.CharSequence localfileReplwildcard(java.lang.StringBuilder uRet,
                                                    JZtxtcmdFilepath replWildc)

name

public java.lang.CharSequence name()

Returns the name from this Filepath as String.

Returns:

the name of the file without extension.

namext

public java.lang.CharSequence namext()

Assembles and returns the designated part from this Filepath as String or StringBuilder: <&path.namext()>.

Returns:

the file name with extension.

ext

public java.lang.String ext()

Assembles and returns the extension from this Filepath as String..

Returns:

the file extension.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object