AbstractFileInfo (SKB Base 0.2.0 API)

Object
- AbstractFileInfo

Direct Known Subclasses:

FileSource, FileTarget
```
public abstract class AbstractFileInfo
extends Object
```
An abstract file info implementation that can be configured for use as source or target.

Since:

v0.0.7

Version:

v0.2.0 build 170404 (04-Apr-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AbstractFileInfo.Options
Options for an asString method

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractFileInfo.Options` Options for an asString method

Field Summary

Fields
Modifier and Type	Field and Description
`protected AbstractFileInfo.Options`	`asStringOpt` Option for the return value of asString method.
`protected IsErrorSetFT`	`errors` Local list of errors collected during process, cleared for every new validation call.
`protected File`	`file` The underlying file object for the file name.
`protected URL`	`url` The underlying URL object for the file name.

Constructor Summary

Constructors
Constructor and Description
`AbstractFileInfo(File file)` Creates a new file info object from an existing File object.
`AbstractFileInfo(File file, boolean doValidate)` Creates a new file info object from an existing File object with optional validation.
`AbstractFileInfo(File file, String setRoot)` Creates a new file info object from an existing File object with a set-as-root directory.
`AbstractFileInfo(String fileName)` Creates a new file info object from a file name.
`AbstractFileInfo(String fileName, InfoLocationOptions option)` Creates a new file info object from a file name with options.
`AbstractFileInfo(String directory, String fileName)` Creates a new file info object from a path and a file name.
`AbstractFileInfo(String directory, String fileName, InfoLocationOptions option)` Creates a new file info object from a path and a file name with options.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`File`	`asFile()` Returns the file info object name as File object
`URL`	`asURL()` Returns the file info object name as URL object.
`String`	`getAbsoluteName()` Returns the absolute name of the file with all path information and the file (with extension).
`String`	`getAbsolutePath()` Returns the absolute path of the file, without the file name
`String`	`getBaseFileName()` Returns the base name of the file name of the object.
`String`	`getFileExtension()` Returns the file extension of the file name, without the leading dot.
`String`	`getFullFileName()` Returns the full file name (base name plus dot plus extension).
`String`	`getRootPath()` Returns the root path which is either the absolute path or (if any directory is set and `getSetRootPath()` returns not null) the path to the set-as-root path
`String`	`getSetRootName()` Returns the path and file elements for the set-as-root path of the file if a directory was explicitly given to one of the constructors.
`String`	`getSetRootPath()` Returns a path set-as-root to the file if a directory was explicitly given to one of the constructors.
`protected void`	`init(File file, String directory, String fileName, InfoLocationOptions option)` Initialize the file info object with any parameters presented by the constructors.
`boolean`	`isValid()` Flag reporting on the validation.
`protected void`	`reset()` Resets all local members to null, except for the error.
`void`	`setAsStringOption(AbstractFileInfo.Options option)` Sets the option for an asString method
`protected boolean`	`testFile(File file)` Test a file for several conditions (does exist, is not hidden etc).
`String`	`toString()`
`protected boolean`	`tryFS(String directory, String fileName)` Try to locate a file in the file system.
`protected boolean`	`tryResource(String directory, String fileName)` Try to locate a file as resource.
`protected abstract ValidationOptions`	`valOption()` Returns the validation option which makes this abstract implementation a info object or target or both.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - file
```
protected File file
```
    The underlying file object for the file name.
  - url
```
protected URL url
```
    The underlying URL object for the file name.
  - errors
```
protected final IsErrorSetFT errors
```
    Local list of errors collected during process, cleared for every new validation call.
  - asStringOpt
```
protected AbstractFileInfo.Options asStringOpt
```
    Option for the return value of asString method.
- Constructor Detail
  - AbstractFileInfo
```
public AbstractFileInfo(File file,
                        boolean doValidate)
```
    Creates a new file info object from an existing File object with optional validation.
    
    Parameters:
    
    file - existing file object
    
    doValidate - true if internal validation is required, false otherwise (for instance if the file object comes from another loader). If validation is set to false and the input argument for file is not valid, the behavior of this object and anyone using it is unpredictable. If validation is set to false a null validation and a validation of the getURI method of the file is still run by the constructor.
  - AbstractFileInfo
```
public AbstractFileInfo(File file,
                        String setRoot)
```
    Creates a new file info object from an existing File object with a set-as-root directory. The file parameter will not be tested except for null and problems creating a URL.
    
    Parameters:
    
    file - existing file object
    
    setRoot - set-as-root directory
  - AbstractFileInfo
```
public AbstractFileInfo(File file)
```
    Creates a new file info object from an existing File object.
    
    Parameters:
    
    file - existing file object
  - AbstractFileInfo
```
public AbstractFileInfo(String fileName)
```
    Creates a new file info object from a file name. This constructor will try to locate the file as resource first and in the file system next.
    
    Parameters:
    
    fileName - name of the file. The file name must include a path that is accessible. The file name must include path information if it is not in the root path. Path information can be relative to any path in the class path.
  - AbstractFileInfo
```
public AbstractFileInfo(String fileName,
                        InfoLocationOptions option)
```
    Creates a new file info object from a file name with options.
    
    Parameters:
    
    fileName - name of the file. The file name must include a path that is accessible. The file name must include path information if it is not in the root path. Path information can be relative to any path in the class path.
    
    option - an option on how to locate the file
  - AbstractFileInfo
```
public AbstractFileInfo(String directory,
                        String fileName)
```
    Creates a new file info object from a path and a file name. This constructor will try to locate the file as resource first and in the file system next.
    
    Parameters:
    
    directory - a directory in which the file can be found. The directory can be absolute or relative to any directory in the class path.
    
    fileName - the file name to locate
  - AbstractFileInfo
```
public AbstractFileInfo(String directory,
                        String fileName,
                        InfoLocationOptions option)
```
    Creates a new file info object from a path and a file name with options.
    
    Parameters:
    
    directory - directory a directory in which the file can be found. The directory can be absolute or relative to any directory in the class path.
    
    fileName - the file name to locate
    
    option - an option on how to locate the file
- Method Detail
  - reset
```
protected void reset()
```
    Resets all local members to null, except for the error.
  - init
```
protected void init(File file,
                    String directory,
                    String fileName,
                    InfoLocationOptions option)
```
    Initialize the file info object with any parameters presented by the constructors.
    
    Parameters:
    
    file - a file with all information
    
    directory - a directory to locate a file in
    
    fileName - a file name with or without path information
    
    option - an option on how to locate the file (not used if parameter file is set)
  - tryFS
```
protected final boolean tryFS(String directory,
                              String fileName)
```
    Try to locate a file in the file system.
    
    Parameters:
    
    directory - a directory to locate the file in
    
    fileName - a file name with optional path information
    
    Returns:
    
    true if the file was found, false otherwise
  - tryResource
```
protected final boolean tryResource(String directory,
                                    String fileName)
```
    Try to locate a file as resource.
    
    Parameters:
    
    directory - a directory to locate the file in
    
    fileName - a file name with optional path information
    
    Returns:
    
    true if the file was found, false otherwise
  - testFile
```
protected final boolean testFile(File file)
```
    Test a file for several conditions (does exist, is not hidden etc).
    
    Parameters:
    
    file - file object to test
    
    Returns:
    
    true if object points to an existing, non-hidden, readable/writable (according to options) file, false otherwise
  - asFile
```
public File asFile()
```
    Returns the file info object name as File object
    
    Returns:
    
    file object, null if none was created during initialization (then the file info object is only accessible as resource from URL)
  - asURL
```
public URL asURL()
```
    Returns the file info object name as URL object.
    
    Returns:
    
    URL object if the file info object is valid, null otherwise
  - getFileExtension
```
public String getFileExtension()
```
    Returns the file extension of the file name, without the leading dot.
    
    Returns:
    
    file extension if the file info object is valid, null otherwise
  - getBaseFileName
```
public String getBaseFileName()
```
    Returns the base name of the file name of the object.
    
    Returns:
    
    base name if the file info object is valid, null otherwise
  - getFullFileName
```
public String getFullFileName()
```
    Returns the full file name (base name plus dot plus extension).
    
    Returns:
    
    full file name if the file info object is valid, null otherwise
  - getAbsolutePath
```
public String getAbsolutePath()
```
    Returns the absolute path of the file, without the file name
    
    Returns:
    
    absolute path if the file info object is valid, null otherwise
  - getAbsoluteName
```
public String getAbsoluteName()
```
    Returns the absolute name of the file with all path information and the file (with extension).
    
    Returns:
    
    the absolute name of the file with all part elements if the file info object is valid, null otherwise
  - getSetRootPath
```
public String getSetRootPath()
```
    Returns a path set-as-root to the file if a directory was explicitly given to one of the constructors.
    
    Returns:
    
    the relative path if the file info object is valid and a relative path was given to a constructor as directory, null otherwise
  - getSetRootName
```
public String getSetRootName()
```
    Returns the path and file elements for the set-as-root path of the file if a directory was explicitly given to one of the constructors.
    
    Returns:
    
    set-as-root-file name if the file info object is valid and a relative path was given to a constructor as directory, null otherwise
  - getRootPath
```
public String getRootPath()
```
    Returns the root path which is either the absolute path or (if any directory is set and getSetRootPath() returns not null) the path to the set-as-root path
    
    Returns:
    
    absolute or prefix path for the set-as-root path if the file info object is valid and a relative path was given to a constructor as directory, null otherwise
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isValid
```
public boolean isValid()
```
    Flag reporting on the validation.
    
    Returns:
    
    true if the validation was successful (error list is of size 0), false otherwise (error list is of size greater than 0)
  - valOption
```
protected abstract ValidationOptions valOption()
```
    Returns the validation option which makes this abstract implementation a info object or target or both.
    
    Returns:
    
    validation option, if not set (null) will create init errors
  - setAsStringOption
```
public void setAsStringOption(AbstractFileInfo.Options option)
```
    Sets the option for an asString method
    
    Parameters:
    
    option - new option, only set if not null

Class AbstractFileInfo

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

file

url

errors

asStringOpt

Constructor Detail

AbstractFileInfo

AbstractFileInfo

AbstractFileInfo

AbstractFileInfo

AbstractFileInfo

AbstractFileInfo

AbstractFileInfo

Method Detail

reset

init

tryFS

tryResource

testFile

asFile

asURL

getFileExtension

getBaseFileName

getFullFileName

getAbsolutePath

getAbsoluteName

getSetRootPath

getSetRootName

getRootPath

toString

isValid

valOption

setAsStringOption