Inode (Alluxio Parent 1.8.3-SNAPSHOT API)

java.lang.Object
- alluxio.master.file.meta.Inode<T>

Type Parameters:

T - the concrete subclass of this object

All Implemented Interfaces:

JournalEntryRepresentable

Direct Known Subclasses:

InodeDirectory, InodeFile
```
@NotThreadSafe
public abstract class Inode<T>
extends Object
implements JournalEntryRepresentable
```
Inode is an abstract class, with information shared by all types of Inodes. The inode must be locked (lockRead() or lockWrite()) before methods are called.

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`mCreationTimeMs`
`protected boolean`	`mDirectory`
`protected long`	`mId`
`protected long`	`mTtl`
`protected TtlAction`	`mTtlAction`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Inode(long id, boolean isDirectory)

Constructors
Modifier	Constructor and Description
`protected`	`Inode(long id, boolean isDirectory)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`compareAndSwap(PersistenceState oldState, PersistenceState newState)` Compare-and-swaps the persistence state.
`boolean`	`equals(Object o)`
`abstract FileInfo`	`generateClientFileInfo(String path)` Generates a `FileInfo` of the file or folder.
`long`	`getCreationTimeMs()`
`String`	`getGroup()`
`long`	`getId()`
`long`	`getLastModificationTimeMs()`
`short`	`getMode()`
`String`	`getName()`
`String`	`getOwner()`
`long`	`getParentId()`
`PersistenceState`	`getPersistenceState()`
`protected abstract T`	`getThis()`
`long`	`getTtl()`
`TtlAction`	`getTtlAction()`
`String`	`getUfsFingerprint()`
`int`	`hashCode()`
`boolean`	`isDeleted()`
`boolean`	`isDirectory()`
`boolean`	`isFile()`
`boolean`	`isPersisted()`
`boolean`	`isPinned()`
`boolean`	`isReadLocked()`
`boolean`	`isWriteLocked()`
`void`	`lockRead()` Obtains a read lock on the inode.
`void`	`lockReadAndCheckNameAndParent(Inode parent, String name)` Obtains a read lock on the inode.
`void`	`lockReadAndCheckParent(Inode parent)` Obtains a read lock on the inode.
`void`	`lockWrite()` Obtains a write lock on the inode.
`void`	`lockWriteAndCheckNameAndParent(Inode parent, String name)` Obtains a write lock on the inode.
`void`	`lockWriteAndCheckParent(Inode parent)` Obtains a write lock on the inode.
`T`	`setCreationTimeMs(long creationTimeMs)`
`T`	`setDeleted(boolean deleted)`
`T`	`setGroup(String group)`
`T`	`setLastModificationTimeMs(long lastModificationTimeMs)` Sets the last modification time of the inode to the new time if the new time is more recent.
`T`	`setLastModificationTimeMs(long lastModificationTimeMs, boolean override)`
`T`	`setMode(short mode)`
`T`	`setName(String name)`
`T`	`setOwner(String owner)`
`T`	`setParentId(long parentId)`
`T`	`setPersistenceState(PersistenceState persistenceState)`
`T`	`setPinned(boolean pinned)`
`T`	`setTtl(long ttl)`
`T`	`setTtlAction(TtlAction ttlAction)`
`T`	`setUfsFingerprint(String ufsFingerprint)`
`protected com.google.common.base.Objects.ToStringHelper`	`toStringHelper()`
`void`	`unlockRead()` Releases the read lock for this inode.
`void`	`unlockWrite()` Releases the write lock for this inode.

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

Methods inherited from interface alluxio.master.journal.JournalEntryRepresentable
toJournalEntry

- Field Detail
  - mCreationTimeMs
```
protected long mCreationTimeMs
```
  - mDirectory
```
protected final boolean mDirectory
```
  - mId
```
protected final long mId
```
  - mTtl
```
protected long mTtl
```
  - mTtlAction
```
protected TtlAction mTtlAction
```
- Constructor Detail
  - Inode
```
protected Inode(long id,
                boolean isDirectory)
```
- Method Detail
  - getCreationTimeMs
```
public long getCreationTimeMs()
```
    Returns:
    
    the create time, in milliseconds
  - getGroup
```
public String getGroup()
```
    Returns:
    
    the group of the inode
  - getId
```
public long getId()
```
    Returns:
    
    the id of the inode
  - getTtl
```
public long getTtl()
```
    Returns:
    
    the ttl of the file
  - getTtlAction
```
public TtlAction getTtlAction()
```
    Returns:
    
    the TtlAction
  - getLastModificationTimeMs
```
public long getLastModificationTimeMs()
```
    Returns:
    
    the last modification time, in milliseconds
  - getName
```
public String getName()
```
    Returns:
    
    the name of the inode
  - getMode
```
public short getMode()
```
    Returns:
    
    the mode of the inode
  - getPersistenceState
```
public PersistenceState getPersistenceState()
```
    Returns:
    
    the PersistenceState of the inode
  - compareAndSwap
```
public boolean compareAndSwap(PersistenceState oldState,
                              PersistenceState newState)
```
    Compare-and-swaps the persistence state.
    
    Parameters:
    
    oldState - the old PersistenceState
    
    newState - the new PersistenceState to set
    
    Returns:
    
    true if the old state matches and the new state was set
  - getParentId
```
public long getParentId()
```
    Returns:
    
    the id of the parent folder
  - getOwner
```
public String getOwner()
```
    Returns:
    
    the owner of the inode
  - isDeleted
```
public boolean isDeleted()
```
    Returns:
    
    true if the inode is deleted, false otherwise
  - isDirectory
```
public boolean isDirectory()
```
    Returns:
    
    true if the inode is a directory, false otherwise
  - isFile
```
public boolean isFile()
```
    Returns:
    
    true if the inode is a file, false otherwise
  - isPinned
```
public boolean isPinned()
```
    Returns:
    
    true if the inode is pinned, false otherwise
  - isPersisted
```
public boolean isPersisted()
```
    Returns:
    
    true if the file has persisted, false otherwise
  - getUfsFingerprint
```
public String getUfsFingerprint()
```
    Returns:
    
    the UFS fingerprint
  - setCreationTimeMs
```
public T setCreationTimeMs(long creationTimeMs)
```
    Parameters:
    
    creationTimeMs - the creation time to use (in milliseconds)
    
    Returns:
    
    the updated object
  - setDeleted
```
public T setDeleted(boolean deleted)
```
    Parameters:
    
    deleted - the deleted flag to use
    
    Returns:
    
    the updated object
  - setGroup
```
public T setGroup(String group)
```
    Parameters:
    
    group - the group of the inode
    
    Returns:
    
    the updated object
  - setLastModificationTimeMs
```
public T setLastModificationTimeMs(long lastModificationTimeMs)
```
    Sets the last modification time of the inode to the new time if the new time is more recent. This method can be called concurrently with deterministic results.
    
    Parameters:
    
    lastModificationTimeMs - the last modification time to use
    
    Returns:
    
    the updated object
  - setLastModificationTimeMs
```
public T setLastModificationTimeMs(long lastModificationTimeMs,
                                   boolean override)
```
    Parameters:
    
    lastModificationTimeMs - the last modification time to use
    
    override - if true, sets the value regardless of the previous last modified time, should be set to true for journal replay
    
    Returns:
    
    the updated object
  - setName
```
public T setName(String name)
```
    Parameters:
    
    name - the name to use
    
    Returns:
    
    the updated object
  - setParentId
```
public T setParentId(long parentId)
```
    Parameters:
    
    parentId - the parent id to use
    
    Returns:
    
    the updated object
  - setTtl
```
public T setTtl(long ttl)
```
    Parameters:
    
    ttl - the TTL to use, in milliseconds
    
    Returns:
    
    the updated object
  - setTtlAction
```
public T setTtlAction(TtlAction ttlAction)
```
    Parameters:
    
    ttlAction - the TtlAction to use
    
    Returns:
    
    the updated options object
  - setPersistenceState
```
public T setPersistenceState(PersistenceState persistenceState)
```
    Parameters:
    
    persistenceState - the PersistenceState to use
    
    Returns:
    
    the updated object
  - setPinned
```
public T setPinned(boolean pinned)
```
    Parameters:
    
    pinned - the pinned flag value to use
    
    Returns:
    
    the updated object
  - setOwner
```
public T setOwner(String owner)
```
    Parameters:
    
    owner - the owner name of the inode
    
    Returns:
    
    the updated object
  - setMode
```
public T setMode(short mode)
```
    Parameters:
    
    mode - the mode of the inode
    
    Returns:
    
    the updated object
  - setUfsFingerprint
```
public T setUfsFingerprint(String ufsFingerprint)
```
    Parameters:
    
    ufsFingerprint - the ufs fingerprint to use
    
    Returns:
    
    the updated object
  - generateClientFileInfo
```
public abstract FileInfo generateClientFileInfo(String path)
```
    Generates a FileInfo of the file or folder.
    
    Parameters:
    
    path - the path of the file
    
    Returns:
    
    generated FileInfo
  - getThis
```
protected abstract T getThis()
```
    Returns:
    
    this so that the abstract class can use the fluent builder pattern
  - lockRead
```
public void lockRead()
```
    Obtains a read lock on the inode. This call should only be used when locking the root or an inode by id and not path or parent.
  - lockReadAndCheckParent
```
public void lockReadAndCheckParent(Inode parent)
                            throws InvalidPathException
```
    Obtains a read lock on the inode. Afterward, checks the inode state: - parent is consistent with what the caller is expecting - the inode is not marked as deleted If the state is inconsistent, an exception will be thrown and the lock will be released. NOTE: This method assumes that the inode path to the parent has been read locked.
    
    Parameters:
    
    parent - the expected parent inode
    
    Throws:
    
    InvalidPathException - if the parent is not as expected
  - lockReadAndCheckNameAndParent
```
public void lockReadAndCheckNameAndParent(Inode parent,
                                          String name)
                                   throws InvalidPathException
```
    Obtains a read lock on the inode. Afterward, checks the inode state to ensure the full inode path is consistent with what the caller is expecting. If the state is inconsistent, an exception will be thrown and the lock will be released. NOTE: This method assumes that the inode path to the parent has been read locked.
    
    Parameters:
    
    parent - the expected parent inode
    
    name - the expected name of the inode to be locked
    
    Throws:
    
    InvalidPathException - if the parent and/or name is not as expected
  - lockWrite
```
public void lockWrite()
```
    Obtains a write lock on the inode. This call should only be used when locking the root or an inode by id and not path or parent.
  - lockWriteAndCheckParent
```
public void lockWriteAndCheckParent(Inode parent)
                             throws InvalidPathException
```
    Obtains a write lock on the inode. Afterward, checks the inode state: - parent is consistent with what the caller is expecting - the inode is not marked as deleted If the state is inconsistent, an exception will be thrown and the lock will be released. NOTE: This method assumes that the inode path to the parent has been read locked.
    
    Parameters:
    
    parent - the expected parent inode
    
    Throws:
    
    InvalidPathException - if the parent is not as expected
  - lockWriteAndCheckNameAndParent
```
public void lockWriteAndCheckNameAndParent(Inode parent,
                                           String name)
                                    throws InvalidPathException
```
    Obtains a write lock on the inode. Afterward, checks the inode state to ensure the full inode path is consistent with what the caller is expecting. If the state is inconsistent, an exception will be thrown and the lock will be released. NOTE: This method assumes that the inode path to the parent has been read locked.
    
    Parameters:
    
    parent - the expected parent inode
    
    name - the expected name of the inode to be locked
    
    Throws:
    
    InvalidPathException - if the parent and/or name is not as expected
  - unlockRead
```
public void unlockRead()
```
    Releases the read lock for this inode.
  - unlockWrite
```
public void unlockWrite()
```
    Releases the write lock for this inode.
  - isWriteLocked
```
public boolean isWriteLocked()
```
    Returns:
    
    returns true if the current thread holds a write lock on this inode, false otherwise
  - isReadLocked
```
public boolean isReadLocked()
```
    Returns:
    
    returns true if the current thread holds a read lock on this inode, false otherwise
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - toStringHelper
```
protected com.google.common.base.Objects.ToStringHelper toStringHelper()
```

Class Inode<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface alluxio.master.journal.JournalEntryRepresentable

Field Detail

mCreationTimeMs

mDirectory

mId

mTtl

mTtlAction

Constructor Detail

Inode

Method Detail

getCreationTimeMs

getGroup

getId

getTtl

getTtlAction

getLastModificationTimeMs

getName

getMode

getPersistenceState

compareAndSwap

getParentId

getOwner

isDeleted

isDirectory

isFile

isPinned

isPersisted

getUfsFingerprint

setCreationTimeMs

setDeleted

setGroup

setLastModificationTimeMs

setLastModificationTimeMs

setName

setParentId

setTtl

setTtlAction

setPersistenceState

setPinned

setOwner

setMode

setUfsFingerprint

generateClientFileInfo

getThis

lockRead

lockReadAndCheckParent

lockReadAndCheckNameAndParent

lockWrite

lockWriteAndCheckParent

lockWriteAndCheckNameAndParent

unlockRead

unlockWrite

isWriteLocked

isReadLocked

hashCode

equals

toStringHelper