com.atlassian.crowd.acceptance.utils

Class DbCachingTestHelper.PartialSyncTask

java.lang.Object

com.atlassian.crowd.acceptance.utils.DbCachingTestHelper.PartialSyncTask

Enclosing class:

DbCachingTestHelper

public class DbCachingTestHelper.PartialSyncTask
extends Object

Uses the Builder pattern to create a synchronisation task.

Constructor Summary

Constructors

Constructor and Description
PartialSyncTask(String directoryName)

Method Summary

Modifier and Type	Method and Description
DbCachingTestHelper.PartialSyncTask	maxWaitMs(long maxWaitMs) Sets the maximum time in milliseconds to wait for synchronisation to finish.
DbCachingTestHelper.PartialSyncTask	shortDescription(String shortDescription) Sets a short description of the synchronisation task.
DbCachingTestHelper.SyncInfo	sync() Synchronises the directory and waits until the synchronisation has finished.

Methods inherited from class java.lang.Object

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

Constructor Detail

PartialSyncTask

public PartialSyncTask(String directoryName)

Parameters:

directoryName - Name of the directory to synchronise.

Method Detail

maxWaitMs

public DbCachingTestHelper.PartialSyncTask maxWaitMs(long maxWaitMs)

Sets the maximum time in milliseconds to wait for synchronisation to finish.

Parameters:

maxWaitMs - maximum wait time in milliseconds

shortDescription

public DbCachingTestHelper.PartialSyncTask shortDescription(String shortDescription)

Sets a short description of the synchronisation task.

Parameters:

shortDescription - of the synchronisation task.

sync

public DbCachingTestHelper.SyncInfo sync()

Synchronises the directory and waits until the synchronisation has finished. Use as a convenience method for a one-off synchronisation. Otherwise instantiate an instance of DbCachingTestHelper.

Returns:

SyncInfo

Throws:

RuntimeException - if the synchronisation doesn't finish within the specified maximum wait time (or default time if no max wait time was set).