XMLFileSystem.Impl (File System API)

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

All Implemented Interfaces:

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

Enclosing class:

XMLFileSystem
```
public static class XMLFileSystem.Impl
extends java.lang.Object
implements AbstractFileSystem.List, AbstractFileSystem.Info, AbstractFileSystem.Change, AbstractFileSystem.Attr
```
Implementation of all interfaces List, Change, Info and Attr that delegates to XMLFileSystem

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

Impl(XMLFileSystem fs)
Constructor.

Constructors
Constructor	Description
`Impl(XMLFileSystem fs)`	Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.Enumeration<java.lang.String>`	`attributes(java.lang.String name)`	Get all file attribute names for the file.
`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.
`void`	`deleteAttributes(java.lang.String name)`	Called when a file is deleted, to also delete its attributes.
`boolean`	`folder(java.lang.String name)`	Test if the file is a folder or contains data.
`java.io.InputStream`	`inputStream(java.lang.String name)`	Get input stream.
`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.
`java.lang.Object`	`readAttribute(java.lang.String name, java.lang.String attrName)`	Get the file attribute with the specified name.
`boolean`	`readOnly(java.lang.String name)`	Test whether this file can be written to or not.
`void`	`rename(java.lang.String oldName, java.lang.String newName)`	Rename a file.
`void`	`renameAttributes(java.lang.String oldName, java.lang.String newName)`	Called when a file is renamed, to appropriately update its attributes.
`long`	`size(java.lang.String name)`	Get the size of the file.
`void`	`unlock(java.lang.String name)`	Unlock the file.
`void`	`writeAttribute(java.lang.String name, java.lang.String attrName, java.lang.Object value)`	Set the file attribute with the specified name.

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

- Constructor Detail
  - Impl
```
public Impl(XMLFileSystem fs)
```
    Constructor.
    
    Parameters:
    
    fs - the filesystem to delegate 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
  - readAttribute
```
public java.lang.Object readAttribute(java.lang.String name,
                                      java.lang.String attrName)
```
    Description copied from interface: AbstractFileSystem.Attr
    
    Get the file attribute with the specified name.
    
    Specified by:
    
    readAttribute in interface AbstractFileSystem.Attr
    
    Parameters:
    
    name - the file
    
    attrName - name of the attribute
    
    Returns:
    
    appropriate (serializable) value or null if the attribute is unset (or could not be properly restored for some reason)
  - writeAttribute
```
public void writeAttribute(java.lang.String name,
                           java.lang.String attrName,
                           java.lang.Object value)
                    throws java.io.IOException
```
    Description copied from interface: AbstractFileSystem.Attr
    
    Set the file attribute with the specified name.
    
    Specified by:
    
    writeAttribute in interface AbstractFileSystem.Attr
    
    Parameters:
    
    name - the file
    
    attrName - name of the attribute
    
    value - new value or null to clear the attribute. Must be serializable, although particular filesystems may or may not use serialization to store attribute values.
    
    Throws:
    
    java.io.IOException - if the attribute cannot be set. If serialization is used to store it, this may in fact be a subclass such as NotSerializableException.
  - attributes
```
public java.util.Enumeration<java.lang.String> attributes(java.lang.String name)
```
    Description copied from interface: AbstractFileSystem.Attr
    
    Get all file attribute names for the file.
    
    Specified by:
    
    attributes in interface AbstractFileSystem.Attr
    
    Parameters:
    
    name - the file
    
    Returns:
    
    enumeration of keys (as strings)
  - renameAttributes
```
public void renameAttributes(java.lang.String oldName,
                             java.lang.String newName)
```
    Description copied from interface: AbstractFileSystem.Attr
    
    Called when a file is renamed, to appropriately update its attributes.
    
    Specified by:
    
    renameAttributes in interface AbstractFileSystem.Attr
    
    Parameters:
    
    oldName - old name of the file
    
    newName - new name of the file
  - deleteAttributes
```
public void deleteAttributes(java.lang.String name)
```
    Description copied from interface: AbstractFileSystem.Attr
    
    Called when a file is deleted, to also delete its attributes.
    
    Specified by:
    
    deleteAttributes in interface AbstractFileSystem.Attr
    
    Parameters:
    
    name - name of the file

Class XMLFileSystem.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

readAttribute

writeAttribute

attributes

renameAttributes

deleteAttributes