FileBrowser.LocalPath

java.lang.Object
- FileBrowser.MyPath
- - FileBrowser.LocalPath

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

FileBrowser
```
static class FileBrowser.LocalPath
extends FileBrowser.MyPath
```
Implements a path (MyPath) in the local file system. Illegal characters for a linux file name are: '/' and null. Illegal characters for a windows file name are /\:*?"<>|. Transferring a file from a linux machine to a windows machine can be a problem if one of the illegal windows file name characters is in the linux file name. I don't know what to do about this.

Field Summary

Fields
Modifier and Type Field and Description

(package private) java.nio.file.WatchKey key

(package private) java.nio.file.Path path

(package private) static long serialVersionUID
- Fields inherited from class FileBrowser.MyPath
  treeChildren, uri

Fields
Modifier and Type	Field and Description
`(package private) java.nio.file.WatchKey`	`key`
`(package private) java.nio.file.Path`	`path`
`(package private) static long`	`serialVersionUID`

Constructor Summary

Constructors
Constructor and Description
`LocalPath(java.net.URI uri)` For linux: root directory ends in '/', no other LocalPath does For windows: top-level drives /x:/ ends in '/', no other LocalPath does NB: InvalidPathException.getIndex() returns an index to the unescaped URI - all %xx count as one character.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) boolean`	`copyFileFrom(FileBrowser.MyPath file)` Copies a file to this.
`(package private) boolean`	`copyFileTo(FileBrowser.LocalPath toFile)` Copy this to toFile.
`(package private) boolean`	`copyFileTo(FileBrowser.RemotePath toFile)` Copy this to toFile.
`(package private) boolean`	`delete()` Deletes a file or a symbolic link
`boolean`	`equals(java.lang.Object other)`
`(package private) boolean`	`exists()` Checks if the path refers to an existing file or directory.
`(package private) java.lang.String`	`fullName()` Returns the full path of this path
`(package private) java.util.TreeSet<FileBrowser.TableData>`	`getChildren(boolean dotFiles)` Enumerates all children (files and directories) of this path.
`(package private) java.awt.datatransfer.DataFlavor`	`getFlavor()` Returns the appropriate transfer DataFlavor for this MyPath.
`(package private) long`	`getMTime()` Returns the modification date of this file as the number of milliseconds after 00:00:00 GMT, January 1, 1970.
`(package private) FileBrowser.MyPath`	`getParent()` returns a path to the parent of this path or null if there is no parent.
`(package private) java.util.ArrayList<FileBrowser.MyPath>`	`getTreeChildren()` Only gets directories
`int`	`hashCode()`
`(package private) boolean`	`isDirectory()` Checks if the path refers to a directory.
`(package private) boolean`	`isFile()` Checks if the path refers to an ordinary file.
`(package private) boolean`	`isLink()` Checks if the path refers to a link.
`(package private) boolean`	`makeDirectory()` creates an empty directory at the location specified by this.
`(package private) boolean`	`makeLinkTo(byte[] target)` Creates a symbolic link from this to target.
`(package private) void`	`moveFileFrom(FileBrowser.MyPath file)` Moves a file or directory from one directory to another.
`(package private) void`	`moveFileTo(FileBrowser.LocalPath other)` Move this to other.
`(package private) void`	`moveFileTo(FileBrowser.RemotePath other)` Move this to other.
`(package private) java.util.List<java.lang.String>`	`readAllLines()` Reads lines from this file and returns them as a List<String>
`(package private) void`	`readFile(byte[] data)` Will fill data with read information.
`(package private) byte[]`	`readLink()` Reads the link value (not it's target)
`(package private) boolean`	`renameFile(java.lang.String newName)` Renames this file or directory, keeping it in the same parent directory.
`(package private) FileBrowser.LocalPath`	`resolve(java.nio.file.Path other)` Appends other to the current path and returns it.
`(package private) FileBrowser.LocalPath`	`resolve(java.lang.String other)` Appends other to the current path and returns it.
`(package private) boolean`	`setMTime(long time)` Sets the modification date of this file as the number of milliseconds after 00:00:00 GMT, January 1, 1970.
`(package private) long`	`size()` Returns the length of the file in bytes refered to by this path.
`java.lang.String`	`toString()` Returns the base name of this path
`(package private) void`	`touch()` Will touch file or directory.
`(package private) void`	`writeFile(byte[] data)` Will write data to file starting at offset.

Methods inherited from class FileBrowser.MyPath
getIndex

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

- Field Detail
  - serialVersionUID
```
static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - key
```
java.nio.file.WatchKey key
```
  - path
```
java.nio.file.Path path
```
- Constructor Detail
  - LocalPath
```
LocalPath(java.net.URI uri)
```
    For linux: root directory ends in '/', no other LocalPath does For windows: top-level drives /x:/ ends in '/', no other LocalPath does NB: InvalidPathException.getIndex() returns an index to the unescaped URI - all %xx count as one character. It also appears to use -1 based indexing, i.e., need to add +1 to returned index to get address of bad character (byte). (Need to check this out on linux.) We don't use the index value in this code. 1. expand URI removing all % quoted characters. 2. quote with % all characters not on approved list. 3. convert back to uri 4. convert URI to Path 5. catch any exceptions and quote forbidden character 6. when no more - set URI and cache Path in class variable Attempts to make a valid Path for the local file system. The strategy is to clear all %'s and add %'s for known characters requiring escaping. The resulting String is converted to a URI and then to a Path. If this fails then the second part of the algorithm is tried. The URI is truncated and tried again. If this works another character is added to the URI. If this fails then the character is escaped. If it is already escaped then the % is escaped. Must check that forward progress is made or it is a failure. When the end of the String is reached then we are done. The starting point depends on whether this is a windows or a linux machine.
    
    Parameters:
    
    uri - the URI to be converted to a Path
- Method Detail
  - getFlavor
```
java.awt.datatransfer.DataFlavor getFlavor()
```
    Description copied from class: FileBrowser.MyPath
    
    Returns the appropriate transfer DataFlavor for this MyPath.
    
    Specified by:
    
    getFlavor in class FileBrowser.MyPath
    
    Returns:
    
    DataFlavor for this MyPath
  - exists
```
boolean exists()
```
    Description copied from class: FileBrowser.MyPath
    
    Checks if the path refers to an existing file or directory.
    
    Specified by:
    
    exists in class FileBrowser.MyPath
    
    Returns:
    
    true if the path refers to an existing file or directory
  - isDirectory
```
boolean isDirectory()
```
    Description copied from class: FileBrowser.MyPath
    
    Checks if the path refers to a directory.
    
    Specified by:
    
    isDirectory in class FileBrowser.MyPath
    
    Returns:
    
    true if path refers to a directory
  - isFile
```
boolean isFile()
```
    Description copied from class: FileBrowser.MyPath
    
    Checks if the path refers to an ordinary file.
    
    Specified by:
    
    isFile in class FileBrowser.MyPath
    
    Returns:
    
    true if the path refers to an ordinary file
  - isLink
```
boolean isLink()
```
    Description copied from class: FileBrowser.MyPath
    
    Checks if the path refers to a link.
    
    Specified by:
    
    isLink in class FileBrowser.MyPath
    
    Returns:
    
    true if the path refers to a link
  - getParent
```
FileBrowser.MyPath getParent()
```
    Description copied from class: FileBrowser.MyPath
    
    returns a path to the parent of this path or null if there is no parent.
    
    Specified by:
    
    getParent in class FileBrowser.MyPath
    
    Returns:
    
    parent path
  - getChildren
```
java.util.TreeSet<FileBrowser.TableData> getChildren(boolean dotFiles)
```
    Description copied from class: FileBrowser.MyPath
    
    Enumerates all children (files and directories) of this path.
    
    Specified by:
    
    getChildren in class FileBrowser.MyPath
    
    Parameters:
    
    dotFiles - true if dot files are to be included
    
    Returns:
    
    a list of all children of this path
  - getTreeChildren
```
java.util.ArrayList<FileBrowser.MyPath> getTreeChildren()
```
    Only gets directories
    
    Specified by:
    
    getTreeChildren in class FileBrowser.MyPath
    
    Returns:
    
    exposed children of this path
  - resolve
```
FileBrowser.LocalPath resolve(java.lang.String other)
```
    Description copied from class: FileBrowser.MyPath
    
    Appends other to the current path and returns it. "other" is a simple file name.
    
    Specified by:
    
    resolve in class FileBrowser.MyPath
    
    Parameters:
    
    other - the name to append to this path
    
    Returns:
    
    the augmented path
  - resolve
```
FileBrowser.LocalPath resolve(java.nio.file.Path other)
```
    Description copied from class: FileBrowser.MyPath
    
    Appends other to the current path and returns it. "other" is a simple file name.
    
    Specified by:
    
    resolve in class FileBrowser.MyPath
    
    Parameters:
    
    other - the name to append to this path
    
    Returns:
    
    the augmented path
  - size
```
long size()
```
    Description copied from class: FileBrowser.MyPath
    
    Returns the length of the file in bytes refered to by this path.
    
    Specified by:
    
    size in class FileBrowser.MyPath
    
    Returns:
    
    the length of the file in bytes
  - getMTime
```
long getMTime()
```
    Description copied from class: FileBrowser.MyPath
    
    Returns the modification date of this file as the number of milliseconds after 00:00:00 GMT, January 1, 1970.
    
    Specified by:
    
    getMTime in class FileBrowser.MyPath
    
    Returns:
    
    number of milliseconds after 00:00:00 GMT, January 1, 1970
  - setMTime
```
boolean setMTime(long time)
```
    Description copied from class: FileBrowser.MyPath
    
    Sets the modification date of this file as the number of milliseconds after 00:00:00 GMT, January 1, 1970.
    
    Specified by:
    
    setMTime in class FileBrowser.MyPath
    
    Parameters:
    
    time - Number of milliseconds after 00:00:00 GMT, January 1, 1970
    
    Returns:
    
    true if success
  - makeDirectory
```
boolean makeDirectory()
```
    Description copied from class: FileBrowser.MyPath
    
    creates an empty directory at the location specified by this.
    
    Specified by:
    
    makeDirectory in class FileBrowser.MyPath
    
    Returns:
    
    true if successful
  - renameFile
```
boolean renameFile(java.lang.String newName)
```
    Description copied from class: FileBrowser.MyPath
    
    Renames this file or directory, keeping it in the same parent directory.
    
    Specified by:
    
    renameFile in class FileBrowser.MyPath
    
    Parameters:
    
    newName - the new name of the file or directory
    
    Returns:
    
    true is successful
  - readFile
```
void readFile(byte[] data)
```
    Description copied from class: FileBrowser.MyPath
    
    Will fill data with read information.
    
    Specified by:
    
    readFile in class FileBrowser.MyPath
    
    Parameters:
    
    data - buffer to read data into
  - writeFile
```
void writeFile(byte[] data)
```
    Description copied from class: FileBrowser.MyPath
    
    Will write data to file starting at offset.
    
    Specified by:
    
    writeFile in class FileBrowser.MyPath
    
    Parameters:
    
    data - buffer to write data from
  - readAllLines
```
java.util.List<java.lang.String> readAllLines()
```
    Description copied from class: FileBrowser.MyPath
    
    Reads lines from this file and returns them as a List<String>
    
    Specified by:
    
    readAllLines in class FileBrowser.MyPath
    
    Returns:
    
    the lines from the file
  - readLink
```
byte[] readLink()
```
    Description copied from class: FileBrowser.MyPath
    
    Reads the link value (not it's target)
    
    Specified by:
    
    readLink in class FileBrowser.MyPath
    
    Returns:
    
    the value of the link
  - makeLinkTo
```
boolean makeLinkTo(byte[] target)
```
    Description copied from class: FileBrowser.MyPath
    
    Creates a symbolic link from this to target.
    
    Specified by:
    
    makeLinkTo in class FileBrowser.MyPath
    
    Parameters:
    
    target - the target of the link
    
    Returns:
    
    the value of the link
  - touch
```
void touch()
```
    Description copied from class: FileBrowser.MyPath
    
    Will touch file or directory.
    
    Specified by:
    
    touch in class FileBrowser.MyPath
  - moveFileFrom
```
void moveFileFrom(FileBrowser.MyPath file)
```
    Description copied from class: FileBrowser.MyPath
    
    Moves a file or directory from one directory to another.
    
    Specified by:
    
    moveFileFrom in class FileBrowser.MyPath
    
    Parameters:
    
    file - the file to be moved to this
  - moveFileTo
```
void moveFileTo(FileBrowser.LocalPath other)
```
    Description copied from class: FileBrowser.MyPath
    
    Move this to other.
    
    Specified by:
    
    moveFileTo in class FileBrowser.MyPath
    
    Parameters:
    
    other - directory to move this to
  - moveFileTo
```
void moveFileTo(FileBrowser.RemotePath other)
```
    Description copied from class: FileBrowser.MyPath
    
    Move this to other.
    
    Specified by:
    
    moveFileTo in class FileBrowser.MyPath
    
    Parameters:
    
    other - directory to move this to
  - copyFileFrom
```
boolean copyFileFrom(FileBrowser.MyPath file)
```
    Description copied from class: FileBrowser.MyPath
    
    Copies a file to this.
    
    Specified by:
    
    copyFileFrom in class FileBrowser.MyPath
    
    Parameters:
    
    file - the file to be copied
    
    Returns:
    
    true is successful
  - copyFileTo
```
boolean copyFileTo(FileBrowser.LocalPath toFile)
```
    Description copied from class: FileBrowser.MyPath
    
    Copy this to toFile.
    
    Specified by:
    
    copyFileTo in class FileBrowser.MyPath
    
    Parameters:
    
    toFile - LocalPath to copy this to
    
    Returns:
    
    true is successful
  - copyFileTo
```
boolean copyFileTo(FileBrowser.RemotePath toFile)
```
    Description copied from class: FileBrowser.MyPath
    
    Copy this to toFile.
    
    Specified by:
    
    copyFileTo in class FileBrowser.MyPath
    
    Parameters:
    
    toFile - RemotePath to copy this to
    
    Returns:
    
    true is successful
  - delete
```
boolean delete()
```
    Description copied from class: FileBrowser.MyPath
    
    Deletes a file or a symbolic link
    
    Specified by:
    
    delete in class FileBrowser.MyPath
    
    Returns:
    
    true is successful
  - toString
```
public java.lang.String toString()
```
    Description copied from class: FileBrowser.MyPath
    
    Returns the base name of this path
    
    Specified by:
    
    toString in class FileBrowser.MyPath
    
    Returns:
    
    the base name of this path
  - fullName
```
java.lang.String fullName()
```
    Description copied from class: FileBrowser.MyPath
    
    Returns the full path of this path
    
    Specified by:
    
    fullName in class FileBrowser.MyPath
    
    Returns:
    
    full path name
  - equals
```
public boolean equals(java.lang.Object other)
```
    Specified by:
    
    equals in class FileBrowser.MyPath
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in class FileBrowser.MyPath

Class FileBrowser.LocalPath

Field Summary

Fields inherited from class FileBrowser.MyPath

Constructor Summary

Method Summary

Methods inherited from class FileBrowser.MyPath

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

key

path

Constructor Detail

LocalPath

Method Detail

getFlavor

exists

isDirectory

isFile

isLink

getParent

getChildren

getTreeChildren

resolve

resolve

size

getMTime

setMTime

makeDirectory

renameFile

readFile

writeFile

readAllLines

readLink

makeLinkTo

touch

moveFileFrom

moveFileTo

moveFileTo

copyFileFrom

copyFileTo

copyFileTo

delete

toString

fullName

equals

hashCode