com.facebook.internal.instrument

Class InstrumentUtility

java.lang.Object

com.facebook.internal.instrument.InstrumentUtility

public final class InstrumentUtility
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANALYSIS_REPORT_PREFIX
static java.lang.String	CRASH_REPORT_PREFIX
static java.lang.String	CRASH_SHIELD_PREFIX
static java.lang.String	ERROR_REPORT_PREFIX
static java.lang.String	THREAD_CHECK_PREFIX

Constructor Summary

Constructors

Constructor and Description
InstrumentUtility()

Method Summary

Modifier and Type	Method and Description
static boolean	deleteFile(java.lang.String filename) Deletes the cache file under instrument report directory.
static java.lang.String	getCause(java.lang.Throwable e) Get the cause of the raised exception.
static java.io.File	getInstrumentReportDir() Get the instrument directory for report if the directory exists.
static java.lang.String	getStackTrace(java.lang.Throwable e) Get the iterated call stack traces of the raised exception.
static boolean	isSDKRelatedException(java.lang.Throwable e) Check whether a Throwable is related to Facebook SDK by looking at iterated stack traces and return true if one of the traces has prefix "com.facebook".
static java.io.File[]	listExceptionAnalysisReportFiles() Get the list of exception analysis report files from instrument report directory defined in getInstrumentReportDir() method.
static java.io.File[]	listExceptionReportFiles() Get the list of exception report files from instrument report directory defined in getInstrumentReportDir() method.
static org.json.JSONObject	readFile(java.lang.String filename, boolean deleteOnException) Read the content from the file which is denoted by filename and the directory is the instrument report directory defined in getInstrumentReportDir() method.
static void	sendReports(java.lang.String key, org.json.JSONArray reports, GraphRequest.Callback callback) Create Graph Request for Instrument reports and send the reports to Facebook.
static void	writeFile(java.lang.String filename, java.lang.String content) Write the content to the file which is denoted by filename and the file will be put in instrument report directory defined in getInstrumentReportDir() method.

Methods inherited from class java.lang.Object

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

Field Detail

ANALYSIS_REPORT_PREFIX

public static final java.lang.String ANALYSIS_REPORT_PREFIX

See Also:

Constant Field Values

CRASH_REPORT_PREFIX

public static final java.lang.String CRASH_REPORT_PREFIX

See Also:

Constant Field Values

CRASH_SHIELD_PREFIX

public static final java.lang.String CRASH_SHIELD_PREFIX

See Also:

Constant Field Values

THREAD_CHECK_PREFIX

public static final java.lang.String THREAD_CHECK_PREFIX

See Also:

Constant Field Values

ERROR_REPORT_PREFIX

public static final java.lang.String ERROR_REPORT_PREFIX

See Also:

Constant Field Values

Constructor Detail

InstrumentUtility

public InstrumentUtility()

Method Detail

getCause

@Nullable
public static java.lang.String getCause(java.lang.Throwable e)

Get the cause of the raised exception.

Parameters:

e - The Throwable containing the exception that was raised

Returns:

The String containing the cause of the raised exception

getStackTrace

@Nullable
public static java.lang.String getStackTrace(java.lang.Throwable e)

Get the iterated call stack traces of the raised exception.

Parameters:

e - The Throwable containing the exception that was raised

Returns:

The String containing the stack traces of the raised exception

isSDKRelatedException

public static boolean isSDKRelatedException(@Nullable
                                            java.lang.Throwable e)

Check whether a Throwable is related to Facebook SDK by looking at iterated stack traces and return true if one of the traces has prefix "com.facebook".

Parameters:

e - The Throwable containing the exception that was raised

Returns:

Whether the raised exception is related to Facebook SDK

listExceptionAnalysisReportFiles

public static java.io.File[] listExceptionAnalysisReportFiles()

Get the list of exception analysis report files from instrument report directory defined in getInstrumentReportDir() method. Note that the function should be called after FacebookSdk is initialized. Otherwise, exception FacebookSdkNotInitializedException will be thrown.

Returns:

The list of crash report files

listExceptionReportFiles

public static java.io.File[] listExceptionReportFiles()

Get the list of exception report files from instrument report directory defined in getInstrumentReportDir() method. Note that the function should be called after FacebookSdk is initialized. Otherwise, exception FacebookSdkNotInitializedException will be thrown.

Returns:

The list of crash report files

readFile

@Nullable
public static org.json.JSONObject readFile(@Nullable
                                                     java.lang.String filename,
                                                     boolean deleteOnException)

Read the content from the file which is denoted by filename and the directory is the instrument report directory defined in getInstrumentReportDir() method. Note that the function should be called after FacebookSdk is initialized. Otherwise, exception FacebookSdkNotInitializedException will be thrown.

writeFile

public static void writeFile(@Nullable
                             java.lang.String filename,
                             @Nullable
                             java.lang.String content)

Write the content to the file which is denoted by filename and the file will be put in instrument report directory defined in getInstrumentReportDir() method. Note that the function should be called after FacebookSdk is initialized. Otherwise, exception FacebookSdkNotInitializedException will be thrown.

deleteFile

public static boolean deleteFile(@Nullable
                                 java.lang.String filename)

Deletes the cache file under instrument report directory. If the instrument report directory exists and the file exists under the directory, the file will be deleted. Note that the function should be called after FacebookSdk is initialized. Otherwise, exception FacebookSdkNotInitializedException will be thrown.

Returns:

Whether the file is successfully deleted

sendReports

public static void sendReports(java.lang.String key,
                               org.json.JSONArray reports,
                               GraphRequest.Callback callback)

Create Graph Request for Instrument reports and send the reports to Facebook.

getInstrumentReportDir

@Nullable
public static java.io.File getInstrumentReportDir()

Get the instrument directory for report if the directory exists. If the directory doesn't exist, will attempt to create the directory. Note that, the instrument directory is under cache directory of the Application. Note that the function should be called after FacebookSdk is initialized. Otherwise, exception FacebookSdkNotInitializedException will be thrown.

Returns:

The instrument cache directory if and only if the directory exists or it's successfully created, otherwise return null.