com.twitter.sdk.android.core.internal.scribe

Class QueueFileEventStorage

Object

com.twitter.sdk.android.core.internal.scribe.QueueFileEventStorage

All Implemented Interfaces:

EventsStorage

public class QueueFileEventStorage
extends Object
implements EventsStorage

An implementation of EventsStorage backed by a QueueFile. Note that this class is not thread safe and relies on upstream collaborators to ensure thread safe access.

Constructor Summary

Constructors

Constructor and Description
QueueFileEventStorage(Context context, File workingDirectory, String workingFileName, String targetDirectoryName)

Method Summary

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)
OutputStream	getMoveOutputStream(File targetFile) Returns the output stream to be used for moving file contents to the specified targetFile.
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.

Methods inherited from class Object

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

Constructor Detail

QueueFileEventStorage

public QueueFileEventStorage(Context context,
                             File workingDirectory,
                             String workingFileName,
                             String targetDirectoryName)
                      throws IOException

Throws:

IOException

Method Detail

add

public void add(byte[] data)
         throws IOException

Description copied from interface: EventsStorage

Add an event represented as a byte array to the working file

Specified by:

add in interface EventsStorage

Throws:

IOException

getWorkingFileUsedSizeInBytes

public int getWorkingFileUsedSizeInBytes()

Specified by:

getWorkingFileUsedSizeInBytes in interface EventsStorage

Returns:

size in bytes of the current working file

rollOver

public void rollOver(String targetName)
              throws IOException

Description copied from interface: EventsStorage

roll the current working file over to a file in the roll-over directory with the given name. A new working file is created

Specified by:

rollOver in interface EventsStorage

Throws:

IOException

getMoveOutputStream

public OutputStream getMoveOutputStream(File targetFile)
                                 throws IOException

Returns the output stream to be used for moving file contents to the specified targetFile. Override this method if you need a different output stream, such as one that supports compression.

Throws:

IOException

getWorkingDirectory

public File getWorkingDirectory()

Specified by:

getWorkingDirectory in interface EventsStorage

Returns:

working directory

getRollOverDirectory

public File getRollOverDirectory()

Specified by:

getRollOverDirectory in interface EventsStorage

Returns:

roll-over directory

getBatchOfFilesToSend

public List<File> getBatchOfFilesToSend(int maxBatchSize)

Specified by:

getBatchOfFilesToSend in interface EventsStorage

Parameters:

maxBatchSize - maximum number of files to include in batch

Returns:

a list of files that are ready for being sent to the server

deleteFilesInRollOverDirectory

public void deleteFilesInRollOverDirectory(List<File> files)

Description copied from interface: EventsStorage

Clear out given set of files in roll-over directory

Specified by:

deleteFilesInRollOverDirectory in interface EventsStorage

getAllFilesInRollOverDirectory

public List<File> getAllFilesInRollOverDirectory()

Specified by:

getAllFilesInRollOverDirectory in interface EventsStorage

Returns:

all of the files currently in the roll over directory

deleteWorkingFile

public void deleteWorkingFile()

Description copied from interface: EventsStorage

Clear out active working file

Specified by:

deleteWorkingFile in interface EventsStorage

isWorkingFileEmpty

public boolean isWorkingFileEmpty()

Specified by:

isWorkingFileEmpty in interface EventsStorage

Returns:

true if the working file has not had any events written to it

canWorkingFileStore

public boolean canWorkingFileStore(int newEventSizeInBytes,
                                   int maxByteSizePerFile)

Specified by:

canWorkingFileStore in interface EventsStorage

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