FileToolbox

java.lang.Object
- org.trianacode.taskgraph.tool.FileToolbox

All Implemented Interfaces:: Toolbox

public class FileToolbox
extends java.lang.Object
implements Toolbox

Class Description Here...

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String[]`	`excludedDirectories`
`static java.lang.String`	`EXT_JAVA_CLASS`
`static java.lang.String`	`EXT_TASKGRAPH`
`static java.lang.String[]`	`extensions`
`static java.lang.String`	`HELP_DIR`
`static java.lang.String`	`LIB_DIR`
`static java.lang.String`	`NATIVE_DIR` constants for directory names where native and java libs are stored in a toolbox.
`static java.lang.String[]`	`nativeDirs`
`static java.lang.String`	`NUX_32_DIR`
`static java.lang.String`	`NUX_64_DIR`
`static java.lang.String`	`OSX_32_DIR`
`static java.lang.String`	`OSX_64_DIR`
`static java.lang.String`	`OSX_DIR`
`static java.lang.String`	`WIN_32_DIR`
`static java.lang.String`	`WIN_64_DIR`

Constructor Summary

Constructors
Constructor and Description
`FileToolbox(java.io.File file)`
`FileToolbox(java.lang.String path, java.lang.String name, TrianaProperties properties)`
`FileToolbox(java.lang.String path, TrianaProperties properties)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addTool(Tool tool)`
`protected Tool`	`createTool(java.lang.String className)` instantiate a tool
`Tool`	`deleteTool(java.lang.String name)` not always supported.
`java.lang.ClassLoader`	`getClassLoader()`
`java.lang.String`	`getClassPath()`
`java.io.File`	`getFile(java.lang.String relativePath)` attempt to get a local file with a path that is a child of the root of the toolbox
`java.util.List<java.lang.String>`	`getLibPaths()` get relative paths pointing to library files (.class, .jar)
`java.lang.String`	`getName()` a name for the toolbox.
`java.lang.String`	`getPath()` a path for the toolbox.
`TrianaProperties`	`getProperties()`
`Tool`	`getTool(java.lang.String name)` get a tool using tool.getQualifiedToolName()
`java.util.List<Tool>`	`getTools()` get all tools
`java.util.List<Tool>`	`getTools(java.net.URL url)` get tools that share the same definition path
`protected org.thinginitself.streamable.Streamable`	`getToolStream(java.net.URL url)` get a streamable from a tool URL
`java.lang.String`	`getType()` a type for the toolbox.
`java.util.List<java.lang.String>`	`getVisibleRoots()` get a list of local files that can browsed by a user.
`void`	`loadTools()` load all tools
`void`	`refresh(java.net.URL url)` relaod tools at a particular URL (this is the tool.getDefinitionPath())
`Tool`	`removeTool(java.lang.String name)` could be called deregisterTool
`protected java.util.Map<java.lang.String,Tool>`	`resolveTools()`
`protected java.util.List<Tool>`	`resolveTools(java.net.URL url)` resolve tools from a particular URL.
`void`	`setName(java.lang.String name)`
`void`	`setProperties(TrianaProperties properties)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NATIVE_DIR
```
public static final java.lang.String NATIVE_DIR
```
    constants for directory names where native and java libs are stored in a toolbox. For a toolbox to know where these things are and have them loaded, and exposed, these naming convention must be followed.
    The OS-specific dir names should all be within a 'nativ' dir.
    
    See Also:
    Constant Field Values
  - WIN_32_DIR
```
public static final java.lang.String WIN_32_DIR
```
    See Also:
    Constant Field Values
  - WIN_64_DIR
```
public static final java.lang.String WIN_64_DIR
```
    See Also:
    Constant Field Values
  - OSX_DIR
```
public static final java.lang.String OSX_DIR
```
    See Also:
    Constant Field Values
  - OSX_32_DIR
```
public static final java.lang.String OSX_32_DIR
```
    See Also:
    Constant Field Values
  - OSX_64_DIR
```
public static final java.lang.String OSX_64_DIR
```
    See Also:
    Constant Field Values
  - NUX_32_DIR
```
public static final java.lang.String NUX_32_DIR
```
    See Also:
    Constant Field Values
  - NUX_64_DIR
```
public static final java.lang.String NUX_64_DIR
```
    See Also:
    Constant Field Values
  - LIB_DIR
```
public static final java.lang.String LIB_DIR
```
    See Also:
    Constant Field Values
  - HELP_DIR
```
public static final java.lang.String HELP_DIR
```
    See Also:
    Constant Field Values
  - EXT_TASKGRAPH
```
public static final java.lang.String EXT_TASKGRAPH
```
    See Also:
    Constant Field Values
  - EXT_JAVA_CLASS
```
public static final java.lang.String EXT_JAVA_CLASS
```
    See Also:
    Constant Field Values
  - excludedDirectories
```
public static java.lang.String[] excludedDirectories
```
  - extensions
```
public static java.lang.String[] extensions
```
  - nativeDirs
```
public static java.lang.String[] nativeDirs
```
- Constructor Detail
  - FileToolbox
```
public FileToolbox(java.lang.String path,
           java.lang.String name,
           TrianaProperties properties)
```
  - FileToolbox
```
public FileToolbox(java.lang.String path,
           TrianaProperties properties)
```
  - FileToolbox
```
public FileToolbox(java.io.File file)
```
- Method Detail
  - getProperties
```
public TrianaProperties getProperties()
```
    Specified by:
    
    getProperties in interface Toolbox
  - setProperties
```
public void setProperties(TrianaProperties properties)
```
    Specified by:
    
    setProperties in interface Toolbox
  - getClassLoader
```
public java.lang.ClassLoader getClassLoader()
```
  - getLibPaths
```
public java.util.List<java.lang.String> getLibPaths()
```
    get relative paths pointing to library files (.class, .jar)
    
    Returns:
  - getVisibleRoots
```
public java.util.List<java.lang.String> getVisibleRoots()
```
    get a list of local files that can browsed by a user. Any file not equal to or a child of one of these strings will have access denied.
    
    Returns:
  - getFile
```
public java.io.File getFile(java.lang.String relativePath)
```
    attempt to get a local file with a path that is a child of the root of the toolbox
    
    Parameters:
    relativePath -
    
    Returns:
  - getClassPath
```
public java.lang.String getClassPath()
```
  - loadTools
```
public void loadTools()
               throws java.lang.Exception
```
    Description copied from interface: Toolbox
    
    load all tools
    
    Specified by:
    
    loadTools in interface Toolbox
    
    Throws:
    
    java.lang.Exception
  - refresh
```
public void refresh(java.net.URL url)
             throws java.lang.Exception
```
    Description copied from interface: Toolbox
    
    relaod tools at a particular URL (this is the tool.getDefinitionPath())
    
    Specified by:
    
    refresh in interface Toolbox
    
    Throws:
    
    java.lang.Exception
  - getTools
```
public java.util.List<Tool> getTools(java.net.URL url)
```
    Description copied from interface: Toolbox
    
    get tools that share the same definition path
    
    Specified by:
    
    getTools in interface Toolbox
    
    Returns:
  - getTools
```
public java.util.List<Tool> getTools()
```
    Description copied from interface: Toolbox
    
    get all tools
    
    Specified by:
    
    getTools in interface Toolbox
    
    Returns:
  - addTool
```
public void addTool(Tool tool)
```
    Specified by:
    
    addTool in interface Toolbox
  - getTool
```
public Tool getTool(java.lang.String name)
```
    Description copied from interface: Toolbox
    
    get a tool using tool.getQualifiedToolName()
    
    Specified by:
    
    getTool in interface Toolbox
    
    Returns:
  - removeTool
```
public Tool removeTool(java.lang.String name)
```
    Description copied from interface: Toolbox
    
    could be called deregisterTool
    
    Specified by:
    
    removeTool in interface Toolbox
    
    Returns:
  - deleteTool
```
public Tool deleteTool(java.lang.String name)
```
    Description copied from interface: Toolbox
    
    not always supported. Has the concept of 'deletion' that may not be appropriate Keeping for now...
    
    Specified by:
    
    deleteTool in interface Toolbox
    
    Returns:
  - getPath
```
public java.lang.String getPath()
```
    Description copied from interface: Toolbox
    
    a path for the toolbox. This should be unique among all loaded toolboxes
    
    Specified by:
    
    getPath in interface Toolbox
    
    Returns:
  - getType
```
public java.lang.String getType()
```
    Description copied from interface: Toolbox
    
    a type for the toolbox. The type determines which ToolboxLoader can load this Toolbox. It should share its type with the ToolboxLoader that loaded it.
    
    Specified by:
    
    getType in interface Toolbox
    
    Returns:
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: Toolbox
    
    a name for the toolbox.
    
    Specified by:
    
    getName in interface Toolbox
    
    Returns:
  - setName
```
public void setName(java.lang.String name)
```
    Specified by:
    
    setName in interface Toolbox
  - resolveTools
```
protected java.util.Map<java.lang.String,Tool> resolveTools()
```
  - resolveTools
```
protected java.util.List<Tool> resolveTools(java.net.URL url)
                                     throws java.lang.Exception
```
    resolve tools from a particular URL. A single URL can contain more than one tool for example if it's a jar.
    
    Parameters:
    url -
    
    Returns:
    
    Throws:
    
    java.lang.Exception
  - getToolStream
```
protected org.thinginitself.streamable.Streamable getToolStream(java.net.URL url)
                                                         throws java.lang.Exception
```
    get a streamable from a tool URL
    
    Parameters:
    url -
    
    Returns:
    
    Throws:
    
    java.lang.Exception
  - createTool
```
protected Tool createTool(java.lang.String className)
                   throws java.lang.Exception
```
    instantiate a tool
    
    Parameters:
    className -
    
    Returns:
    
    Throws:
    
    java.lang.Exception

Class FileToolbox

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NATIVE_DIR

WIN_32_DIR

WIN_64_DIR

OSX_DIR

OSX_32_DIR

OSX_64_DIR

NUX_32_DIR

NUX_64_DIR

LIB_DIR

HELP_DIR

EXT_TASKGRAPH

EXT_JAVA_CLASS

excludedDirectories

extensions

nativeDirs

Constructor Detail

FileToolbox

FileToolbox

FileToolbox

Method Detail

getProperties

setProperties

getClassLoader

getLibPaths

getVisibleRoots

getFile

getClassPath

loadTools

refresh

getTools

getTools

addTool

getTool

removeTool

deleteTool

getPath

getType

getName

setName

resolveTools

resolveTools

getToolStream

createTool