DecoratingEntry (TrueCommons Container I/O 2.5.0 API)

java.lang.Object
- net.java.truecommons.shed.UniqueObject
- - net.java.truecommons.cio.DecoratingEntry<E>

Type Parameters:
E - the type of the decorated entry.

All Implemented Interfaces:

Entry

Direct Known Subclasses:

DecoratingIoBuffer
```
@ThreadSafe
public abstract class DecoratingEntry<E extends Entry>
extends UniqueObject
implements Entry
```
An abstract decorator for an entry.

Author:

Christian Schlichtherle

Nested Class Summary
- Nested classes/interfaces inherited from interface net.java.truecommons.cio.Entry
  Entry.Access, Entry.Entity, Entry.PosixEntity, Entry.Size, Entry.Type

Field Summary

Fields
Modifier and Type Field and Description

protected E entry
The nullable decorated entry.
- 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

Fields
Modifier and Type	Field and Description
`protected E`	`entry` The nullable decorated entry.

Constructor Summary

Constructors
Modifier Constructor and Description

protected DecoratingEntry()

protected DecoratingEntry(E entry)

Constructors
Modifier	Constructor and Description
`protected`	`DecoratingEntry()`
`protected`	`DecoratingEntry(E entry)`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getName()` Returns the entry name.
`long`	`getSize(Entry.Size type)` Returns the size of the given `type` for this entry in bytes or `Entry.UNKNOWN` if not defined or the type is not supported.
`long`	`getTime(Entry.Access type)` Returns the time of the given access `type` for this entry in milliseconds since the epoch or -1 if not defined or the type is not supported.
`Boolean`	`isPermitted(Entry.Access type, Entry.Entity entity)` Returns `true` or `false` if the given access `type` to this entry for the given `entity` is respectively permitted or denied.
`String`	`toString()` Returns a string representation of this object for debugging and logging purposes.

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

- Field Detail
  - entry
```
@Nullable
protected E extends Entry entry
```
    The nullable decorated entry.
- Constructor Detail
  - DecoratingEntry
```
protected DecoratingEntry()
```
  - DecoratingEntry
```
protected DecoratingEntry(E entry)
```
- Method Detail
  - getName
```
public String getName()
```
    Description copied from interface: Entry
    Returns the entry name. When parsed, an entry name is interpreted as follows:
    1. An entry name is a sequence of segments which are separated by one or more separator characters, which may be '/' or '\\' or both, according to the rules of the Container. This implies that a segment cannot contain separator characters.
    2. An entry name may contain one or more dot (".") or dot-dot ("..") segments which represent the current or parent segment respectively.
    3. An entry name may start with one or more separator characters. In this case, its said to be absolute. Otherwise, its said to be relative.
    4. An entry name may end with one or more separator characters (e.g. to identify a directory entry).
    For example, the entry names "foo/bar/" and "./abc/../foo/./def/./../bar/." both refer to the same entry when being parsed.
    Specified by:
    
    getName in interface Entry
    
    Returns:
    The entry name.
  - getSize
```
public long getSize(Entry.Size type)
```
    Description copied from interface: Entry
    
    Returns the size of the given type for this entry in bytes or Entry.UNKNOWN if not defined or the type is not supported. This method may not be meaningful for non-Entry.Type.FILE entries.
    
    Specified by:
    
    getSize in interface Entry
    
    Parameters:
    type - the type of the size.
    
    Returns:
    The size of the given type for this entry in bytes or Entry.UNKNOWN if not defined or the type is not supported.
  - getTime
```
public long getTime(Entry.Access type)
```
    Description copied from interface: Entry
    
    Returns the time of the given access type for this entry in milliseconds since the epoch or -1 if not defined or the type is not supported.
    
    Specified by:
    
    getTime in interface Entry
    
    Parameters:
    type - the type of the access.
    
    Returns:
    The time of the given access type for this entry in milliseconds since the epoch or -1 if not defined or the type is not supported.
  - isPermitted
```
public Boolean isPermitted(Entry.Access type,
                  Entry.Entity entity)
```
    Description copied from interface: Entry
    
    Returns true or false if the given access type to this entry for the given entity is respectively permitted or denied. Returns null if not defined or the access type or entity is not supported.
    
    Specified by:
    
    isPermitted in interface Entry
    
    Parameters:
    type - the type of the access.
    entity - the entity which desires access.
    
    Returns:
    true if and only if the given access type to this entry is permitted for the given entity.
  - toString
```
public String toString()
```
    Returns a string representation of this object for debugging and logging purposes.
    
    Overrides:
    
    toString in class Object

Class DecoratingEntry<E extends Entry>

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

entry

Constructor Detail

DecoratingEntry

DecoratingEntry

Method Detail

getName

getSize

getTime

isPermitted

toString