com.pubmatic.sdk.common.utility

Class POBUtils

java.lang.Object

com.pubmatic.sdk.common.utility.POBUtils

public class POBUtils
extends java.lang.Object

This is common utility class

Constructor Summary

Constructors

Constructor and Description
POBUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	buildUrlWithQueryParam(java.lang.String serverUrl, java.lang.String key, java.lang.String value) Util method to add query param to a url
static int	convertDpToPixel(int value) Method is used to covert DP into pixel
static int	convertPixelToDp(int value) Method is used to convert Pixel into DP
static long	convertToMilliSeconds(java.lang.String time) Utility method to convert time string to milli seconds
static double	convertToSeconds(java.lang.String duration, java.lang.String skipOffset) Calculates time in seconds whether skip offset is in time format or percentage
static boolean	getBooleanValue(java.lang.String data)
static java.lang.Object	getBuildConfigValue(android.content.Context context, java.lang.String fieldName) Gets a field from the project's BuildConfig.
static int	getDeviceOrientation(android.content.Context appContext) Returns the device current orientation
static long	getEpochTimeInSec() Returns the epoch time
static int	getIntegerValue(java.lang.String data)
static POBAdSize	getInterstitialAdSize(android.content.Context context)
static POBLocation	getLocation(POBLocationDetector locationDetector) Method identifies isLocationDetectionEnabled if enabled then fetch last known location of the device if disabled then get location provided by the publisher
static POBAdSize	getOWAdSize(java.lang.String size) Method for returning the POBAdSize based on provided ad size string.
static int	getRandomNumber(int lowerBound, int upperBound) Returns the random number between lowerBound and upperBound
static int	getScreenHeight() Method to get screen height in DP
static int	getScreenWidth() Method to get screen width in DP
static double	getSeconds(java.lang.String time) Utility method to convert time string to seconds
static int	getTimeOffsetInMinutes() Returns local time as the number +/- of minutes from UTC.
static int	getValidRefreshInterval(int refreshInterval, int minRefreshInterval) Validates and returns time interval in seconds to refresh the banner ad.
static int	getViewVisiblePixel(android.view.View view) To get visible pixel of view.
static int[]	getViewXYPosition(android.view.View view) Method is used get x, y position of View
static float	getVisiblePercent(android.view.View view) To get visibility percent of view, if view is null it will always returns 0 as visibility percent
static boolean	hasPermission(android.content.Context appContext, java.lang.String permission) Method is used to check app has user permission
static boolean	isNull(java.lang.Object[] obj) Method to check Object array is Null/Empty or one of the object inside the object array is null
static boolean	isNullOrEmpty(java.lang.String str) Method to check String isNull or isEmpty
static boolean	isTablet(android.content.Context context) Method to check whether the device is Phone or Tablet.
static boolean	isViewVisible(android.view.View view, int visibilityCriteriaInPixel) To get visibility of view.
static void	logBidWinningStatus(boolean hasWon, java.lang.String partnerName) Log the statement based on the winning status
static java.lang.String	md5(java.lang.String string) Method is used generate MD5 String
static boolean	openExternalBrowser(android.content.Context context, java.lang.String url) Opens url in external app of browser
static java.lang.String	readFile(java.lang.String path) Utility method to read file content from given path
static java.lang.String	readFromAssets(android.content.Context context, java.lang.String file) Utility method to read file from assets
static android.content.Context	resolveWebViewContext(android.content.Context context) Used to get resolved context for WebWiew.
static void	runOnBackgroundThread(java.lang.Runnable action) Runs the specified action on the non main thread.
static void	runOnMainThread(java.lang.Runnable action) Runs the specified action on the Main/UI thread.
static java.lang.String	sha1(java.lang.String string) Method is used to generate SHA1 string
static void	writeFile(java.lang.String content, java.lang.String fileName) Utility method to write string content to file

Methods inherited from class java.lang.Object

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

Constructor Detail

POBUtils

public POBUtils()

Method Detail

sha1

public static java.lang.String sha1(java.lang.String string)

Method is used to generate SHA1 string

Parameters:

string - on which SHA1 to be perform

Returns:

SHA string

md5

public static java.lang.String md5(java.lang.String string)

Method is used generate MD5 String

Parameters:

string - on which MD5 algorithm to be perform

Returns:

MD5 string

getBuildConfigValue

@Nullable
public static java.lang.Object getBuildConfigValue(android.content.Context context,
                                                             java.lang.String fieldName)

Gets a field from the project's BuildConfig. This is useful when, for example, flavors are used at the project level to set custom fields.

Parameters:

context - Used to find the correct file

fieldName - The name of the field-to-access

Returns:

The value of the field, or null if the field is not found.

hasPermission

public static boolean hasPermission(@NonNull
                                    android.content.Context appContext,
                                    @NonNull
                                    java.lang.String permission)

Method is used to check app has user permission

Parameters:

appContext - android app context

permission - string of app permission

Returns:

true if user provides the permission else return false

getRandomNumber

public static int getRandomNumber(int lowerBound,
                                  int upperBound)

Returns the random number between lowerBound and upperBound

Parameters:

lowerBound - Minimum value for random number

upperBound - Maximum value for random number

Returns:

random number between lowerBound and upperBound

openExternalBrowser

public static boolean openExternalBrowser(android.content.Context context,
                                          java.lang.String url)

Opens url in external app of browser

Parameters:

context - android app context

url - which is going to be opened in external browser/application

Returns:

returns true if intent opens url else return false

isNullOrEmpty

public static boolean isNullOrEmpty(@Nullable
                                    java.lang.String str)

Method to check String isNull or isEmpty

Parameters:

str - which is going to checked

Returns:

true if passed string is Null or Empty else return false

isNull

public static boolean isNull(@Nullable
                             java.lang.Object[] obj)

Method to check Object array is Null/Empty or one of the object inside the object array is null

Parameters:

obj - accepts array of object

Returns:

true if Object array is Null/Empty or one of the object inside the object array is null else false

getLocation

@Nullable
public static POBLocation getLocation(@Nullable
                                                POBLocationDetector locationDetector)

Method identifies isLocationDetectionEnabled if enabled then fetch last known location of the device if disabled then get location provided by the publisher

Parameters:

locationDetector - instance of POBLocationDetector

Returns:

value of POBLocation

getScreenWidth

public static int getScreenWidth()

Method to get screen width in DP

Returns:

int value of screen width

convertPixelToDp

public static int convertPixelToDp(int value)

Method is used to convert Pixel into DP

Parameters:

value - in Pixel

Returns:

int value in DP

getScreenHeight

public static int getScreenHeight()

Method to get screen height in DP

Returns:

int value of screen height

getViewXYPosition

public static int[] getViewXYPosition(android.view.View view)

Method is used get x, y position of View

Parameters:

view - on which operation to be performed

Returns:

array of int include 0=x, 1=y position which is in DP

convertDpToPixel

public static int convertDpToPixel(int value)

Method is used to covert DP into pixel

Parameters:

value - of DP

Returns:

int pixel value for respective DP

getInterstitialAdSize

public static POBAdSize getInterstitialAdSize(@NonNull
                                              android.content.Context context)

getDeviceOrientation

public static int getDeviceOrientation(@NonNull
                                       android.content.Context appContext)

Returns the device current orientation

Parameters:

appContext - application context

Returns:

device current orientation

isTablet

public static boolean isTablet(android.content.Context context)

Method to check whether the device is Phone or Tablet.

Parameters:

context - provide screenLayout and screenLayout size mask

Returns:

boolean value [true, if device is Tablet else is false]

readFromAssets

@Nullable
 @WorkerThread
public static java.lang.String readFromAssets(@NonNull
                                                                       android.content.Context context,
                                                                       @NonNull
                                                                       java.lang.String file)

Utility method to read file from assets

Parameters:

context - instance of Context

file - name of file

Returns:

String content of file

writeFile

public static void writeFile(java.lang.String content,
                             java.lang.String fileName)

Utility method to write string content to file

Parameters:

content - content to write

fileName - name of file

readFile

@Nullable
public static java.lang.String readFile(java.lang.String path)

Utility method to read file content from given path

Parameters:

path - absolute path of file

getTimeOffsetInMinutes

public static int getTimeOffsetInMinutes()

Returns local time as the number +/- of minutes from UTC.

Returns:

Local time in minutes

convertToMilliSeconds

public static long convertToMilliSeconds(@NonNull
                                         java.lang.String time)

Utility method to convert time string to milli seconds

Parameters:

time - time can be in format HH:MM:SS.mmm, HH:MM:SS, MM:SS, SS etc

Returns:

converted milli seconds

convertToSeconds

public static double convertToSeconds(@Nullable
                                      java.lang.String duration,
                                      @Nullable
                                      java.lang.String skipOffset)

Calculates time in seconds whether skip offset is in time format or percentage

Parameters:

duration - should be in format HH:MM:SS.mmm, HH:MM:SS, MM:SS, SS etc

skipOffset - should be in format HH:MM:SS.mmm or HH:MM:SS or in percentage

Returns:

offset time

getSeconds

public static double getSeconds(@Nullable
                                java.lang.String time)

Utility method to convert time string to seconds

Parameters:

time - time can be in format HH:MM:SS.mmm, HH:MM:SS, MM:SS, SS etc

Returns:

seconds

getIntegerValue

public static int getIntegerValue(@Nullable
                                  java.lang.String data)

getBooleanValue

public static boolean getBooleanValue(@Nullable
                                      java.lang.String data)

getVisiblePercent

public static float getVisiblePercent(@Nullable
                                      android.view.View view)

To get visibility percent of view, if view is null it will always returns 0 as visibility percent

Parameters:

view - on which visibility percent is calculated

Returns:

visibility percent of view in float

isViewVisible

public static boolean isViewVisible(@Nullable
                                    android.view.View view,
                                    int visibilityCriteriaInPixel)

To get visibility of view. Returns true if visibility criteria in pixel is met.

Parameters:

view - on which visibility should be checked

visibilityCriteriaInPixel - number of pixel needed to meet visibility criteria

Returns:

true if visibility criteria in pixel is met.

getViewVisiblePixel

public static int getViewVisiblePixel(@Nullable
                                      android.view.View view)

To get visible pixel of view. Returns count of visible pixel.

Parameters:

view - on which visibility should be checked

Returns:

0 if view is not visible.

runOnMainThread

public static void runOnMainThread(java.lang.Runnable action)

Runs the specified action on the Main/UI thread. If the current thread is the Main/UI thread, then the action is executed immediately. If the current thread is not the Main/UI thread, the action is posted to the event queue of the Main/UI thread.

Parameters:

action - the action to run on the Main/UI thread

runOnBackgroundThread

public static void runOnBackgroundThread(java.lang.Runnable action)

Runs the specified action on the non main thread.

Parameters:

action - the action to run on the Main/UI thread

getValidRefreshInterval

public static int getValidRefreshInterval(int refreshInterval,
                                          int minRefreshInterval)

Validates and returns time interval in seconds to refresh the banner ad. By default Banner Ad view does not auto-refresh, to enable auto refresh set refreshInterval to a non zero value. Expected value should be greater than minRefreshInterval seconds. Ad refresh behaviour when refreshInterval=X: - X<=0 :: Ad will not refresh - X > 0 and X <= minRefreshInterval :: Ad will refresh after every minRefreshInterval seconds - X > minRefreshInterval :: Ad will refresh after every X seconds

Parameters:

refreshInterval - time interval in seconds

resolveWebViewContext

@NonNull
public static android.content.Context resolveWebViewContext(@NonNull
                                                                     android.content.Context context)

Used to get resolved context for WebWiew. Checks for api levels to avoid app crashes through appcompat library version 1.1.0 Crash only happens on Lolipop devices and android 6, 8,9 where devices does not have play services for more details refer https://issuetracker.google.com/issues/141132133

Note: Must be used with WebView FIXME: Remove this method onces new appcompat library available with above mentioned fix.

Parameters:

context - the instance of context

Returns:

resolved/fixed context

getOWAdSize

@NonNull
public static POBAdSize getOWAdSize(@NonNull
                                             java.lang.String size)

Method for returning the POBAdSize based on provided ad size string.

Parameters:

size - Size in the format of widthxheight For example: 320x50

logBidWinningStatus

public static void logBidWinningStatus(boolean hasWon,
                                       @Nullable
                                       java.lang.String partnerName)

Log the statement based on the winning status

Parameters:

hasWon - Winning status

partnerName - Name of the winning partner

getEpochTimeInSec

public static long getEpochTimeInSec()

Returns the epoch time

Returns:

epoc time in seconds

buildUrlWithQueryParam

@NonNull
public static java.lang.String buildUrlWithQueryParam(@NonNull
                                                               java.lang.String serverUrl,
                                                               @NonNull
                                                               java.lang.String key,
                                                               @NonNull
                                                               java.lang.String value)

Util method to add query param to a url

Parameters:

serverUrl - url in which the param needs to be added

key - key of query param

value - value of query param

Returns:

returns url with added query param