de.schlichtherle.truezip.fs
Class FsModel

java.lang.Object
  de.schlichtherle.truezip.fs.FsModel

Direct Known Subclasses:

FsDecoratingModel, FsDefaultModel

@ThreadSafe
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
public abstract class FsModel
extends Object

Defines the common properties of a file system.

Sub-classes must be thread-safe, too.

Author:

Christian Schlichtherle

See Also:

FsController

FsModel

public FsModel()

getMountPoint

public abstract FsMountPoint getMountPoint()

Returns the mount point of this file system model.

The mount point may be used to construct error messages or to locate and access file system metadata which is stored outside the file system, e.g. in-memory stored passwords for RAES encrypted ZIP files.

Returns:

The mount point of this file system model.

getParent

@Nullable
public abstract FsModel getParent()

Returns the model of the parent file system or null if and only if the file system is not federated, i.e. if it's not a member of a parent file system.

Returns:

The nullable parent file system model.

isTouched

public abstract boolean isTouched()

Returns true if and only if the contents of the federated file system have been modified so that it needs synchronization with its parent file system.

setTouched

public abstract void setTouched(boolean touched)

Sets the value of the property touched.

Parameters:

touched - the new value of this property.

equals

public final boolean equals(Object that)

Two file system models are considered equal if and only if they are identical. This can't get overriden.

Overrides:

equals in class Object

hashCode

public final int hashCode()

Returns a hash code which is consistent with equals(java.lang.Object). This can't get overriden.

Overrides:

hashCode in class Object

toString

public String toString()

Returns a string representation of this object for debugging and logging purposes.

Overrides:

toString in class Object