Skip navigation links
org.openide.filesystems 9.11

File System API
Official

See: Description

File System API 
Package Description
org.openide.filesystems
NetBeans internally uses the concept of a virtual filesystem.
org.openide.filesystems.annotations
Support for writing annotation processors which generate XML layer fragments.
org.openide.filesystems.spi  

NetBeans internally uses the concept of a virtual filesystem. This module provide APIs for accessing such virtual files as well as some support classes to make writing of custom vitual filesystems easier.

What is New (see all changes)?

Use Cases

Cover of NetBeans Platform for Beginners book For general overview of the filesystem concepts, related topics, together with code samples, see chapter 3, of NetBeans Platform for Beginners by Jason Wexbridge and Walter Nyland. Many of the usecases are described at the overall documentation, in a way how to register a mime type. Some of the additional usecases are covered here.

How to change menus, etc. after login?

See documentation about dynamically changing the system filesystem.

Exported Interfaces

This table lists all of the module exported APIs with defined stability classifications. It is generated based on answers to questions about the architecture of the module. Read them all...
Group of java interfaces
Interface NameIn/OutStabilitySpecified in What Document?
FilesystemsAPIExportedOfficial .../openide/filesystems/doc-files/api.html

FileObjectMoveLookupExportedFriend

masterfs module is using a reflection to re-associate the lookup after a move operation.

Group of property interfaces
Interface NameIn/OutStabilitySpecified in What Document?
fallbackExportedStable

See documentation of FileSystem.

revealEntriesExportedUnder Development .../openide/filesystems/MultiFileSystem.html

The MultiFileSystem defines some pseudo attributes on files and folders, which provide rollback features. Please see MultiFileSystem class javadoc for more information.

Group of systemproperty interfaces
Interface NameIn/OutStabilitySpecified in What Document?
org.openide.filesystems.DefaultAttributes.ATTR_NAME_EXT_XMLExportedPrivate

Name of attribute file can be changed , if .nbattrs can't be used.

org.openide.filesystems.LocalFileSystem.REFRESH_TIMEExportedPrivate

Periodic refresh can be set.

org.openide.filesystems.annotateUnclosedStreamsExportedPrivate

If true, better diagnostic information will be available as to when file input or output streams were opened that prevent a file from being deleted because they were not closed. This information comes at a performance cost, however.

allow.filechooser.symlink.traversalExportedPrivate

Used by FileChooserBuilder. If set to false, file choosers created by instances of FileChooserBuilder will traverse symlinks. By default they do not.

forget.recent.dirsExportedPrivate

Used by FileChooserBuilder. If true, FileChooserBuilder will not remember users' recent directories across sessions. This property is provided for applications where a history of recently used directories is a security concern.

Group of layer interfaces
Interface NameIn/OutStabilitySpecified in What Document?
methodvalue-newvalueExportedStable .../org/openide/filesystems/FileObject.html

When special form of setAttribute is supported by the filesystem, the getAttribute can behave like XMLFileSystem's methodvalue and newvalue attributes:

raw-valueExportedPrivate

It is possible to prefix call to
FileObject.getAttribute with raw: prefix to evaluate the attribute without instantiating it (e.g. get Method or Class values from methodvalue and newvalue attributes. This API is not intended for public use at present and can change in future.

Group of dtd interfaces
Interface NameIn/OutStabilitySpecified in What Document?
attributes-1_0.dtdExportedStable .../www.netbeans.org/dtds/attributes-1_0.dtd

-//NetBeans//DTD DefaultAttributes 1.0//EN

filesystem-1_0.dtdExportedStable .../www.netbeans.org/dtds/filesystem-1_0.dtd

-//NetBeans//DTD Filesystem 1.0//EN

Implementation Details

Where are the sources for the module?

The sources for the module are in the NetBeans Mercurial repositories.

What do other modules need to do to declare a dependency on this one, in addition to or instead of a plain module dependency?

XXX no answer for deploy-dependencies

Read more about the implementation in the answers to architecture questions.

Skip navigation links
org.openide.filesystems 9.11

Built on December 10 2016.  |  Portions Copyright 1997-2016 Oracle. All rights reserved.