com.brightech.xmp.js

Class StdIoFunctions

java.lang.Object

com.brightech.xmp.js.StdIoFunctions

public class StdIoFunctions
extends java.lang.Object

This class exports a variety of utility functions, including: "args", "stdout", "stderr", "alert", "validateDate", "validateNumber", "encodeUrl", "setNamespacePrefix"

Field Summary

Fields

Modifier and Type	Field and Description
static int	kMaxCauseLoggingDepth The max depth to follow throwable causes to when logging them.
static java.lang.String	kWorkflowDebuggerLogListenerKey
static java.lang.String	kWorkflowFieldInfoSourceKey

Constructor Summary

Constructors

Constructor and Description
StdIoFunctions()

Method Summary

Modifier and Type	Method and Description
static void	alert(java.lang.Object theObject) Shows message to a user.
static java.lang.String	args(java.lang.String theName, java.lang.String theDefault) Returns system property provided to the java application, if property is not defined it returns provided default value or null.
static java.lang.String	encodeUrl(java.lang.String theUrl) Encodes the specified URL to the UTF-8 character encoding.
static void	exit(int code) This method is still being developed.
static java.lang.String	generateUUID() Creates a UUID that probably isn't that Universally Unique.
static void	log(java.lang.Object theObject, java.lang.Object theScriptName) Logs a message to the workflow log file at the info level.
static void	logAtLevel(java.lang.Object theObject, java.lang.Object theScriptName, java.lang.String theLevel) Logs a message to the workflow log file at the given level.
static void	logAtLevelWithThrowable(java.lang.Object theObject, java.lang.Object theScriptName, java.lang.String theLevel, java.lang.Object theThrowable) Logs a message and a throwable to the workflow log file at the given level.
static void	logWithThrowable(java.lang.Object theObject, java.lang.Object theScriptName, java.lang.Object theThrowable) Logs a message and a throwable to the workflow log file at the info level
static void	setNamespacePrefix(java.lang.String theUri, java.lang.String thePrefix) Sets the specified prefix to the specified URI.
static void	sleep(int theMillis) Sleep the thread using standard thread sleep
static void	stderr(java.lang.Object theObject) Prints a message to the workflow log file at the warning level.
static void	stdout(java.lang.Object theObject) Prints a message to the workflow log file at the info level.
static boolean	validateDate(java.lang.String theFormat, java.lang.String theValue) Validates that the string matches the given date format.
static boolean	validateNumber(java.lang.String theFormat, java.lang.String theValue) Validates that the string matches the given number format.

Methods inherited from class java.lang.Object

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

Field Detail

kMaxCauseLoggingDepth

public static final int kMaxCauseLoggingDepth

The max depth to follow throwable causes to when logging them.

See Also:

Constant Field Values

kWorkflowDebuggerLogListenerKey

public static final java.lang.String kWorkflowDebuggerLogListenerKey

See Also:

Constant Field Values

kWorkflowFieldInfoSourceKey

public static final java.lang.String kWorkflowFieldInfoSourceKey

See Also:

Constant Field Values

Constructor Detail

StdIoFunctions

public StdIoFunctions()

Method Detail

exit

public static void exit(int code)

This method is still being developed. It may not be functional in current builds of MediaBeacon.

Parameters:

code - the exit code.

args

public static java.lang.String args(java.lang.String theName,
                                    java.lang.String theDefault)

Returns system property provided to the java application, if property is not defined it returns provided default value or null.

Parameters:

theName - the name of the property.

theDefault - the default value if property is not defined.

Returns:

the the system property, or if it is not defined returns the specified default value, or null.

stdout

public static void stdout(java.lang.Object theObject)

Prints a message to the workflow log file at the info level.

Parameters:

theObject - message to log.

stderr

public static void stderr(java.lang.Object theObject)

Prints a message to the workflow log file at the warning level.

Parameters:

theObject - message to log.

log

public static void log(java.lang.Object theObject,
                       java.lang.Object theScriptName)

Logs a message to the workflow log file at the info level.

Parameters:

theObject - the message to log.

theScriptName - the name of the script that is logging.

logWithThrowable

public static void logWithThrowable(java.lang.Object theObject,
                                    java.lang.Object theScriptName,
                                    java.lang.Object theThrowable)

Logs a message and a throwable to the workflow log file at the info level

Parameters:

theObject - the message to log

theScriptName - the name of the script that is logging

theThrowable - the throwable

logAtLevel

public static void logAtLevel(java.lang.Object theObject,
                              java.lang.Object theScriptName,
                              java.lang.String theLevel)

Logs a message to the workflow log file at the given level.

Parameters:

theObject - the message to log.

theScriptName - the name of the script that is logging.

theLevel - the level to log at.

logAtLevelWithThrowable

public static void logAtLevelWithThrowable(java.lang.Object theObject,
                                           java.lang.Object theScriptName,
                                           java.lang.String theLevel,
                                           java.lang.Object theThrowable)

Logs a message and a throwable to the workflow log file at the given level.

Parameters:

theObject - the message to log.

theScriptName - the name of the script that is logging.

theLevel - the level to log at.

theThrowable - the throwable

alert

public static void alert(java.lang.Object theObject)

Shows message to a user. Similar to 'alert' javascript function in web browsers.

Parameters:

theObject - message to show.

validateDate

public static boolean validateDate(java.lang.String theFormat,
                                   java.lang.String theValue)

Validates that the string matches the given date format.
formatString is the string conforming SimpleTextFormat specification.

Parameters:

theFormat - the format.

theValue - the date value.

Returns:

true if string value is valid or false if not.

See Also:

SimpleDateFormat

validateNumber

public static boolean validateNumber(java.lang.String theFormat,
                                     java.lang.String theValue)

Validates that the string matches the given number format.
formatString is the string conforming DecimalFormat specification.

Parameters:

theFormat - the format.

theValue - the number value.

Returns:

true if string value is valid or false if not.

See Also:

DecimalFormat

encodeUrl

public static java.lang.String encodeUrl(java.lang.String theUrl)

Encodes the specified URL to the UTF-8 character encoding.

Parameters:

theUrl - the URL to be encoded

Returns:

the encoded URL.

setNamespacePrefix

public static void setNamespacePrefix(java.lang.String theUri,
                                      java.lang.String thePrefix)

Sets the specified prefix to the specified URI.

Parameters:

theUri - the URI.

thePrefix - the prefix.

generateUUID

public static java.lang.String generateUUID()

Creates a UUID that probably isn't that Universally Unique.

However, it is generated fast.

Returns:

generated UUID

sleep

public static void sleep(int theMillis)

Sleep the thread using standard thread sleep

Parameters:

theMillis - milliseconds to sleep for