Package org.eclipse.serializer.afs.types

Interface ADirectory

All Superinterfaces:

AItem, AResolving

All Known Subinterfaces:

ADirectory.Wrapper, ARoot

All Known Implementing Classes:

ADirectory.Abstract, ADirectory.Default, ARoot.Default

public interface ADirectory
extends AItem, AResolving

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ADirectory.Abstract
static class	ADirectory.Default
static interface	ADirectory.Observer
static interface	ADirectory.Wrapper

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

AItem.Base

Method Summary

Modifier and Type	Method	Description
<R> R	accessDirectories(Function<? super XGettingTable<String,? extends ADirectory>,R> logic)
<S,R> R	accessDirectories(S subject, BiFunction<? super XGettingTable<String,? extends ADirectory>,S,R> logic)
<R> R	accessFiles(Function<? super XGettingTable<String,? extends AFile>,R> logic)
<S,R> R	accessFiles(S subject, BiFunction<? super XGettingTable<String,? extends AFile>,S,R> logic)
static ADirectory	actual(ADirectory directory)
int	consolidate()	Removes all child items (ADirectory or AFile) that have no physical equivalent.
int	consolidateDirectories()
int	consolidateFiles()
default boolean	contains(ADirectory directory)
default boolean	contains(AFile file)
boolean	contains(AItem item)
default boolean	containsDeep(ADirectory directory)
default boolean	containsDeep(AFile file)
boolean	containsDeep(AItem item)
boolean	containsDirectory(String directoryName)
boolean	containsFile(String fileName)
boolean	containsItem(String itemName)
ADirectory	ensureDirectory(String identifier)
default boolean	ensureExists()
default AFile	ensureFile(String identifier)
default AFile	ensureFile(String name, String type)
AFile	ensureFile(String identifier, String name, String type)
default boolean	exists()	Queries whether the item represented by this instance actually physically exists on the underlying storage layer.
ADirectory	getDirectory(String identifier)
AFile	getFile(String identifier)
AItem	getItem(String identifier)
ADirectory	inventorize()
boolean	isEmpty()	Returns true if the directory does not contain any other file or directories
<C extends Consumer<? super ADirectory>> C	iterateDirectories(C iterator)
<C extends Consumer<? super AFile>> C	iterateFiles(C iterator)
<C extends Consumer<? super AItem>> C	iterateItems(C iterator)
<C extends Consumer<? super ADirectory.Observer>> C	iterateObservers(C logic)
default XGettingEnum<ADirectory>	listDirectories()
default XGettingEnum<AFile>	listFiles()
default XGettingEnum<AItem>	listItems()
static ADirectory	New(ADirectory parent, String identifier)
boolean	registerObserver(ADirectory.Observer observer)
boolean	removeObserver(ADirectory.Observer observer)
ADirectory	resolveDirectoryPath(String[] pathElements, int offset, int length)
default String[]	toPath()
default String	toPathString()	The value that uniquely identifies the item globally in the whole file system.

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

fileSystem, identifier, parent

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

resolveDirectoryPath, resolveFilePath, resolveFilePath, resolveFilePath

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

accessDirectories

<R> R accessDirectories(Function<? super XGettingTable<String,? extends ADirectory>,R> logic)

accessFiles

<R> R accessFiles(Function<? super XGettingTable<String,? extends AFile>,R> logic)

accessDirectories

<S,R> R accessDirectories(S subject,
                                BiFunction<? super XGettingTable<String,? extends ADirectory>,S,R> logic)

accessFiles

<S,R> R accessFiles(S subject,
                          BiFunction<? super XGettingTable<String,? extends AFile>,S,R> logic)

registerObserver

boolean registerObserver(ADirectory.Observer observer)

removeObserver

boolean removeObserver(ADirectory.Observer observer)

iterateObservers

<C extends Consumer<? super ADirectory.Observer>> C iterateObservers(C logic)

ensureExists

default boolean ensureExists()

ensureDirectory

ADirectory ensureDirectory(String identifier)

ensureFile

default AFile ensureFile(String identifier)

ensureFile

default AFile ensureFile(String name,
                         String type)

ensureFile

AFile ensureFile(String identifier,
                 String name,
                 String type)

getItem

AItem getItem(String identifier)

getDirectory

ADirectory getDirectory(String identifier)

getFile

AFile getFile(String identifier)

iterateItems

<C extends Consumer<? super AItem>> C iterateItems(C iterator)

iterateDirectories

<C extends Consumer<? super ADirectory>> C iterateDirectories(C iterator)

iterateFiles

<C extends Consumer<? super AFile>> C iterateFiles(C iterator)

inventorize

ADirectory inventorize()

listItems

default XGettingEnum<AItem> listItems()

listDirectories

default XGettingEnum<ADirectory> listDirectories()

listFiles

default XGettingEnum<AFile> listFiles()

contains

boolean contains(AItem item)

contains

default boolean contains(ADirectory directory)

contains

default boolean contains(AFile file)

containsDeep

boolean containsDeep(AItem item)

containsDeep

default boolean containsDeep(ADirectory directory)

containsDeep

default boolean containsDeep(AFile file)

containsItem

boolean containsItem(String itemName)

containsDirectory

boolean containsDirectory(String directoryName)

containsFile

boolean containsFile(String fileName)

resolveDirectoryPath

ADirectory resolveDirectoryPath(String[] pathElements,
                                int offset,
                                int length)

Specified by:

resolveDirectoryPath in interface AResolving

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.

consolidate

int consolidate()

Removes all child items (ADirectory or AFile) that have no physical equivalent.

Returns:

the amount of removed items

consolidateDirectories

int consolidateDirectories()

consolidateFiles

int consolidateFiles()

isEmpty

boolean isEmpty()

Returns true if the directory does not contain any other file or directories

Returns:

true if this directory is empty

New

static ADirectory New(ADirectory parent,
                      String identifier)

actual

static ADirectory actual(ADirectory directory)