oracle.ifs.fdk

Class NamedValue

java.lang.Object

oracle.ifs.fdk.NamedValue

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Preference

public class NamedValue
extends Object
implements Serializable

Represents a Java Bean name/value pair. It is suitable for representing attributes, options, preferences, etc.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NamedValue() Required constructor in order to be a Java Bean.
NamedValue(String name, Object value) Convenience constructor that sets the name and value.

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the name.
Object	getValue() Returns the value.
Object	getWrappedValue() Get the wrapped value.
static NamedValue[]	mapToNamedValues(Map map) Converts an Map of named values to NamedValue[].
static Map	namedValuesToMap(NamedValue[] namedValues) Converts a NamedValue[] to a Map for easy access.
void	setName(String name) Sets the name.
void	setValue(Object value) Sets the value.
void	setWrappedValue(Object value) Set the wrapped value.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NamedValue

public NamedValue()

Required constructor in order to be a Java Bean.

NamedValue

public NamedValue(String name,
                  Object value)

Convenience constructor that sets the name and value.

(Unpublished)

Method Detail

getName

public final String getName()

Returns the name.

setName

public final void setName(String name)

Sets the name.

getValue

public final Object getValue()

Returns the value.

setValue

public final void setValue(Object value)

Sets the value.

getWrappedValue

public Object getWrappedValue()

Get the wrapped value. This should only be called by web services to get the value to be encoded in the web services request. The wrapped is the actual value or an ArrayValue object if the value is an array.

(Unpublished)

setWrappedValue

public void setWrappedValue(Object value)

Set the wrapped value. This should only be called by web services to set the value that was encoded in the web services request. The wrapped is the actual value or an ArrayValue object if the value is an array.

(Unpublished)

toString

public String toString()

Overrides:

toString in class Object

namedValuesToMap

public static final 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.

(Unpublished)

mapToNamedValues

public static final NamedValue[] mapToNamedValues(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.

(Unpublished)