jsimple.util

Class PlatformUtilsBase

java.lang.Object

jsimple.util.PlatformUtilsBase

Direct Known Subclasses:

PlatformUtils

public class PlatformUtilsBase
extends java.lang.Object

This class is used to wrap one off utility methods that need to be implemented in a platform dependent way. Methods here are static & not actually defined in the base class--just a template comment is given here, and the method should actually be implemented in the platform dependent PlatformUtils subclass. Callers should call, for example, with the syntax PlatformUtils.stringGetChars().

By using the above scheme, calls are static & most efficient, there's no need for extra infrastructure around a factory class, and perhaps most importantly if the platform doesn't implement a method which is actually needed by some code it uses, that problem is caught at compile time not run time.

Since:

10/21/12 3:26 PM

Field Summary

Fields

Modifier and Type	Field and Description
static long	currentTimeOverride

Constructor Summary

Constructors

Constructor and Description
PlatformUtilsBase()

Method Summary

Modifier and Type	Method and Description
static long	getCurrentTimeMillis() Get the number of milliseconds since Jan 1, 1970, UTC time.
static void	setCurrentTimeOverride(long currentTimeOverrideInMillis) Set an override for the current time, that will then be returned from getCurrentTimeMillis instead of the actual time being returned.

Methods inherited from class java.lang.Object

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

Field Detail

currentTimeOverride

public static long currentTimeOverride

Constructor Detail

PlatformUtilsBase

public PlatformUtilsBase()

Method Detail

getCurrentTimeMillis

public static long getCurrentTimeMillis()

Get the number of milliseconds since Jan 1, 1970, UTC time. That's also known as epoch time. It's the time unit we generally use in JSimple.

Returns:

number of milliseconds since 1/1/70 UTC/GMT

setCurrentTimeOverride

public static void setCurrentTimeOverride(long currentTimeOverrideInMillis)

Set an override for the current time, that will then be returned from getCurrentTimeMillis instead of the actual time being returned. This method can be used in test jigs, to simulate the time, so tests are deterministic with respect to time or perhaps to make a certain amount of time pass for code that checks getCurrentTimeMillis. If the specified time is DateTime.NULL_DATE, then any override is cleared and the real time will be returned again from getCurrentTimeMillis.

Parameters:

currentTimeOverrideInMillis - override for current time, in millis, or DateTime.NULL_DATE to clear override