BulkOperationUtil (utils 2.0.1 API)

java.lang.Object
- com.bluejeans.utils.BulkOperationUtil<E>

Type Parameters:

E - the entity type
```
public class BulkOperationUtil<E>
extends Object
```
Bulk operation utils for queuing elements and performing bulk operation on them at once, interval based

Author:

Dinesh Ilindra

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`BulkOperationUtil.BulkOperation<E>` The interface for the bulk operation
`static class`	`BulkOperationUtil.BulkStatus`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(E e)` Add the given element to queue
`static <E> BulkOperationUtil<E>`	`create(int bulkPollInterval, int capacity, BulkOperationUtil.BulkOperation<E> bulkOperation)` Create based on parameters
`static <E> BulkOperationUtil<E>`	`create(int bulkPollInterval, int capacity, BulkOperationUtil.BulkOperation<E> bulkOperation, int batchSize, int bulkExecutorSize, int bulkExecutorQueueCapacity)` Create based on parameters
`static <E> BulkOperationUtil<E>`	`create(int bulkPollInterval, int capacity, String queueDir, String queueName, long bigQueueTimerInterval, BulkOperationUtil.BulkOperation<E> bulkOperation, int batchSize, int bulkExecutorSize, int bulkExecutorQueueCapacity)` Create based on parameters
`static <E> BulkOperationUtil<E>`	`create(int bulkPollInterval, int capacity, String queueDir, String queueName, long bigQueueTimerInterval, BulkOperationUtil.BulkOperation<E> bulkOperation, int batchSize, int bulkExecutorSize, int bulkExecutorQueueCapacity, boolean start)` Create based on parameters
`void`	`doBulk()` Do the bulk operation.
`void`	`dummyElementIs(E el)`
`void`	`entityTypeIs(Class<E> entityType)`
`int`	`getBatchSize()`
`BigQueue<E>`	`getBigQueue()`
`Timer`	`getBigQueueTimer()`
`long`	`getBigQueueTimerInterval()`
`ThreadPoolExecutor`	`getBulkExecutor()`
`int`	`getBulkExecutorQueueCapacity()`
`int`	`getBulkExecutorSize()`
`BulkOperationUtil.BulkOperation<E>`	`getBulkOperation()`
`long`	`getBulkPollInterval()`
`int`	`getBulkRetryCount()`
`Runnable`	`getBulkRunnable()`
`EnumCounter<BulkOperationUtil.BulkStatus>`	`getBulkStatusCounter()`
`com.bluejeans.utils.BulkOperationUtil.Doer`	`getDoer()`
`E`	`getDummyElement()`
`Class<?>`	`getEntityType()`
`int`	`getMinBatchSize()`
`BlockingQueue<E>`	`getQueue()`
`AtomicLong`	`getQueueAddFailCount()`
`String`	`getQueueDir()`
`String`	`getQueueName()`
`long`	`getQueueSize()` Get the queue size
`boolean`	`isBulkRetryEnabled()`
`boolean`	`isFileBased()`
`boolean`	`isParallel()`
`boolean`	`isPeekEnabled()`
`boolean`	`isStopped()`
`boolean`	`isWaitEnabled()`
`void`	`setBatchSize(int batchSize)`
`void`	`setBulkRetryCount(int bulkRetryCount)`
`void`	`setBulkRetryEnabled(boolean bulkRetryEnabled)`
`void`	`setDummyElement(E dummyElement)`
`void`	`setEntityType(Class<E> entityType)`
`void`	`setFileBased(boolean fileBased)`
`void`	`setMinBatchSize(int minBatchSize)`
`void`	`setParallel(boolean parallel)`
`void`	`setPeekEnabled(boolean peekEnabled)`
`void`	`setWaitEnabled(boolean waitEnabled)`
`void`	`start()` start
`void`	`stop()` Stop the utility and operate on any remaining elements in queue.

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

Method Detail

create

public static <E> BulkOperationUtil<E> create(int bulkPollInterval,
                                              int capacity,
                                              String queueDir,
                                              String queueName,
                                              long bigQueueTimerInterval,
                                              BulkOperationUtil.BulkOperation<E> bulkOperation,
                                              int batchSize,
                                              int bulkExecutorSize,
                                              int bulkExecutorQueueCapacity,
                                              boolean start)

Create based on parameters

Type Parameters:: E - the entity type
Parameters:: bulkPollInterval - the poll interval; capacity - the queue capacity; queueDir - the queue directory; queueName - the queue name; bigQueueTimerInterval - the bigQueueTimerInterval; bulkOperation - the bulk operation itself; batchSize - the drain batch size; bulkExecutorSize - the bulk executor size; bulkExecutorQueueCapacity - the bulkExecutorQueueCapacity; start - start on create?
Returns:: the created utility

create

public static <E> BulkOperationUtil<E> create(int bulkPollInterval,
                                              int capacity,
                                              String queueDir,
                                              String queueName,
                                              long bigQueueTimerInterval,
                                              BulkOperationUtil.BulkOperation<E> bulkOperation,
                                              int batchSize,
                                              int bulkExecutorSize,
                                              int bulkExecutorQueueCapacity)

Create based on parameters

Type Parameters:: E - the entity type
Parameters:: bulkPollInterval - the poll interval; capacity - the queue capacity; queueDir - the queue directory; queueName - the queue name; bigQueueTimerInterval - the bigQueueTimerInterval; bulkOperation - the bulk operation itself; batchSize - the drain batch size; bulkExecutorSize - the bulk executor size; bulkExecutorQueueCapacity - the bulkExecutorQueueCapacity
Returns:: the created utility

create

public static <E> BulkOperationUtil<E> create(int bulkPollInterval,
                                              int capacity,
                                              BulkOperationUtil.BulkOperation<E> bulkOperation,
                                              int batchSize,
                                              int bulkExecutorSize,
                                              int bulkExecutorQueueCapacity)

Create based on parameters

Type Parameters:: E - the entity type
Parameters:: bulkPollInterval - the poll interval; capacity - the queue capacity; bulkOperation - the bulk operation itself; batchSize - the drain batch size; bulkExecutorSize - the bulk executor size; bulkExecutorQueueCapacity - the bulkExecutorQueueCapacity
Returns:: the created utility

create

public static <E> BulkOperationUtil<E> create(int bulkPollInterval,
                                              int capacity,
                                              BulkOperationUtil.BulkOperation<E> bulkOperation)

Create based on parameters

Type Parameters:: E - the entity type
Parameters:: bulkPollInterval - the poll interval; capacity - the queue capacity; bulkOperation - the bulk operation itself
Returns:: the created utility

doBulk
```
public void doBulk()
```
Do the bulk operation.

getQueueSize
```
public long getQueueSize()
```
Get the queue size

Returns:

the queue size

add
```
public void add(E e)
```
Add the given element to queue

Parameters:

e - the element to add

start
```
public void start()
```
start

stop
```
public void stop()
```
Stop the utility and operate on any remaining elements in queue.

getQueue
```
public BlockingQueue<E> getQueue()
```
Returns:

the queue

getBigQueue
```
public BigQueue<E> getBigQueue()
```
Returns:

the bigQueue

isFileBased
```
public boolean isFileBased()
```
Returns:

the fileBased

setFileBased
```
public void setFileBased(boolean fileBased)
```
Parameters:

fileBased - the fileBased to set

isPeekEnabled
```
public boolean isPeekEnabled()
```
Returns:

the peekEnabled

setPeekEnabled
```
public void setPeekEnabled(boolean peekEnabled)
```
Parameters:

peekEnabled - the peekEnabled to set

isWaitEnabled
```
public boolean isWaitEnabled()
```
Returns:

the waitEnabled

setWaitEnabled
```
public void setWaitEnabled(boolean waitEnabled)
```
Parameters:

waitEnabled - the waitEnabled to set

getQueueDir
```
public String getQueueDir()
```
Returns:

the queueDir

getQueueName
```
public String getQueueName()
```
Returns:

the queueName

getBigQueueTimerInterval
```
public long getBigQueueTimerInterval()
```
Returns:

the bigQueueTimerInterval

getBigQueueTimer
```
public Timer getBigQueueTimer()
```
Returns:

the bigQueueTimer

getBulkPollInterval
```
public long getBulkPollInterval()
```
Returns:

the bulkPollInterval

getBulkOperation

public BulkOperationUtil.BulkOperation<E> getBulkOperation()

Returns:: the bulkOperation

getDoer

public com.bluejeans.utils.BulkOperationUtil.Doer getDoer()

Returns:: the doer

getQueueAddFailCount
```
public AtomicLong getQueueAddFailCount()
```
Returns:

the queueAddFailCount

isStopped
```
public boolean isStopped()
```
Returns:

the stopped

getBatchSize
```
public int getBatchSize()
```
Returns:

the batchSize

setBatchSize
```
public void setBatchSize(int batchSize)
```
Parameters:

batchSize - the batchSize to set

getBulkExecutorSize
```
public int getBulkExecutorSize()
```
Returns:

the bulkExecutorSize

getBulkExecutorQueueCapacity
```
public int getBulkExecutorQueueCapacity()
```
Returns:

the bulkExecutorQueueCapacity

getBulkExecutor

public ThreadPoolExecutor getBulkExecutor()

Returns:: the bulkExecutor

getBulkRunnable
```
public Runnable getBulkRunnable()
```
Returns:

the bulkRunnable

isParallel
```
public boolean isParallel()
```
Returns:

the parallel

setParallel
```
public void setParallel(boolean parallel)
```
Parameters:

parallel - the parallel to set

getMinBatchSize
```
public int getMinBatchSize()
```
Returns:

the minBatchSize

setMinBatchSize
```
public void setMinBatchSize(int minBatchSize)
```
Parameters:

minBatchSize - the minBatchSize to set

isBulkRetryEnabled
```
public boolean isBulkRetryEnabled()
```
Returns:

the bulkRetryEnabled

setBulkRetryEnabled
```
public void setBulkRetryEnabled(boolean bulkRetryEnabled)
```
Parameters:

bulkRetryEnabled - the bulkRetryEnabled to set

getBulkRetryCount
```
public int getBulkRetryCount()
```
Returns:

the bulkRetryCount

setBulkRetryCount
```
public void setBulkRetryCount(int bulkRetryCount)
```
Parameters:

bulkRetryCount - the bulkRetryCount to set

getBulkStatusCounter

public EnumCounter<BulkOperationUtil.BulkStatus> getBulkStatusCounter()

Returns:: the bulkStatusCounter

getEntityType
```
public Class<?> getEntityType()
```
Returns:

the entityType

setEntityType
```
public void setEntityType(Class<E> entityType)
```
Parameters:

entityType - the entityType to set

entityTypeIs

public void entityTypeIs(Class<E> entityType)

getDummyElement
```
public E getDummyElement()
```
Returns:

the dummyElement

setDummyElement
```
public void setDummyElement(E dummyElement)
```
Parameters:

dummyElement - the dummyElement to set

dummyElementIs
```
public void dummyElementIs(E el)
```

Class BulkOperationUtil<E>

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

create

create

create

doBulk

getQueueSize

add

start

stop

getQueue

getBigQueue

isFileBased

setFileBased

isPeekEnabled

setPeekEnabled

isWaitEnabled

setWaitEnabled

getQueueDir

getQueueName

getBigQueueTimerInterval

getBigQueueTimer

getBulkPollInterval

getBulkOperation

getDoer

getQueueAddFailCount

isStopped

getBatchSize

setBatchSize

getBulkExecutorSize

getBulkExecutorQueueCapacity

getBulkExecutor

getBulkRunnable

isParallel

setParallel

getMinBatchSize

setMinBatchSize

isBulkRetryEnabled

setBulkRetryEnabled

getBulkRetryCount

setBulkRetryCount

getBulkStatusCounter

getEntityType

setEntityType

entityTypeIs

getDummyElement

setDummyElement

dummyElementIs