FsCovariantEntry (TrueZIP Kernel 7.4.1 API)

java.lang.Object
- de.schlichtherle.truezip.fs.FsEntry
- - de.schlichtherle.truezip.fs.archive.FsCovariantEntry<E>

Type Parameters:
E - The type of the mapped archive entries.

All Implemented Interfaces:

Entry, Cloneable
```
@NotThreadSafe
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
public final class FsCovariantEntry<E extends FsArchiveEntry>
extends FsEntry
implements Cloneable
```
A covariant file system entry 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) and Entry.getTime(Access).

Author:

Christian Schlichtherle

Nested Class Summary
- Nested classes/interfaces inherited from interface de.schlichtherle.truezip.entry.Entry
  Entry.Access, Entry.Size, Entry.Type

Field Summary

Fields
Modifier and Type Field and Description

private Entry.Type key

private EnumMap<Entry.Type,E> map

private LinkedHashSet<String> members

private String name
- Fields inherited from interface de.schlichtherle.truezip.entry.Entry
  ALL_ACCESS_SET, ALL_SIZE_SET, ALL_TYPE_SET, DIRECTORY_TYPE_SET, FILE_TYPE_SET, SPECIAL_TYPE_SET, SYMLINK_TYPE_SET, UNKNOWN

Fields
Modifier and Type	Field and Description
`private Entry.Type`	`key`
`private EnumMap<Entry.Type,E>`	`map`
`private LinkedHashSet<String>`	`members`
`private String`	`name`

Constructor Summary

Constructors
Constructor and Description

FsCovariantEntry(String path)
Constructs a new covariant file system entry with given path.

Constructors
Constructor and Description
`FsCovariantEntry(String path)` Constructs a new covariant file system entry with given path.

Method Summary

Methods
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 entry implements a directory.
`FsCovariantEntry<E>`	`clone(FsArchiveDriver<E> driver)` Returns a deep clone of this covariant file system entry.
`Collection<E>`	`getEntries()` A collection of the mapped entries.
`E`	`getEntry()` Returns the archive entry mapped for the `key` property.
`E`	`getEntry(Entry.Type type)` Returns the entry for the given type.
`Entry.Type`	`getKey()` Returns the type of the file system entry to which calls to `getEntry()`, `Entry.getSize(Size)` and `Entry.getTime(Access)` 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 entry mapped.
`String`	`getName()` Returns a string representation of the `file system entry name`.
`long`	`getSize(Entry.Size type)` Returns the size mapped for the `key` property.
`long`	`getTime(Entry.Access type)` Returns the access time mapped for the `key` property.
`Set<Entry.Type>`	`getTypes()` A set of the mapped types.
`boolean`	`isType(Entry.Type type)` Returns `true` if there is an entry mapped for the given type.
`E`	`putEntry(Entry.Type type, E entry)` Maps the given type to the given entry.
`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 entry implements a directory.
`E`	`removeEntry(Entry.Type type)` Removes the entry for the given type from the map.
`void`	`setKey(Entry.Type type)` Selects the type of the file system entry to which calls to `getEntry()`, `Entry.getSize(Size)` and `Entry.getTime(Access)` shall get forwarded.

Methods inherited from class de.schlichtherle.truezip.fs.FsEntry
equals, hashCode, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - key
```
@Nullable
private Entry.Type key
```
  - map
```
private EnumMap<Entry.Type,E extends FsArchiveEntry> map
```
  - members
```
@Nullable
private LinkedHashSet<String> members
```
  - name
```
private final String name
```
- Constructor Detail
  - FsCovariantEntry
```
public FsCovariantEntry(String path)
```
    Constructs a new covariant file system entry with 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 entry 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 entry does not implement a directory.
  - clone
```
public FsCovariantEntry<E> clone(FsArchiveDriver<E> driver)
```
    Returns a deep clone of this covariant file system entry.
    
    Parameters:
    driver - the archive driver to use for cloning the mapped archive entries.
    
    Returns:
    A deep clone of this covariant file system entry.
  - 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.
  - getEntry
```
@Nullable
public E getEntry(Entry.Type type)
```
    Returns the entry for the given type.
    
    Parameters:
    type - the type of the entry to lookup.
    
    Returns:
    The entry for the given type.
  - getKey
```
@Nullable
public Entry.Type getKey()
```
    Returns the type of the file system entry to which calls to getEntry(), Entry.getSize(Size) and Entry.getTime(Access) 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 entry of this type needs to be mapped.
    
    Returns:
    the type of the file system entry to which calls to getEntry(), Entry.getSize(Size) and Entry.getTime(Access) 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 entry mapped. This is a bidirectional view: Any change is reflected in the set and vice versa.
    
    Specified by:
    
    getMembers in class FsEntry
    
    Returns:
    A set of the members of this directory or null if and only if there is no directory entry mapped.
  - getName
```
public String getName()
```
    Description copied from class: FsEntry
    
    Returns a string representation of the file system entry name.
    
    Specified by:
    
    getName in interface Entry
    
    Specified by:
    
    getName in class FsEntry
    
    Returns:
    A string representation of the file system entry name.
    See Also:
    EntryName.create(String)
  - getSize
```
public long getSize(Entry.Size type)
```
    Returns the size mapped for the key property.
    
    Specified by:
    
    getSize in interface Entry
    
    Parameters:
    type - the size type to lookup.
    
    Returns:
    the size mapped for the key property.
  - getTime
```
public long getTime(Entry.Access type)
```
    Returns the access time mapped for the key property.
    
    Specified by:
    
    getTime in interface Entry
    
    Parameters:
    type - the access time type to lookup.
    
    Returns:
    the access time mapped for the key property.
  - getTypes
```
public Set<Entry.Type> getTypes()
```
    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 class FsEntry
    
    Returns:
    a set of the mapped types
  - isType
```
public boolean isType(Entry.Type type)
```
    Returns true if there is an entry mapped for the given type.
    
    Overrides:
    
    isType in class FsEntry
    
    Parameters:
    type - the type to lookup.
    
    Returns:
    true if there is an entry mapped for the given type.
    See Also:
    FsEntry.getTypes()
  - putEntry
```
@Nullable
public E putEntry(Entry.Type type,
                  E entry)
```
    Maps the given type to the given entry. As a side effect, the key property is set to the given type.
    
    Parameters:
    type - the type to map.
    entry - the entry to map.
    
    Returns:
    The previously mapped 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 entry 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 entry does not implement a directory.
  - removeEntry
```
@Nullable
public E removeEntry(Entry.Type type)
```
    Removes the entry for the given type from the map.
    
    Parameters:
    type - the type to remove.
    
    Returns:
    The previously mapped entry.
  - setKey
```
public void setKey(@Nullable
          Entry.Type type)
```
    Selects the type of the file system entry to which calls to getEntry(), Entry.getSize(Size) and Entry.getTime(Access) shall get forwarded. If the given type is null or no file system entry of this type is mappeed, then any subsequent call to these methods will fail with a NullPointerException.
    
    Parameters:
    type - the type of the file system entry to which calls to getEntry(), Entry.getSize(Size) and Entry.getTime(Access) shall get forwarded.

Class FsCovariantEntry<E extends FsArchiveEntry>

Nested Class Summary

Nested classes/interfaces inherited from interface de.schlichtherle.truezip.entry.Entry

Field Summary

Fields inherited from interface de.schlichtherle.truezip.entry.Entry

Constructor Summary

Method Summary

Methods inherited from class de.schlichtherle.truezip.fs.FsEntry

Methods inherited from class java.lang.Object

Field Detail

key

map

members

name

Constructor Detail

FsCovariantEntry

Method Detail

add

clone

getEntries

getEntry

getEntry

getKey

getMembers

getName

getSize

getTime

getTypes

isType

putEntry

remove

removeEntry

setKey