EventsStorage (twitter-core 3.0.0 API)

All Known Implementing Classes:

QueueFileEventStorage
```
public interface EventsStorage
```
Stores events in a single file in the working directory and on-demand rolls that file over to the specified target in the roll-over directory. Once rolled over, a new working file is created.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`add(byte[] data)` Add an event represented as a byte array to the working file
`boolean`	`canWorkingFileStore(int newEventSizeInBytes, int maxByteSizePerFile)`
`void`	`deleteFilesInRollOverDirectory(List<File> files)` Clear out given set of files in roll-over directory
`void`	`deleteWorkingFile()` Clear out active working file
`List<File>`	`getAllFilesInRollOverDirectory()`
`List<File>`	`getBatchOfFilesToSend(int maxBatchSize)`
`File`	`getRollOverDirectory()`
`File`	`getWorkingDirectory()`
`int`	`getWorkingFileUsedSizeInBytes()`
`boolean`	`isWorkingFileEmpty()`
`void`	`rollOver(String targetName)` roll the current working file over to a file in the roll-over directory with the given name.

- Method Detail
  - add
```
void add(byte[] data)
  throws IOException
```
    Add an event represented as a byte array to the working file
    
    Throws:
    
    IOException
  - getWorkingFileUsedSizeInBytes
```
int getWorkingFileUsedSizeInBytes()
```
    Returns:
    
    size in bytes of the current working file
  - isWorkingFileEmpty
```
boolean isWorkingFileEmpty()
```
    Returns:
    
    true if the working file has not had any events written to it
  - rollOver
```
void rollOver(String targetName)
       throws IOException
```
    roll the current working file over to a file in the roll-over directory with the given name. A new working file is created
    
    Throws:
    
    IOException
  - getWorkingDirectory
```
File getWorkingDirectory()
```
    Returns:
    
    working directory
  - getRollOverDirectory
```
File getRollOverDirectory()
```
    Returns:
    
    roll-over directory
  - getBatchOfFilesToSend
```
List<File> getBatchOfFilesToSend(int maxBatchSize)
```
    Parameters:
    
    maxBatchSize - maximum number of files to include in batch
    
    Returns:
    
    a list of files that are ready for being sent to the server
  - getAllFilesInRollOverDirectory
```
List<File> getAllFilesInRollOverDirectory()
```
    Returns:
    
    all of the files currently in the roll over directory
  - deleteFilesInRollOverDirectory
```
void deleteFilesInRollOverDirectory(List<File> files)
```
    Clear out given set of files in roll-over directory
  - deleteWorkingFile
```
void deleteWorkingFile()
```
    Clear out active working file
  - canWorkingFileStore
```
boolean canWorkingFileStore(int newEventSizeInBytes,
                            int maxByteSizePerFile)
```
    Parameters:
    
    newEventSizeInBytes - the size in bytes of the event we would like to write to the working file
    
    maxByteSizePerFile - The size in bytes which we will enforce as the maximum for the working file
    
    Returns:
    
    true if the new event size will fit in the working file, false if not

Interface EventsStorage

Method Summary

Method Detail

add

getWorkingFileUsedSizeInBytes

isWorkingFileEmpty

rollOver

getWorkingDirectory

getRollOverDirectory

getBatchOfFilesToSend

getAllFilesInRollOverDirectory

deleteFilesInRollOverDirectory

deleteWorkingFile

canWorkingFileStore