com.salesforce.androidsdk.analytics.logger

Class FileLogger

java.lang.Object

com.salesforce.androidsdk.analytics.logger.FileLogger

public class FileLogger
extends java.lang.Object

A simple file logger that works with SalesforceLogger to write log entries to a file.

Author:

bhariharan

Constructor Summary

Constructors

Constructor and Description
FileLogger(Context context, java.lang.String componentName) Parameterized constructor.

Method Summary

Modifier and Type	Method and Description
void	addLogLine(java.lang.String logLine) Writes a log line to the file.
void	addLogLines(java.util.List<java.lang.String> logLines) Writes a list of log lines to the file.
void	addLogLines(java.lang.String[] logLines) Writes an array of log lines to the file.
void	flushLog() Flushes the log file and resets it to its original state.
int	getMaxSize() Returns the maximum number of log lines that can be stored in this file.
int	getSize() Returns the number of log lines stored in this file.
java.lang.String[]	readAndRemoveFileAsArray() Returns all log lines stored in FIFO and removes them as they are being read.
java.util.List<java.lang.String>	readAndRemoveFileAsList() Returns all log lines stored in FIFO and removes them as they are being read.
java.lang.String[]	readAndRemoveLogLinesAsArray(int numLines) Returns an array of log lines in FIFO and removes them as they are being read.
java.util.List<java.lang.String>	readAndRemoveLogLinesAsList(int numLines) Returns a list of log lines in FIFO and removes them as they are being read.
java.lang.String	readLogLine() Returns a single log line in FIFO.
void	removeLogLine() Removes the first log line in the file.
void	removeLogLines(int numLines) Removes the specified number of log lines from the file in FIFO.
static void	resetFileLoggerPrefs(Context context) Resets the stored file logger prefs.
void	setMaxSize(int size) Sets the maximum number of log lines that can be stored in this file.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileLogger

public FileLogger(Context context,
                  java.lang.String componentName)
           throws java.io.IOException

Parameterized constructor.

Parameters:

context - Context.

componentName - Component name.

Throws:

java.io.IOException - If file initialization was unsuccessful.

Method Detail

flushLog

public void flushLog()

Flushes the log file and resets it to its original state.

getSize

public int getSize()

Returns the number of log lines stored in this file.

Returns:

Number of stored log lines.

getMaxSize

public int getMaxSize()

Returns the maximum number of log lines that can be stored in this file.

Returns:

Maximum number of log lines.

setMaxSize

public void setMaxSize(int size)

Sets the maximum number of log lines that can be stored in this file.

Parameters:

size - Maximum number of log lines.

addLogLine

public void addLogLine(java.lang.String logLine)

Writes a log line to the file.

Parameters:

logLine - Log line.

addLogLines

public void addLogLines(java.util.List<java.lang.String> logLines)

Writes a list of log lines to the file.

Parameters:

logLines - Log lines.

addLogLines

public void addLogLines(java.lang.String[] logLines)

Writes an array of log lines to the file.

Parameters:

logLines - Log lines.

readLogLine

public java.lang.String readLogLine()

Returns a single log line in FIFO.

Returns:

Log line.

readAndRemoveLogLinesAsList

public java.util.List<java.lang.String> readAndRemoveLogLinesAsList(int numLines)

Returns a list of log lines in FIFO and removes them as they are being read.

Parameters:

numLines - Number of lines to be read.

Returns:

List of log lines.

readAndRemoveLogLinesAsArray

public java.lang.String[] readAndRemoveLogLinesAsArray(int numLines)

Returns an array of log lines in FIFO and removes them as they are being read.

Parameters:

numLines - Number of lines to be read.

Returns:

Array of log lines.

readAndRemoveFileAsList

public java.util.List<java.lang.String> readAndRemoveFileAsList()

Returns all log lines stored in FIFO and removes them as they are being read.

Returns:

List of all log lines stored in this file.

readAndRemoveFileAsArray

public java.lang.String[] readAndRemoveFileAsArray()

Returns all log lines stored in FIFO and removes them as they are being read.

Returns:

Array of all log lines stored in this file.

removeLogLine

public void removeLogLine()

Removes the first log line in the file.

removeLogLines

public void removeLogLines(int numLines)

Removes the specified number of log lines from the file in FIFO.

Parameters:

numLines - Number of log lines.

resetFileLoggerPrefs

public static void resetFileLoggerPrefs(Context context)

Resets the stored file logger prefs. Should be used ONLY by tests.

Parameters:

context - Context.