EventsFilesManager (twitter-core 3.0.0 API)

Object
- com.twitter.sdk.android.core.internal.scribe.EventsFilesManager<T>

```
public abstract class EventsFilesManager<T>
extends Object
```
Manages files containing events. This includes, writing events to them and periodically (size or time triggered) rolling them over to a target directory.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Context`	`context`
`protected CurrentTimeProvider`	`currentTimeProvider`
`protected EventsStorage`	`eventStorage`
`protected long`	`lastRollOverTime`
`static int`	`MAX_BYTE_SIZE_PER_FILE`
`static int`	`MAX_FILES_IN_BATCH`
`static int`	`MAX_FILES_TO_KEEP`
`static String`	`ROLL_OVER_FILE_NAME_SEPARATOR`
`protected List<EventsStorageListener>`	`rollOverListeners`
`protected EventTransform<T>`	`transform`

Constructor Summary

Constructors
Constructor and Description
`EventsFilesManager(Context context, EventTransform<T> transform, CurrentTimeProvider currentTimeProvider, EventsStorage eventStorage, int defaultMaxFilesToKeep)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`deleteAllEventsFiles()`
`void`	`deleteOldestInRollOverIfOverMax()`
`void`	`deleteSentFiles(List<File> files)`
`protected abstract String`	`generateUniqueRollOverFileName()`
`List<File>`	`getBatchOfFilesToSend()`
`long`	`getLastRollOverTime()`
`protected int`	`getMaxByteSizePerFile()`
`protected int`	`getMaxFilesToKeep()` This method can be overridden by subclasses to vary the maximum file count value used during file clean-up.
`long`	`parseCreationTimestampFromFileName(String fileName)`
`void`	`registerRollOverListener(EventsStorageListener listener)` Register a listener for session analytics file roll over events that may get triggered due to the file reaching threshold size.
`boolean`	`rollFileOver()` Trigger a file roll over.
`void`	`writeEvent(T event)`

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

- Field Detail
  - ROLL_OVER_FILE_NAME_SEPARATOR
```
public static final String ROLL_OVER_FILE_NAME_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - MAX_BYTE_SIZE_PER_FILE
```
public static final int MAX_BYTE_SIZE_PER_FILE
```
    See Also:
    
    Constant Field Values
  - MAX_FILES_IN_BATCH
```
public static final int MAX_FILES_IN_BATCH
```
    See Also:
    
    Constant Field Values
  - MAX_FILES_TO_KEEP
```
public static final int MAX_FILES_TO_KEEP
```
    See Also:
    
    Constant Field Values
  - context
```
protected final Context context
```
  - transform
```
protected final EventTransform<T> transform
```
  - currentTimeProvider
```
protected final CurrentTimeProvider currentTimeProvider
```
  - eventStorage
```
protected final EventsStorage eventStorage
```
  - lastRollOverTime
```
protected volatile long lastRollOverTime
```
  - rollOverListeners
```
protected final List<EventsStorageListener> rollOverListeners
```
- Constructor Detail
  - EventsFilesManager
```
public EventsFilesManager(Context context,
                          EventTransform<T> transform,
                          CurrentTimeProvider currentTimeProvider,
                          EventsStorage eventStorage,
                          int defaultMaxFilesToKeep)
                   throws IOException
```
    Parameters:
    
    context - Context to use for file access
    
    transform - EventTransform used to convert events to bytes for storage
    
    currentTimeProvider - CurrentTimeProvider that defines how we determine time
    
    eventStorage - EventsStorage into which we will store events
    
    defaultMaxFilesToKeep - int defining the maximum number of storage files we will buffer on device. This is useful for providing a constant maximum, or a default value that varies based on overriding getMaxFilesToKeep()
    
    Throws:
    
    IOException
- Method Detail
  - writeEvent
```
public void writeEvent(T event)
                throws IOException
```
    Throws:
    
    IOException
  - registerRollOverListener
```
public void registerRollOverListener(EventsStorageListener listener)
```
    Register a listener for session analytics file roll over events that may get triggered due to the file reaching threshold size.
  - rollFileOver
```
public boolean rollFileOver()
                     throws IOException
```
    Trigger a file roll over. Returns true if events existed and a roll-over file was created. Returns false if no events existed and a roll-over file was not created.
    
    Throws:
    
    IOException
  - generateUniqueRollOverFileName
```
protected abstract String generateUniqueRollOverFileName()
```
  - getMaxFilesToKeep
```
protected int getMaxFilesToKeep()
```
    This method can be overridden by subclasses to vary the maximum file count value used during file clean-up.
  - getMaxByteSizePerFile
```
protected int getMaxByteSizePerFile()
```
  - getLastRollOverTime
```
public long getLastRollOverTime()
```
  - getBatchOfFilesToSend
```
public List<File> getBatchOfFilesToSend()
```
  - deleteSentFiles
```
public void deleteSentFiles(List<File> files)
```
  - deleteAllEventsFiles
```
public void deleteAllEventsFiles()
```
  - deleteOldestInRollOverIfOverMax
```
public void deleteOldestInRollOverIfOverMax()
```
  - parseCreationTimestampFromFileName
```
public long parseCreationTimestampFromFileName(String fileName)
```

Class EventsFilesManager<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

ROLL_OVER_FILE_NAME_SEPARATOR

MAX_BYTE_SIZE_PER_FILE

MAX_FILES_IN_BATCH

MAX_FILES_TO_KEEP

context

transform

currentTimeProvider

eventStorage

lastRollOverTime

rollOverListeners

Constructor Detail

EventsFilesManager

Method Detail

writeEvent

registerRollOverListener

rollFileOver

generateUniqueRollOverFileName

getMaxFilesToKeep

getMaxByteSizePerFile

getLastRollOverTime

getBatchOfFilesToSend

deleteSentFiles

deleteAllEventsFiles

deleteOldestInRollOverIfOverMax

parseCreationTimestampFromFileName