alluxio.master.file.meta

Class InodeDirectory

java.lang.Object

alluxio.master.file.meta.Inode<InodeDirectory>

alluxio.master.file.meta.InodeDirectory

All Implemented Interfaces:

JournalEntryRepresentable

@NotThreadSafe
public final class InodeDirectory
extends Inode<InodeDirectory>

Alluxio file system's directory representation in the file system master. The inode must be locked (Inode.lockRead() or Inode.lockWrite()) before methods are called.

Field Summary

Fields inherited from class alluxio.master.file.meta.Inode

mCreationTimeMs, mDirectory, mId, mTtl, mTtlAction

Method Summary

Modifier and Type	Method and Description
boolean	addChild(Inode<?> child) Adds the given inode to the set of children.
boolean	areDescendantsLoaded() Before calling this method, the caller should hold at least a READ LOCK on the inode.
static InodeDirectory	create(long id, long parentId, String name, CreateDirectoryOptions options) Creates an InodeDirectory.
static InodeDirectory	fromJournalEntry(File.InodeDirectoryEntry entry) Converts the entry to an InodeDirectory.
FileInfo	generateClientFileInfo(String path) Generates client file info for a folder.
Inode<?>	getChild(String name)
Inode<?>	getChildReadLock(String name, InodeLockList lockList)
Set<Inode<?>>	getChildren()
Set<Long>	getChildrenIds()
Inode<?>	getChildWriteLock(String name, InodeLockList lockList)
int	getNumberOfChildren()
protected InodeDirectory	getThis()
boolean	isDirectChildrenLoaded()
boolean	isMountPoint()
boolean	removeChild(Inode<?> child) Removes the given inode from the directory.
boolean	removeChild(String name) Removes the given child by its name from the directory.
InodeDirectory	setDirectChildrenLoaded(boolean directChildrenLoaded)
InodeDirectory	setMountPoint(boolean mountPoint)
Journal.JournalEntry	toJournalEntry()
String	toString()

Methods inherited from class alluxio.master.file.meta.Inode

compareAndSwap, equals, getCreationTimeMs, getGroup, getId, getLastModificationTimeMs, getMode, getName, getOwner, getParentId, getPersistenceState, getTtl, getTtlAction, getUfsFingerprint, hashCode, isDeleted, isDirectory, isFile, isPersisted, isPinned, isReadLocked, isWriteLocked, lockRead, lockReadAndCheckNameAndParent, lockReadAndCheckParent, lockWrite, lockWriteAndCheckNameAndParent, lockWriteAndCheckParent, setCreationTimeMs, setDeleted, setGroup, setLastModificationTimeMs, setLastModificationTimeMs, setMode, setName, setOwner, setParentId, setPersistenceState, setPinned, setTtl, setTtlAction, setUfsFingerprint, toStringHelper, unlockRead, unlockWrite

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getThis

protected InodeDirectory getThis()

Specified by:

getThis in class Inode<InodeDirectory>

Returns:

this so that the abstract class can use the fluent builder pattern

addChild

public boolean addChild(Inode<?> child)

Adds the given inode to the set of children.

Parameters:

child - the inode to add

Returns:

true if inode was added successfully, false otherwise

getChild

public Inode<?> getChild(String name)

Parameters:

name - the name of the child

Returns:

the inode with the given name, or null if there is no child with that name

getChildReadLock

@Nullable
public Inode<?> getChildReadLock(String name,
                                           InodeLockList lockList)
                                    throws InvalidPathException

Parameters:

name - the name of the child

lockList - the lock list to add the lock to

Returns:

the read-locked inode with the given name, or null if there is no such child

Throws:

InvalidPathException - if the path to the child is invalid

getChildWriteLock

@Nullable
public Inode<?> getChildWriteLock(String name,
                                            InodeLockList lockList)
                                     throws InvalidPathException

Parameters:

name - the name of the child

lockList - the lock list to add the lock to

Returns:

the write-locked inode with the given name, or null if there is no such child

Throws:

InvalidPathException - if the path to the child is invalid

getChildren

public Set<Inode<?>> getChildren()

Returns:

an unmodifiable set of the children inodes

getChildrenIds

public Set<Long> getChildrenIds()

Returns:

the ids of the children

getNumberOfChildren

public int getNumberOfChildren()

Returns:

the number of children in the directory

isMountPoint

public boolean isMountPoint()

Returns:

true if the inode is a mount point, false otherwise

isDirectChildrenLoaded

public boolean isDirectChildrenLoaded()

Returns:

true if we have loaded all the direct children's metadata once

areDescendantsLoaded

public boolean areDescendantsLoaded()

Before calling this method, the caller should hold at least a READ LOCK on the inode.

Returns:

true if we have loaded all the direct and indirect children's metadata once

removeChild

public boolean removeChild(Inode<?> child)

Removes the given inode from the directory.

Parameters:

child - the Inode to remove

Returns:

true if the inode was removed, false otherwise

removeChild

public boolean removeChild(String name)

Removes the given child by its name from the directory.

Parameters:

name - the name of the Inode to remove

Returns:

true if the inode was removed, false otherwise

setMountPoint

public InodeDirectory setMountPoint(boolean mountPoint)

Parameters:

mountPoint - the mount point flag value to use

Returns:

the updated object

setDirectChildrenLoaded

public InodeDirectory setDirectChildrenLoaded(boolean directChildrenLoaded)

Parameters:

directChildrenLoaded - whether to load the direct children if they were not loaded before

Returns:

the updated object

generateClientFileInfo

public FileInfo generateClientFileInfo(String path)

Generates client file info for a folder.

Specified by:

generateClientFileInfo in class Inode<InodeDirectory>

Parameters:

path - the path of the folder in the filesystem

Returns:

the generated FileInfo

toString

public String toString()

Overrides:

toString in class Object

fromJournalEntry

public static InodeDirectory fromJournalEntry(File.InodeDirectoryEntry entry)

Converts the entry to an InodeDirectory.

Parameters:

entry - the entry to convert

Returns:

the InodeDirectory representation

create

public static InodeDirectory create(long id,
                                    long parentId,
                                    String name,
                                    CreateDirectoryOptions options)

Creates an InodeDirectory.

Parameters:

id - id of this inode

parentId - id of the parent of this inode

name - name of this inode

options - options to create this directory

Returns:

the InodeDirectory representation

toJournalEntry

public Journal.JournalEntry toJournalEntry()

Returns:

the Journal.JournalEntry representing this object