oracle.ifs.fdk
Class ClientUtils

java.lang.Object
oracle.ifs.fdk.ClientUtils

public class ClientUtils

extends java.lang.Object

Utilities for the client side of Web Services, but they can also be used by in-process callers.

Method Summary

static java.lang.String	fdkExceptionEntryToString(FdkExceptionEntry fdkee) Returns a String representation of a FdkExceptionEntry, suitable for detail logging.
static java.lang.String	fdkExceptionToString(FdkException fdke, boolean includeStackTrace) Returns a String representation of a FdkException, suitable for detail logging.
static java.lang.String	itemToString(Item item) Returns a String representation of an Item.
static NamedValue[]	mapToNamedValues(java.util.Map map) Converts an Map of named values to NamedValue[].
static java.util.Map	namedValuesToMap(NamedValue[] namedValues) Converts a NamedValue[] to a Map for easy access.
static java.lang.String	namedValueToString(NamedValue nv) Returns a String representation of a NamedValue.
static java.lang.String	stackTraceToString(java.lang.Throwable t) Converts an exception stack trace to a String.
static java.lang.String	toString(java.lang.Object o) Returns a String representation of any Object, with special handling for known objects such as Item, NamedValue, FdkException, FdkExceptionEntry, etc.

Methods inherited from class java.lang.Object

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

Method Detail

fdkExceptionEntryToString

public static final java.lang.String fdkExceptionEntryToString(FdkExceptionEntry fdkee)

Returns a String representation of a FdkExceptionEntry, suitable for detail logging.

Parameters:

fdkee - Entry to convert to String.

(Published)

fdkExceptionToString

public static final java.lang.String fdkExceptionToString(FdkException fdke,
                                                          boolean includeStackTrace)

Returns a String representation of a FdkException, suitable for detail logging.

Parameters:

fdke - Exception to convert to String.

includeStackTrace - Whether to include the stack trace of the exception in the returned String.

(Published)

itemToString

public static final java.lang.String itemToString(Item item)

Returns a String representation of an Item.

Parameters:

item - Item to convert to String.

(Published)

mapToNamedValues

public static final NamedValue[] mapToNamedValues(java.util.Map map)

Converts an Map of named values to NamedValue[]. If the Map instance guarantees a certain order, it will be preserved in the array.

Parameters:

map - The Map to convert. The keys in the map must be of type String. An empty map will result in a zero-length NamedValue[] and a null map will result into a null return value.

(Published)

namedValuesToMap

public static final java.util.Map namedValuesToMap(NamedValue[] namedValues)

Converts a NamedValue[] to a Map for easy access. This method guarantees that an Iterator over the Map will return the entries in the same order they were in the array. The keys in the returned map will be of type String.

Parameters:

namedValues - The NamedValue[] to convert. A zero-length array will result into an empty map and a null array will result into a null return value.

(Published)

namedValueToString

public static final java.lang.String namedValueToString(NamedValue nv)

Returns a String representation of a NamedValue.

Parameters:

nv - NamedValue to convert to String.

(Published)

stackTraceToString

public static final java.lang.String stackTraceToString(java.lang.Throwable t)

Converts an exception stack trace to a String.

Parameters:

t - The exception to convert.

(Published)

toString

public static final java.lang.String toString(java.lang.Object o)

Returns a String representation of any Object, with special handling for known objects such as Item, NamedValue, FdkException, FdkExceptionEntry, etc.

Parameters:

o - Object to convert to a String.

(Published)