net.java.truevfs.kernel.spec

Interface FsNode

All Superinterfaces:

net.java.truecommons.cio.Entry

All Known Implementing Classes:

FsAbstractNode, FsCovariantNode, HttpNode

@ImplementationsShouldExtend(value=FsAbstractNode.class)
public interface FsNode
extends net.java.truecommons.cio.Entry

A file system node is an entry which can implement multiple entry types and list directory members.

Author:

Christian Schlichtherle

Nested Class Summary

Nested classes/interfaces inherited from interface net.java.truecommons.cio.Entry

net.java.truecommons.cio.Entry.Access, net.java.truecommons.cio.Entry.Entity, net.java.truecommons.cio.Entry.PosixEntity, net.java.truecommons.cio.Entry.Size, net.java.truecommons.cio.Entry.Type

Field Summary

Fields inherited from interface net.java.truecommons.cio.Entry

ALL_ACCESS, ALL_POSIX_ACCESS, ALL_POSIX_ENTITIES, ALL_SIZES, ALL_TYPES, DIRECTORY_TYPE, FILE_TYPE, NO_ACCESS, NO_POSIX_ENTITIES, NO_SIZES, NO_TYPES, SPECIAL_TYPE, SYMLINK_TYPE, UNKNOWN

Method Summary

Modifier and Type	Method and Description
Set<String>	getMembers() Returns a set of strings with the base names of the members of this directory node or null if and only if this is not a directory node.
String	getName() Returns a string representation of the file system node name.
net.java.truecommons.shed.BitField<net.java.truecommons.cio.Entry.Type>	getTypes() Returns a bit field of types implemented by this file system node.
boolean	isType(net.java.truecommons.cio.Entry.Type type) Returns true if and only if this file system node implements the given type.

Methods inherited from interface net.java.truecommons.cio.Entry

getSize, getTime, isPermitted

Method Detail

getMembers

@Nullable
Set<String> getMembers()

Returns a set of strings with the base names of the members of this directory node or null if and only if this is not a directory node. Whether or not modifying the returned set is supported and the effect on the file system is implementation specific.

Returns:

A set of strings with the base names of the members of this directory node or null if and only if this is not a directory node.

getName

String getName()

Returns a string representation of the file system node name.

Specified by:

getName in interface net.java.truecommons.cio.Entry

Returns:

A string representation of the file system node name.

getTypes

net.java.truecommons.shed.BitField<net.java.truecommons.cio.Entry.Type> getTypes()

Returns a bit field of types implemented by this file system node.

Some file system types allow a node to implement multiple types. For example, a ZIP or TAR file may contain an archive entry with the name foo and a directory archive entry with the name foo/. Yes, this is strange, but sh*t happens! In this case then, a virtual file system should collapse this into one file system node which returns true for both isType(FILE) and isType(DIRECTORY).

Returns:

A bit field of types implemented by this file system node.

isType

boolean isType(net.java.truecommons.cio.Entry.Type type)

Returns true if and only if this file system node implements the given type.

Parameters:

type - the type to test.

Returns:

true if and only if this file system node implements the given type.

See Also:

getTypes()