All Superinterfaces:

AItem

All Known Subinterfaces:

AFile.Wrapper, AReadableFile, AWritableFile

All Known Implementing Classes:

AFile.Default, AFile.Wrapper.Abstract
```
public interface AFile
extends AItem
```

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class AFile.Default

static interface AFile.Observer

static interface AFile.Wrapper
- Nested classes/interfaces inherited from interface org.eclipse.serializer.afs.types.AItem
  AItem.Abstract, AItem.Base

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`static AFile`	`actual(AFile file)`
`default Object`	`defaultUser()`
`default boolean`	`ensureExists()`
`default boolean`	`exists()`	Queries whether the item represented by this instance actually physically exists on the underlying storage layer.
`default boolean`	`isEmpty()`
`default boolean`	`isUsed()`
`<C extends Consumer<? super AFile.Observer>> C`	`iterateObservers(C logic)`
`default String`	`name()`	A simple String representing the "name" of the file.
`static AFile`	`New(ADirectory parent, String identifier)`
`boolean`	`registerObserver(AFile.Observer observer)`
`boolean`	`removeObserver(AFile.Observer observer)`
`default long`	`size()`	Returns the size in bytes of this file's content, without any space required for file metadata (name etc.).
`default String[]`	`toPath()`
`default String`	`toPathString()`	The value that uniquely identifies the item globally in the whole file system.
`default AReadableFile`	`tryUseReading()`
`default AReadableFile`	`tryUseReading(Object user)`
`default AWritableFile`	`tryUseWriting()`
`default AWritableFile`	`tryUseWriting(Object user)`
`default String`	`type()`	An optional String defining the type of the file's content.
`default AReadableFile`	`useReading()`
`default AReadableFile`	`useReading(Object user)`
`default AWritableFile`	`useWriting()`
`default AWritableFile`	`useWriting(Object user)`

Methods inherited from interface org.eclipse.serializer.afs.types.AItem
fileSystem, identifier, parent

- Method Detail
  - toPathString
```
default String toPathString()
```
    Description copied from interface: AItem
    
    The value that uniquely identifies the item globally in the whole file system.
    Note that this value is usually a combination of the identifiers of AItem.parent() directories and the local AItem.identifier(), but such a relation is not mandatory.
    
    Specified by:
    
    toPathString in interface AItem
    
    Returns:
    
    the item's globally unique identifier.
    
    See Also:
    
    AItem.parent(), AItem.identifier()
  - toPath
```
default String[] toPath()
```
    Specified by:
    
    toPath in interface AItem
  - name
```
default String name()
```
    A simple String representing the "name" of the file. While no two files can have the same AItem.identifier() inside a given directory, any number of files can have the same name.
    Depending on the file system implementation, name() might be the same value as AItem.identifier(), but while AItem.identifier() is guaranteed to be a unique local identifier for any file system, name() is not.
    
    Returns:
    
    the file's name.
    
    See Also:
    
    toPathString(), AItem.identifier(), type()
  - type
```
default String type()
```
    An optional String defining the type of the file's content.
    If such an information makes no sense for a certain file system, this value may be null.
    
    Returns:
    
    the file's type.
  - size
```
default long size()
```
    Returns the size in bytes of this file's content, without any space required for file metadata (name etc.).
    
    Returns:
    
    the size in bytes of this file's content.
  - isEmpty
```
default boolean isEmpty()
```
  - registerObserver
```
boolean registerObserver(AFile.Observer observer)
```
  - removeObserver
```
boolean removeObserver(AFile.Observer observer)
```
  - iterateObservers
```
<C extends Consumer<? super AFile.Observer>> C iterateObservers(C logic)
```
  - useReading
```
default AReadableFile useReading(Object user)
```
  - useWriting
```
default AWritableFile useWriting(Object user)
```
  - useReading
```
default AReadableFile useReading()
```
  - useWriting
```
default AWritableFile useWriting()
```
  - tryUseReading
```
default AReadableFile tryUseReading(Object user)
```
  - tryUseWriting
```
default AWritableFile tryUseWriting(Object user)
```
  - tryUseReading
```
default AReadableFile tryUseReading()
```
  - tryUseWriting
```
default AWritableFile tryUseWriting()
```
  - exists
```
default boolean exists()
```
    Description copied from interface: AItem
    
    Queries whether the item represented by this instance actually physically exists on the underlying storage layer.
    
    Specified by:
    
    exists in interface AItem
    
    Returns:
    
    whether the item exists.
  - ensureExists
```
default boolean ensureExists()
```
  - isUsed
```
default boolean isUsed()
```
  - defaultUser
```
default Object defaultUser()
```
  - New
```
static AFile New(ADirectory parent,
                 String identifier)
```
  - actual
```
static AFile actual(AFile file)
```

Modifier and Type	Interface	Description
`static class`	`AFile.Default`
`static interface`	`AFile.Observer`
`static interface`	`AFile.Wrapper`

Interface AFile

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.serializer.afs.types.AItem

Method Summary

Methods inherited from interface org.eclipse.serializer.afs.types.AItem

Method Detail

toPathString

toPath

name

type

size

isEmpty

registerObserver

removeObserver

iterateObservers

useReading

useWriting

useReading

useWriting

tryUseReading

tryUseWriting

tryUseReading

tryUseWriting

exists

ensureExists

isUsed

defaultUser

New

actual