LocalFileSystem.Impl (File System API)

java.lang.Object
- org.openide.filesystems.LocalFileSystem.Impl

All Implemented Interfaces:

java.io.Serializable, AbstractFileSystem.Change, AbstractFileSystem.Info, AbstractFileSystem.List, AbstractFileSystem.SymlinkInfo

Enclosing class:

LocalFileSystem
```
public static class LocalFileSystem.Impl
extends java.lang.Object
implements AbstractFileSystem.List, AbstractFileSystem.Info, AbstractFileSystem.SymlinkInfo, AbstractFileSystem.Change
```
The implementation class that implements List, Info and Change interfaces and delegates all the methods to appropriate methods of LocalFileSystem.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

Impl(LocalFileSystem fs)
Pointer to local filesystem

Constructors
Constructor	Description
`Impl(LocalFileSystem fs)`	Pointer to local filesystem

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String[]`	`children(java.lang.String name)`	Get a list of children files for a given folder.
`void`	`createData(java.lang.String name)`	Create new data file.
`void`	`createFolder(java.lang.String name)`	Create new folder.
`void`	`delete(java.lang.String name)`	Delete a file.
`boolean`	`folder(java.lang.String name)`	Test if the file is a folder or contains data.
`java.lang.String`	`getCanonicalName(java.lang.String name)`	Get canonical file name (resolve all symbolic links).
`java.io.InputStream`	`inputStream(java.lang.String name)`	Get input stream.
`boolean`	`isSymbolicLink(java.lang.String name)`	Check whether a file represents a symbolic link.
`java.util.Date`	`lastModified(java.lang.String name)`	Get last modification time.
`void`	`lock(java.lang.String name)`	Lock the file.
`void`	`markUnimportant(java.lang.String name)`	Mark the file as being unimportant.
`java.lang.String`	`mimeType(java.lang.String name)`	Get the MIME type of the file.
`java.io.OutputStream`	`outputStream(java.lang.String name)`	Get output stream.
`boolean`	`readOnly(java.lang.String name)`	Test whether this file can be written to or not.
`java.lang.String`	`readSymbolicLink(java.lang.String name)`	Read symbolic link.
`void`	`rename(java.lang.String oldName, java.lang.String newName)`	Rename a file.
`long`	`size(java.lang.String name)`	Get the size of the file.
`void`	`unlock(java.lang.String name)`	Unlock the file.

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

- Constructor Detail
  - Impl
```
public Impl(LocalFileSystem fs)
```
    Pointer to local filesystem
    
    Parameters:
    
    fs - the filesystem this impl is connected to
- Method Detail
  - children
```
public java.lang.String[] children(java.lang.String name)
```
    Description copied from interface: AbstractFileSystem.List
    
    Get a list of children files for a given folder.
    
    Specified by:
    
    children in interface AbstractFileSystem.List
    
    Parameters:
    
    name - the folder, by name; e.g. top/next/afterthat
    
    Returns:
    
    a list of children of the folder, as file.ext (no path) the array can contain null values that will be ignored
  - createFolder
```
public void createFolder(java.lang.String name)
                  throws java.io.IOException
```
    Description copied from interface: AbstractFileSystem.Change
    
    Create new folder.
    
    Specified by:
    
    createFolder in interface AbstractFileSystem.Change
    
    Parameters:
    
    name - full name of new folder, e.g. topfolder/newfolder
    
    Throws:
    
    java.io.IOException - if the operation fails
  - createData
```
public void createData(java.lang.String name)
                throws java.io.IOException
```
    Description copied from interface: AbstractFileSystem.Change
    
    Create new data file.
    
    Specified by:
    
    createData in interface AbstractFileSystem.Change
    
    Parameters:
    
    name - full name of the file, e.g. path/from/root/filename.ext
    
    Throws:
    
    java.io.IOException - if the file cannot be created (e.g. already exists)
  - rename
```
public void rename(java.lang.String oldName,
                   java.lang.String newName)
            throws java.io.IOException
```
    Description copied from interface: AbstractFileSystem.Change
    
    Rename a file.
    
    Specified by:
    
    rename in interface AbstractFileSystem.Change
    
    Parameters:
    
    oldName - old name of the file; fully qualified
    
    newName - new name of the file; fully qualified
    
    Throws:
    
    java.io.IOException - if it could not be renamed
  - delete
```
public void delete(java.lang.String name)
            throws java.io.IOException
```
    Description copied from interface: AbstractFileSystem.Change
    
    Delete a file.
    
    Specified by:
    
    delete in interface AbstractFileSystem.Change
    
    Parameters:
    
    name - name of file; fully qualified
    
    Throws:
    
    java.io.IOException - if the file could not be deleted
  - lastModified
```
public java.util.Date lastModified(java.lang.String name)
```
    Description copied from interface: AbstractFileSystem.Info
    
    Get last modification time.
    
    Specified by:
    
    lastModified in interface AbstractFileSystem.Info
    
    Parameters:
    
    name - the file to test
    
    Returns:
    
    the date of last modification
  - folder
```
public boolean folder(java.lang.String name)
```
    Description copied from interface: AbstractFileSystem.Info
    
    Test if the file is a folder or contains data.
    
    Specified by:
    
    folder in interface AbstractFileSystem.Info
    
    Parameters:
    
    name - name of the file
    
    Returns:
    
    true if the file is folder, false if it is data
  - readOnly
```
public boolean readOnly(java.lang.String name)
```
    Description copied from interface: AbstractFileSystem.Info
    
    Test whether this file can be written to or not.
    
    Specified by:
    
    readOnly in interface AbstractFileSystem.Info
    
    Parameters:
    
    name - the file to test
    
    Returns:
    
    true if the file is read-only
  - mimeType
```
public java.lang.String mimeType(java.lang.String name)
```
    Description copied from interface: AbstractFileSystem.Info
    
    Get the MIME type of the file. If filesystem has no special support for MIME types then can simply return null. FileSystem can register MIME types for a well-known extensions: FileUtil.setMIMEType(String ext, String mimeType) or together with filesystem supply some resolvers subclassed from MIMEResolver.
    
    Specified by:
    
    mimeType in interface AbstractFileSystem.Info
    
    Parameters:
    
    name - the file to test
    
    Returns:
    
    the MIME type textual representation (e.g. "text/plain") or null if no special support for recognizing MIME is implemented.
  - size
```
public long size(java.lang.String name)
```
    Description copied from interface: AbstractFileSystem.Info
    
    Get the size of the file.
    
    Specified by:
    
    size in interface AbstractFileSystem.Info
    
    Parameters:
    
    name - the file to test
    
    Returns:
    
    the size of the file in bytes, or zero if the file does not contain data (does not exist or is a folder).
  - inputStream
```
public java.io.InputStream inputStream(java.lang.String name)
                                throws java.io.FileNotFoundException
```
    Description copied from interface: AbstractFileSystem.Info
    
    Get input stream.
    
    Specified by:
    
    inputStream in interface AbstractFileSystem.Info
    
    Parameters:
    
    name - the file to test
    
    Returns:
    
    an input stream to read the contents of this file
    
    Throws:
    
    java.io.FileNotFoundException - if the file does not exist or is invalid
  - outputStream
```
public java.io.OutputStream outputStream(java.lang.String name)
                                  throws java.io.IOException
```
    Description copied from interface: AbstractFileSystem.Info
    
    Get output stream.
    
    Specified by:
    
    outputStream in interface AbstractFileSystem.Info
    
    Parameters:
    
    name - the file to test
    
    Returns:
    
    output stream to overwrite the contents of this file
    
    Throws:
    
    java.io.IOException - if an error occurs (the file is invalid, etc.)
  - lock
```
public void lock(java.lang.String name)
          throws java.io.IOException
```
    Description copied from interface: AbstractFileSystem.Info
    
    Lock the file. May do nothing if the underlying storage does not support locking. This does not affect locking using FileLock within NetBeans, however.
    
    Specified by:
    
    lock in interface AbstractFileSystem.Info
    
    Parameters:
    
    name - name of the file
    
    Throws:
    
    java.io.IOException - (e.g. FileAlreadyLockedException) if the file is already locked or otherwise cannot be locked
  - unlock
```
public void unlock(java.lang.String name)
```
    Description copied from interface: AbstractFileSystem.Info
    
    Unlock the file.
    
    Specified by:
    
    unlock in interface AbstractFileSystem.Info
    
    Parameters:
    
    name - name of the file
  - markUnimportant
```
public void markUnimportant(java.lang.String name)
```
    Description copied from interface: AbstractFileSystem.Info
    
    Mark the file as being unimportant. If not called, the file is assumed to be important. Deprecated and new implementations need not do anything.
    
    Specified by:
    
    markUnimportant in interface AbstractFileSystem.Info
    
    Parameters:
    
    name - the file to mark
  - isSymbolicLink
```
public boolean isSymbolicLink(java.lang.String name)
                       throws java.io.IOException
```
    Description copied from interface: AbstractFileSystem.SymlinkInfo
    
    Check whether a file represents a symbolic link.
    
    Specified by:
    
    isSymbolicLink in interface AbstractFileSystem.SymlinkInfo
    
    Parameters:
    
    name - Name of the file.
    
    Returns:
    
    True if this file represents a symbolic link, false otherwise.
    
    Throws:
    
    java.io.IOException - If some I/O problem occurs.
    
    See Also:
    
    AbstractFileSystem.SymlinkInfo.readSymbolicLink(java.lang.String), AbstractFileSystem.SymlinkInfo.getCanonicalName(java.lang.String)
  - readSymbolicLink
```
public java.lang.String readSymbolicLink(java.lang.String name)
                                  throws java.io.IOException
```
    Description copied from interface: AbstractFileSystem.SymlinkInfo
    
    Read symbolic link. If the file represents a symbolic link, return its target path. Otherwise the return value is undefined, or IllegalArgumentException can be thrown. This method does not perform any normalization. If the target of symbolic link is defined using relative path, this relative path will be returned.
    
    Specified by:
    
    readSymbolicLink in interface AbstractFileSystem.SymlinkInfo
    
    Parameters:
    
    name - Name of the file.
    
    Returns:
    
    Target of the symbolic link (as absolute or relative path), or some undefined value if name does not represent symbolic link.
    
    Throws:
    
    java.io.IOException - If some I/O problem occurs.
    
    See Also:
    
    AbstractFileSystem.SymlinkInfo.isSymbolicLink(java.lang.String)
  - getCanonicalName
```
public java.lang.String getCanonicalName(java.lang.String name)
                                  throws java.io.IOException
```
    Description copied from interface: AbstractFileSystem.SymlinkInfo
    
    Get canonical file name (resolve all symbolic links).
    
    Specified by:
    
    getCanonicalName in interface AbstractFileSystem.SymlinkInfo
    
    Parameters:
    
    name - Name of the file.
    
    Returns:
    
    Path that represents the same file as name and where all symbolic links are resolved.
    
    Throws:
    
    java.io.IOException - If some I/O problem occurs.

Class LocalFileSystem.Impl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Impl

Method Detail

children

createFolder

createData

rename

delete

lastModified

folder

readOnly

mimeType

size

inputStream

outputStream

lock

unlock

markUnimportant

isSymbolicLink

readSymbolicLink

getCanonicalName