alluxio.master.file.meta

Class SyncCheck

java.lang.Object

alluxio.master.file.meta.SyncCheck

public class SyncCheck
extends Object

Returned by UfsSyncPathCache.shouldSyncPath(alluxio.AlluxioURI, long, alluxio.file.options.DescendantType) indicating whether a sync is needed as well as the time of the last sync if one is not needed. After the sync is performed, calling syncSuccess() or skippedSync() will result in creating an object containing information pertaining to the result of the sync.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SyncCheck.SyncResult Information about the result of a synchronization, created by calling syncSuccess() or skippedSync(), or using SyncCheck.SyncResult.INVALID_RESULT if the sync failed due to an external reason.

Field Summary

Fields

Modifier and Type	Field and Description
static SyncCheck	SHOULD_NOT_SYNC Sync is not needed, with no last sync time.
static SyncCheck	SHOULD_SYNC Sync is needed.

Method Summary

Modifier and Type	Method and Description
long	getLastSyncTime()
boolean	isShouldSync()
static SyncCheck	shouldNotSyncWithTime(long lastSyncTime) Create a SyncCheck object indicating a sync is not needed due to a recent sync.
static SyncCheck	shouldSyncWithTime(long lastSyncTime) Create a SyncCheck object indicating a sync is needed, given the last sync time.
SyncCheck.SyncResult	skippedSync() This method should be called if the sync skipped due to the existence of a recent sync.
SyncCheck.SyncResult	syncSuccess() This method should be called if the sync was performed successfully.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SHOULD_NOT_SYNC

public static final SyncCheck SHOULD_NOT_SYNC

Sync is not needed, with no last sync time.

SHOULD_SYNC

public static final SyncCheck SHOULD_SYNC

Sync is needed.

Method Detail

shouldSyncWithTime

public static SyncCheck shouldSyncWithTime(long lastSyncTime)

Create a SyncCheck object indicating a sync is needed, given the last sync time.

Parameters:

lastSyncTime - the time of the last sync

Returns:

the result object

shouldNotSyncWithTime

public static SyncCheck shouldNotSyncWithTime(long lastSyncTime)

Create a SyncCheck object indicating a sync is not needed due to a recent sync.

Parameters:

lastSyncTime - the time of the last sync

Returns:

the result object

toString

public String toString()

Overrides:

toString in class Object

isShouldSync

public boolean isShouldSync()

Returns:

true if a sync is necessary

getLastSyncTime

public long getLastSyncTime()

Returns:

the time of the last sync for the path

syncSuccess

public SyncCheck.SyncResult syncSuccess()

This method should be called if the sync was performed successfully.

Returns:

the SyncCheck.SyncResult object

skippedSync

public SyncCheck.SyncResult skippedSync()

This method should be called if the sync skipped due to the existence of a recent sync.

Returns:

the SyncCheck.SyncResult object