org.entityfs
Interface Named

All Superinterfaces:

Lockable, ReadLockable

All Known Subinterfaces:

Directory, DirectoryImplementation, DirectoryView, DirectoryViewImplementation, EFile, EFileImplementation, Entity, EntityAcceptingEntity<T>, EntityAcceptingEntityImplementation<T>, EntityAcceptingEntityView<T>, EntityAcceptingEntityViewImplementation<T>, EntityImplementation, EntityView, EntityViewImplementation, NamedReadableFile, SymbolicLink, SymbolicLinkImplementation, SymbolicLinkView, SymbolicLinkViewImplementation

All Known Implementing Classes:

AbstractEntityAcceptingEntityImpl, AbstractEntityAcceptingEntityView, AbstractEntityImpl, AbstractEntityViewImpl, ClasspathNamedReadableFile, DirectoryImpl, DirectoryViewImpl, FileImpl, FileReadableFile, ManualNamedReadableFile, NamedReadableFileAdapter, ReadWritableFileAdapter, SymbolicLinkImpl, SymbolicLinkViewImpl, UrlReadableFile

public interface Named
extends ReadLockable

This interface defines something that has a name, an entity, for instance.

Since:

1.0

Author:

Karl Gustafsson

In_jar:

entityfs-core

Method Summary

String

getName() Get the name.

Methods inherited from interface org.entityfs.lock.ReadLockable

getReadLock, isReadLockedByCurrentThread, lockForReading

Method Detail

getName

String getName()
               throws IllegalStateException,
                      ReadLockRequiredException

Get the name. The name of the root directory is /.

Returns:

The name of the named object.

Throws:

IllegalStateException - If this is called on a disconnected view.

ReadLockRequiredException - If the client does not have a read lock for the viewed entity or its parent.

Locks_required:

A read lock on this entity or on its parent directory.

Permissions_required:

None