net.java.truevfs.kernel.spec

Class FsCovariantNode<E extends FsArchiveEntry>

java.lang.Object

net.java.truecommons.shed.UniqueObject

net.java.truevfs.kernel.spec.FsAbstractNode

net.java.truevfs.kernel.spec.FsCovariantNode<E>

Type Parameters:

E - the type of the mapped archive entries.

All Implemented Interfaces:

Cloneable, net.java.truecommons.cio.Entry, FsNode

@NotThreadSafe
public final class FsCovariantNode<E extends FsArchiveEntry>
extends FsAbstractNode
implements Cloneable

A covariant file system node maintains a map of archive entries and uses its key property to determine the archive entry in the map to which it forwards calls to getEntry(), Entry.getSize(Size), Entry.getTime(Access) et al.

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

Constructor Summary

Constructors

Constructor and Description
FsCovariantNode(String path) Constructs a new covariant file system node with the given path.

Method Summary

Modifier and Type	Method and Description
boolean	add(String member) Adds the given base path to the set of members of this directory if and only if this covariant file system node implements a directory.
FsCovariantNode<E>	clone(FsArchiveDriver<E> driver) Returns a deep clone of this covariant file system node.
E	get(net.java.truecommons.cio.Entry.Type type) Returns the archive entry for the given type.
Collection<E>	getEntries() A collection of the mapped entries.
E	getEntry() Returns the archive entry mapped for the key property.
net.java.truecommons.cio.Entry.Type	getKey() Returns the type of the file system node to which calls to getEntry(), Entry.getSize(Size), Entry.getTime(Access) et al shall get forwarded.
Set<String>	getMembers() Returns a set of the members of this directory or null if and only if there is no directory archive entry mapped.
String	getName() Returns a string representation of the file system node name.
long	getSize(net.java.truecommons.cio.Entry.Size type) Returns the size mapped for the key property.
long	getTime(net.java.truecommons.cio.Entry.Access type) Returns the access time mapped for the key property.
net.java.truecommons.shed.BitField<net.java.truecommons.cio.Entry.Type>	getTypes() Returns a set of the mapped types.
Boolean	isPermitted(net.java.truecommons.cio.Entry.Access type, net.java.truecommons.cio.Entry.Entity entity) Returns the permission mapped for the key property.
boolean	isRoot() Returns true if and only if the name of this covariant node identifies it as a root node.
boolean	isType(net.java.truecommons.cio.Entry.Type type) Returns true if and only if there is an archive entry mapped for the given type.
E	put(net.java.truecommons.cio.Entry.Type type, E entry) Maps the given type to the given archive entry.
E	remove(net.java.truecommons.cio.Entry.Type type) Removes the archive entry for the given type from the map.
boolean	remove(String member) Removes the given base path from the set of members of this directory if and only if this covariant file system node implements a directory.
void	setKey(net.java.truecommons.cio.Entry.Type key) Selects the type of the file system node to which calls to getEntry(), Entry.getSize(Size), Entry.getTime(Access) et al shall get forwarded.

Methods inherited from class net.java.truevfs.kernel.spec.FsAbstractNode

toString

Methods inherited from class net.java.truecommons.shed.UniqueObject

equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FsCovariantNode

public FsCovariantNode(String path)

Constructs a new covariant file system node with the given path.

Parameters:

path - the file system path.

Method Detail

add

public boolean add(String member)

Adds the given base path to the set of members of this directory if and only if this covariant file system node implements a directory.

Parameters:

member - The base path of the member to add.

Returns:

Whether the member has been added or an equal member was already present in the directory.

Throws:

NullPointerException - if this covariant file system node does not implement a directory.

clone

public FsCovariantNode<E> clone(FsArchiveDriver<E> driver)

Returns a deep clone of this covariant file system node.

Parameters:

driver - the archive driver to use for cloning the mapped archive entries.

Returns:

A deep clone of this covariant file system node.

get

@Nullable
public E get(net.java.truecommons.cio.Entry.Type type)

Returns the archive entry for the given type.

Parameters:

type - the type of the archive entry to lookup.

Returns:

The archive entry for the given type.

getEntries

public Collection<E> getEntries()

A collection of the mapped entries. This is a bidirectional view: Any change is reflected in the map and vice versa.

Returns:

a collection of the mapped entries

getEntry

@Nullable
public E getEntry()

Returns the archive entry mapped for the key property.

Returns:

the archive entry mapped for the key property.

getKey

@Nullable
public net.java.truecommons.cio.Entry.Type getKey()

Returns the type of the file system node to which calls to getEntry(), Entry.getSize(Size), Entry.getTime(Access) et al shall get forwarded.

Note that an arbitrary property value may get returned: The initial value is null and even if it's not null, no node of this type needs to be mapped.

Returns:

the type of the file system node to which calls to getEntry(), Entry.getSize(Size), Entry.getTime(Access) et al shall get forwarded.

getMembers

@Nullable
public Set<String> getMembers()

Returns a set of the members of this directory or null if and only if there is no directory archive entry mapped. This is a bidirectional view: Any change is reflected in the set and vice versa.

Specified by:

getMembers in interface FsNode

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

public String getName()

Description copied from interface: FsNode

Returns a string representation of the file system node name.

Specified by:

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

Specified by:

getName in interface FsNode

Returns:

A string representation of the file system node name.

getSize

public long getSize(net.java.truecommons.cio.Entry.Size type)

Returns the size mapped for the key property.

Specified by:

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

getTime

public long getTime(net.java.truecommons.cio.Entry.Access type)

Returns the access time mapped for the key property.

Specified by:

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

getTypes

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

Returns a set of the mapped types. This is a bidirectional view: Any change is reflected in the map and vice versa.

Specified by:

getTypes in interface FsNode

Returns:

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

isPermitted

public Boolean isPermitted(net.java.truecommons.cio.Entry.Access type,
                           net.java.truecommons.cio.Entry.Entity entity)

Returns the permission mapped for the key property.

Specified by:

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

isRoot

public boolean isRoot()

Returns true if and only if the name of this covariant node identifies it as a root node.

Returns:

true if and only if the name of this covariant node identifies it as a root node.

isType

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

Returns true if and only if there is an archive entry mapped for the given type.

Specified by:

isType in interface FsNode

Overrides:

isType in class FsAbstractNode

Parameters:

type - the type to test.

Returns:

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

See Also:

FsNode.getTypes()

put

@Nullable
public E put(net.java.truecommons.cio.Entry.Type type,
                       E entry)

Maps the given type to the given archive entry. As a side effect, the key property is set to the given type.

Parameters:

type - the type to map.

entry - the archive entry to map.

Returns:

The previously mapped archive entry.

remove

@Nullable
public E remove(net.java.truecommons.cio.Entry.Type type)

Removes the archive entry for the given type from the map.

Parameters:

type - the type to remove.

Returns:

The previously mapped archive entry.

remove

public boolean remove(String member)

Removes the given base path from the set of members of this directory if and only if this covariant file system node implements a directory.

Parameters:

member - The base path of the member to remove.

Returns:

Whether the member has been removed or no equal member was present in the directory.

Throws:

NullPointerException - if this covariant file system node does not implement a directory.

setKey

public void setKey(@Nullable
                   net.java.truecommons.cio.Entry.Type key)

Selects the type of the file system node to which calls to getEntry(), Entry.getSize(Size), Entry.getTime(Access) et al shall get forwarded. If the given type is null or no file system node of this type is mappeed, then any subsequent call to these methods will fail with a NullPointerException.

Parameters:

key - the type of the file system node to which calls to getEntry(), Entry.getSize(Size), Entry.getTime(Access) et al shall get forwarded.