AbstractDirectoryInfo (SKB Base 0.2.0 API)

Object
- AbstractDirectoryInfo

Direct Known Subclasses:

DirectorySource, DirectoryTarget
```
public abstract class AbstractDirectoryInfo
extends Object
```
An abstract directory info implementation that can be configured for use as source or target.

Since:

v0.0.8

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 AbstractDirectoryInfo.Options
Options for an asString method

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected AbstractDirectoryInfo.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 directory.
`protected URL`	`url` The underlying URL object for the directory.

Constructor Summary

Constructors
Constructor and Description
`AbstractDirectoryInfo(String directory)` Creates a new directory info object from a directory name.
`AbstractDirectoryInfo(String directory, InfoLocationOptions option)` Creates a new directory info object from a directory name with options.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`File`	`asFile()` Returns the directory info object name as File object
`URL`	`asURL()` Returns the directory info object name as URL object.
`String`	`getFullDirecoryName()` Returns the full directory name.
`String`	`getSetRootPath()` Returns a path set-as-root to the directory.
`protected void`	`init(String directory, InfoLocationOptions option)` Initialize the directory 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(AbstractDirectoryInfo.Options option)` Sets the option for an asString method
`protected boolean`	`testDirectory(File directory)` Test a directory for several conditions (does exist, is not hidden etc).
`protected boolean`	`tryCP(String directory)` Try to locate a directory using any directory given in the class path as set-root.
`protected boolean`	`tryFS(String directory)` Try to locate a directory in the file system.
`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, toString, wait, wait, wait

- Field Detail
  - file
```
protected File file
```
    The underlying file object for the directory.
  - url
```
protected URL url
```
    The underlying URL object for the directory.
  - errors
```
protected final IsErrorSetFT errors
```
    Local list of errors collected during process, cleared for every new validation call.
  - asStringOpt
```
protected AbstractDirectoryInfo.Options asStringOpt
```
    Option for the return value of asString method.
- Constructor Detail
  - AbstractDirectoryInfo
```
public AbstractDirectoryInfo(String directory)
```
    Creates a new directory info object from a directory name. This constructor will try to locate the directory in the class path first and in the file system next.
    
    Parameters:
    
    directory - name of the directory. Path information can be relative to any path in the class path.
  - AbstractDirectoryInfo
```
public AbstractDirectoryInfo(String directory,
                             InfoLocationOptions option)
```
    Creates a new directory info object from a directory name with options.
    
    Parameters:
    
    directory - name of the directory. Path information can be relative to any path in the class path.
    
    option - an option on how to locate the directory
- Method Detail
  - reset
```
protected void reset()
```
    Resets all local members to null, except for the error.
  - init
```
protected void init(String directory,
                    InfoLocationOptions option)
```
    Initialize the directory info object with any parameters presented by the constructors.
    
    Parameters:
    
    directory - a directory name
    
    option - an option on how to locate the directory
  - tryFS
```
protected final boolean tryFS(String directory)
```
    Try to locate a directory in the file system.
    
    Parameters:
    
    directory - the directory to locate
    
    Returns:
    
    true if the directory was found, false otherwise
  - tryCP
```
protected final boolean tryCP(String directory)
```
    Try to locate a directory using any directory given in the class path as set-root.
    
    Parameters:
    
    directory - the directory to locate
    
    Returns:
    
    true if the directory was found, false otherwise
  - testDirectory
```
protected final boolean testDirectory(File directory)
```
    Test a directory for several conditions (does exist, is not hidden etc).
    
    Parameters:
    
    directory - file object to test
    
    Returns:
    
    true if object points to an existing, non-hidden, readable/writable (according to options) directory, false otherwise
  - asFile
```
public File asFile()
```
    Returns the directory info object name as File object
    
    Returns:
    
    file object, null if none was created during initialization (no directory found)
  - asURL
```
public URL asURL()
```
    Returns the directory info object name as URL object.
    
    Returns:
    
    URL object if the directory info object is valid, null otherwise
  - getFullDirecoryName
```
public String getFullDirecoryName()
```
    Returns the full directory name.
    
    Returns:
    
    full directory name if the file info object is valid, null otherwise
  - getSetRootPath
```
public String getSetRootPath()
```
    Returns a path set-as-root to the directory.
    
    Returns:
    
    the relative path if input directory was not absolute, null otherwise
  - 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(AbstractDirectoryInfo.Options option)
```
    Sets the option for an asString method
    
    Parameters:
    
    option - new option, only set if not null

Class AbstractDirectoryInfo

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

file

url

errors

asStringOpt

Constructor Detail

AbstractDirectoryInfo

AbstractDirectoryInfo

Method Detail

reset

init

tryFS

tryCP

testDirectory

asFile

asURL

getFullDirecoryName

getSetRootPath

isValid

valOption

setAsStringOption