ReadOnlyInodeStore (Alluxio Parent 2.9.4-SNAPSHOT API)

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

InodeStore

All Known Implementing Classes:

CachingInodeStore, DelegatingReadOnlyInodeStore, HeapInodeStore, RocksInodeStore
```
public interface ReadOnlyInodeStore
extends Closeable
```
Read-only access to the inode store.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Set<EdgeEntry>`	`allEdges()`
`Set<MutableInode<?>>`	`allInodes()`
`default Optional<Inode>`	`get(long id)`
`Optional<Inode>`	`get(long id, ReadOption option)`
`default Optional<Inode>`	`getChild(InodeDirectoryView inode, String name)`
`default Optional<Inode>`	`getChild(InodeDirectoryView inode, String name, ReadOption option)`
`default Optional<Inode>`	`getChild(Long inodeId, String name)`
`Optional<Inode>`	`getChild(Long inodeId, String name, ReadOption option)`
`default Optional<Long>`	`getChildId(InodeDirectoryView inode, String name, ReadOption option)`
`default Optional<Long>`	`getChildId(Long inodeId, String name)`
`Optional<Long>`	`getChildId(Long inodeId, String name, ReadOption option)`
`default CloseableIterator<Long>`	`getChildIds(InodeDirectoryView inode, ReadOption option)` Returns an iterable for the ids of the children of the given directory.
`default CloseableIterator<Long>`	`getChildIds(Long inodeId)`
`CloseableIterator<Long>`	`getChildIds(Long inodeId, ReadOption option)` Returns an iterable for the ids of the children of the given directory.
`default CloseableIterator<? extends Inode>`	`getChildren(InodeDirectoryView inode)`
`default CloseableIterator<? extends Inode>`	`getChildren(InodeDirectoryView inode, ReadOption option)`
`default CloseableIterator<? extends Inode>`	`getChildren(Long inodeId)`
`default CloseableIterator<? extends Inode>`	`getChildren(Long inodeId, ReadOption option)` Returns an iterator over the children of the specified inode.
`default CloseableIterator<? extends Inode>`	`getChildrenFrom(long parentId, String fromName)` Returns a closeable stream of the inodes sorted by filename of the children of the given directory that come after and including fromName.
`default CloseableIterator<? extends Inode>`	`getChildrenPrefix(long parentId, String prefix)` Returns a closeable stream of the inodes sorted by filename of the children of the given directory that come after and including fromName.
`default CloseableIterator<? extends Inode>`	`getChildrenPrefixFrom(long parentId, String prefix, String fromName)` Returns a closeable stream of the inodes sorted by filename of the children of the given directory that come after and including fromName, and matching the prefix.
`default boolean`	`hasChildren(InodeDirectoryView inode)`
`boolean`	`hasChildren(InodeDirectoryView inode, ReadOption option)`

Methods inherited from interface java.io.Closeable
close

- Method Detail
  - get
```
Optional<Inode> get(long id,
                    ReadOption option)
```
    Parameters:
    
    id - an inode id
    
    option - the options
    
    Returns:
    
    the inode with the given id, if it exists
  - get
```
default Optional<Inode> get(long id)
```
    Parameters:
    
    id - an inode id
    
    Returns:
    
    the result of get(long, ReadOption) with default option
  - getChildrenFrom
```
default CloseableIterator<? extends Inode> getChildrenFrom(long parentId,
                                                           String fromName)
```
    Returns a closeable stream of the inodes sorted by filename of the children of the given directory that come after and including fromName.
    
    Parameters:
    
    parentId - the inode id of the parent directory
    
    fromName - the inode from which to start listing
    
    Returns:
    
    an iterator of the children starting from fromName
  - getChildrenPrefix
```
default CloseableIterator<? extends Inode> getChildrenPrefix(long parentId,
                                                             String prefix)
```
    Returns a closeable stream of the inodes sorted by filename of the children of the given directory that come after and including fromName.
    
    Parameters:
    
    parentId - the inode id of the parent directory
    
    prefix - the prefix to match
    
    Returns:
    
    an iterator of the children starting from fromName
  - getChildrenPrefixFrom
```
default CloseableIterator<? extends Inode> getChildrenPrefixFrom(long parentId,
                                                                 String prefix,
                                                                 String fromName)
```
    Returns a closeable stream of the inodes sorted by filename of the children of the given directory that come after and including fromName, and matching the prefix.
    
    Parameters:
    
    parentId - the inode id of the parent directory
    
    prefix - the prefix to match
    
    fromName - the inode from which to start listing
    
    Returns:
    
    an iterator of the children starting from fromName
  - getChildIds
```
CloseableIterator<Long> getChildIds(Long inodeId,
                                    ReadOption option)
```
    Returns an iterable for the ids of the children of the given directory.
    
    Parameters:
    
    inodeId - an inode id to list child ids for
    
    option - the options
    
    Returns:
    
    the child ids iterable
  - getChildIds
```
default CloseableIterator<Long> getChildIds(Long inodeId)
```
    Parameters:
    
    inodeId - an inode id to list child ids for
    
    Returns:
    
    the result of getChildIds(Long, ReadOption) with default option
  - getChildIds
```
default CloseableIterator<Long> getChildIds(InodeDirectoryView inode,
                                            ReadOption option)
```
    Returns an iterable for the ids of the children of the given directory.
    
    Parameters:
    
    inode - the inode to list child ids for
    
    option - the options
    
    Returns:
    
    the child ids iterable
  - getChildren
```
default CloseableIterator<? extends Inode> getChildren(Long inodeId,
                                                       ReadOption option)
```
    Returns an iterator over the children of the specified inode. The iterator is weakly consistent. It can operate in the presence of concurrent modification, but it is undefined whether concurrently removed inodes will be excluded or whether concurrently added inodes will be included.
    
    Parameters:
    
    inodeId - an inode id
    
    option - the options
    
    Returns:
    
    an iterable over the children of the inode with the given id
  - getChildren
```
default CloseableIterator<? extends Inode> getChildren(Long inodeId)
```
    Parameters:
    
    inodeId - an inode id
    
    Returns:
    
    the result of getChildren(Long, ReadOption) with default option
  - getChildren
```
default CloseableIterator<? extends Inode> getChildren(InodeDirectoryView inode,
                                                       ReadOption option)
```
    Parameters:
    
    inode - an inode directory
    
    option - the options
    
    Returns:
    
    an iterable over the children of the inode with the given id
  - getChildren
```
default CloseableIterator<? extends Inode> getChildren(InodeDirectoryView inode)
```
    Parameters:
    
    inode - an inode directory
    
    Returns:
    
    the result of getChildren(InodeDirectoryView, ReadOption) with default option
  - getChildId
```
Optional<Long> getChildId(Long inodeId,
                          String name,
                          ReadOption option)
```
    Parameters:
    
    inodeId - an inode id
    
    name - an inode name
    
    option - the options
    
    Returns:
    
    the id of the child of the inode with the given name
  - getChildId
```
default Optional<Long> getChildId(Long inodeId,
                                  String name)
```
    Parameters:
    
    inodeId - an inode id
    
    name - an inode name
    
    Returns:
    
    the result of getChildId(Long, String, ReadOption) with default option
  - getChildId
```
default Optional<Long> getChildId(InodeDirectoryView inode,
                                  String name,
                                  ReadOption option)
```
    Parameters:
    
    inode - an inode directory
    
    name - an inode name
    
    option - the options
    
    Returns:
    
    the id of the child of the inode with the given name
  - getChild
```
Optional<Inode> getChild(Long inodeId,
                         String name,
                         ReadOption option)
```
    Parameters:
    
    inodeId - an inode id
    
    name - an inode name
    
    option - the options
    
    Returns:
    
    the child of the inode with the given name
  - getChild
```
default Optional<Inode> getChild(Long inodeId,
                                 String name)
```
    Parameters:
    
    inodeId - an inode id
    
    name - an inode name
    
    Returns:
    
    the result of getChild(Long, String, ReadOption) with default option
  - getChild
```
default Optional<Inode> getChild(InodeDirectoryView inode,
                                 String name,
                                 ReadOption option)
```
    Parameters:
    
    inode - an inode directory
    
    name - an inode name
    
    option - the options
    
    Returns:
    
    the child of the inode with the given name
  - getChild
```
default Optional<Inode> getChild(InodeDirectoryView inode,
                                 String name)
```
    Parameters:
    
    inode - an inode directory
    
    name - an inode name
    
    Returns:
    
    the result of getChild(InodeDirectoryView, String, ReadOption) with default option
  - hasChildren
```
boolean hasChildren(InodeDirectoryView inode,
                    ReadOption option)
```
    Parameters:
    
    inode - an inode directory
    
    option - the options
    
    Returns:
    
    whether the inode has any children
  - hasChildren
```
default boolean hasChildren(InodeDirectoryView inode)
```
    Parameters:
    
    inode - an inode directory
    
    Returns:
    
    the result of hasChildren(InodeDirectoryView, ReadOption) with default option
  - allEdges
```
Set<EdgeEntry> allEdges()
```
    Returns:
    
    all edges in the inode store
  - allInodes
```
Set<MutableInode<?>> allInodes()
```
    Returns:
    
    all inodes in the inode store

Interface ReadOnlyInodeStore

Method Summary

Methods inherited from interface java.io.Closeable

Method Detail

get

get

getChildrenFrom

getChildrenPrefix

getChildrenPrefixFrom

getChildIds

getChildIds

getChildIds

getChildren

getChildren

getChildren

getChildren

getChildId

getChildId

getChildId

getChild

getChild

getChild

getChild

hasChildren

hasChildren

allEdges

allInodes