com.percolate.foam

Class Utils

java.lang.Object

com.percolate.foam.Utils

class Utils
extends java.lang.Object

Foam utility methods. Some methods were taken from Apache Commons Lang (http://commons.apache.org/proper/commons-lang/) Copied over to avoid requiring additional dependencies.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Utils.FoamLogger Foam logger class used to log warning message

Field Summary

Fields

Modifier and Type	Field and Description
protected Utils.FoamLogger	foamLogger

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAndroidId(android.content.Context context) Get ANDROID_ID, which is unique to the device + user combo.
java.lang.String	getApplicationName(android.content.Context context) Get application "label" value from Manifest.
java.lang.String	getApplicationPackageName(android.content.Context context) Get package name from Manifest.
int	getVersionCode(android.content.Context context) Get versionCode value from Manifest.
java.lang.String	getVersionName(android.content.Context context) Get versionName value from Manifest.
boolean	isBlank(java.lang.CharSequence cs) Checks if a CharSequence is whitespace, empty ("") or null.
boolean	isNotBlank(java.lang.CharSequence cs) Checks if a CharSequence is not empty (""), not null and not whitespace only.
boolean	isOnWifi(android.content.Context context) Check to see if the device is currently connected to a WiFi network.
void	logIssue(java.lang.String message, java.lang.Throwable ex) Foam error logging.
void	sleep(int ms) Perform system sleep for the given number of milliseconds
java.lang.String	trimToSize(java.lang.String str, int maxStringLength) Trim a given string to maxStringLength if it is over maxStringLength.

Methods inherited from class java.lang.Object

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

Field Detail

foamLogger

protected Utils.FoamLogger foamLogger

Constructor Detail

Utils

Utils()

Method Detail

isBlank

public boolean isBlank(java.lang.CharSequence cs)

Checks if a CharSequence is whitespace, empty ("") or null.

Parameters:

cs - the CharSequence to check, may be null

Returns:

true if the CharSequence is null, empty or whitespace

isNotBlank

public boolean isNotBlank(java.lang.CharSequence cs)

Checks if a CharSequence is not empty (""), not null and not whitespace only.

Parameters:

cs - the CharSequence to check, may be null

Returns:

true if the CharSequence is not empty and not null and not whitespace

trimToSize

public java.lang.String trimToSize(java.lang.String str,
                                   int maxStringLength)

Trim a given string to maxStringLength if it is over maxStringLength.

Parameters:

str - String to trim

maxStringLength - Max length of string to return

Returns:

str, trimmed to maxStringLength.

sleep

public void sleep(int ms)

Perform system sleep for the given number of milliseconds

Parameters:

ms - Milliseconds to sleep for

logIssue

public void logIssue(java.lang.String message,
                     java.lang.Throwable ex)

Foam error logging. Log a warning message using the TAG "Foam". Include stacktrace of a Throwable, if provided.

Parameters:

message - Message to log

ex - Optional Throwable. Stacktrace will be printed if provided.

getApplicationName

public java.lang.String getApplicationName(android.content.Context context)

Get application "label" value from Manifest.

Parameters:

context - Context

Returns:

Application label from Manifest

getVersionName

public java.lang.String getVersionName(android.content.Context context)

Get versionName value from Manifest.

Parameters:

context - Context

Returns:

Application versionName from Manifest

getVersionCode

public int getVersionCode(android.content.Context context)

Get versionCode value from Manifest.

Parameters:

context - Context

Returns:

Application versionCode from Manifest

getApplicationPackageName

public java.lang.String getApplicationPackageName(android.content.Context context)

Get package name from Manifest.

Parameters:

context - Context

Returns:

Application package from Manifest

getAndroidId

public java.lang.String getAndroidId(android.content.Context context)

Get ANDROID_ID, which is unique to the device + user combo. Can sometimes be null in theory.

Parameters:

context - Context

Returns:

Unique User+Device identifier. Will never be null. Can be blank.

isOnWifi

public boolean isOnWifi(android.content.Context context)

Check to see if the device is currently connected to a WiFi network. Used along with FoamApiKeys.wifiOnly() to only send data over WiFi.

Parameters:

context - Context

Returns:

true if the device is currently connected to a WiFi network.