com.ibm.websphere.workarea

Class PropertyModeType

java.lang.Object

com.ibm.websphere.workarea.PropertyModeType

public class PropertyModeType
extends java.lang.Object

PropertyModeTypes permit applications to indicate that specific values set into a WorkArea should not be removeable, overridable/overwriteable, or both. For examples, if a property were set as follows:

     userWorkArea.set("key", "value", PropertyModeType.read_only);
     

then the value would be unchangeable by further set invocations; the value could be removed, however, though of course only within the context in which it was initially set. Similarly,

     userWorkArea.set("key", "value", PropertyModeType.fixed_normal);
     

would result in a property that cannot be removed; however, the property could be overwritten or overridden. Therefore,

     userWorkArea.set("key", "value", PropertyModeType.fixed_readonly)
     

results in a property that can neither be overriden nor removed; it will exist unchanging until the WorkArea is completed. Properties will be considered normal (may be overwritten, overridden, or deleted) if set with the mode explicitely :

     userWorkArea.set("key", "value", PropertyModeType.normal);
     

or if the mode is implicit:

     userWorkArea.set("key", "value");
     

Version:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	_fixed_normal
static int	_fixed_readonly
static int	_normal
static int	_read_only
static PropertyModeType	fixed_normal Indicates that properties can be overwritten or overridden, but not deleted.
static PropertyModeType	fixed_readonly Indicates that properties may not be removed, overridden, or overwritten.
static PropertyModeType	normal Indicates that properties may be overridden, overwritten, or deleted.
static PropertyModeType	read_only Indicates that properties may be deleted, but cannot be overridden or overwritten.

Method Summary

Methods

Modifier and Type	Method and Description
static PropertyModeType	from_int(int value) Will return a PropertyModeType corresponding to the given PropertyModeType.
int	value() Will return an integer representation of the given PropertyModeType.

Methods inherited from class java.lang.Object

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

Field Detail

_normal

public static final int _normal

See Also:

Constant Field Values

normal

public static final PropertyModeType normal

Indicates that properties may be overridden, overwritten, or deleted.

_read_only

public static final int _read_only

See Also:

Constant Field Values

read_only

public static final PropertyModeType read_only

Indicates that properties may be deleted, but cannot be overridden or overwritten.

_fixed_normal

public static final int _fixed_normal

See Also:

Constant Field Values

fixed_normal

public static final PropertyModeType fixed_normal

Indicates that properties can be overwritten or overridden, but not deleted.

_fixed_readonly

public static final int _fixed_readonly

See Also:

Constant Field Values

fixed_readonly

public static final PropertyModeType fixed_readonly

Indicates that properties may not be removed, overridden, or overwritten.

Method Detail

value

public int value()

Will return an integer representation of the given PropertyModeType. For example, PropertyModeType.normal.value() == PropetyModeType._normal

Returns:

The integer representation of the PropertyModeType; will correspond to one of the integer constants defined by this class.

from_int

public static PropertyModeType from_int(int value)

Will return a PropertyModeType corresponding to the given PropertyModeType. For example, PropertyModeType.from_int(PropertyModeType._normal) == PropertyModeType.normal()

Parameters:

value - Must be an integer from with the set of fixed integers defined in the PropertyModeType class.

Returns:

A non-null PropertyModeType reference.

Throws:

java.lang.IllegalArgumentException - The value must correspond to one of the constants defined in the PropertyModeType class.