oracle.ifs.fdk.impl

Class OptionUtils

java.lang.Object

oracle.ifs.fdk.impl.OptionUtils

public final class OptionUtils
extends Object

This class contains a set of static utilities for processing options.

Method Summary

Modifier and Type	Method and Description
static boolean	getBoolean(Map map, String name, boolean defaultValue) Get a boolean value from a options map.
static int	getInteger(Map map, String name, int defaultValue) Get an integer value from a options map.
static long	getLong(Map map, String name, long defaultValue) Get a long value from a options map.
static String	getString(Map map, String name, String defaultValue) Get a String value from a options map.

Methods inherited from class java.lang.Object

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

Method Detail

getString

public static String getString(Map map,
                               String name,
                               String defaultValue)
                        throws FdkException

Get a String value from a options map.

Parameters:

map - Map of names to values

name - Name

defaultValue - Default value

Returns:

value

Throws:

FdkException - (FDK_INVALID_OPTION_VALUE) if the value is not to a String

getInteger

public static int getInteger(Map map,
                             String name,
                             int defaultValue)
                      throws FdkException

Get an integer value from a options map.

Parameters:

map - Map of names to values

name - Name

defaultValue - Default value

Returns:

value

Throws:

FdkException - (FDK_INVALID_OPTION_VALUE) if the value can not be converted to an integer

getLong

public static long getLong(Map map,
                           String name,
                           long defaultValue)
                    throws FdkException

Get a long value from a options map.

Parameters:

map - Map of names to values

name - Name

defaultValue - Default value

Returns:

value

Throws:

FdkException - (FDK_INVALID_OPTION_VALUE) if the value can not be converted to a long

getBoolean

public static boolean getBoolean(Map map,
                                 String name,
                                 boolean defaultValue)
                          throws FdkException

Get a boolean value from a options map.

Parameters:

map - Map of names to values

name - Name

defaultValue - Default value

Returns:

value

Throws:

FdkException - (FDK_INVALID_OPTION_VALUE) if the value can not be converted to a boolean