com.sap.netweaver.bc.rf.common.property.stringtype
Class MutableStringMultiValueProperty

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.common_api.jar]

java.lang.Object
  |
  +--com.sap.netweaver.bc.rf.common.property.AbstractProperty
        |
        +--com.sap.netweaver.bc.rf.common.property.stringtype.StringMultiValueProperty
              |
              +--com.sap.netweaver.bc.rf.common.property.stringtype.MutableStringMultiValueProperty

All Implemented Interfaces:

IMutableProperty, IProperty, java.io.Serializable

public class MutableStringMultiValueProperty

extends StringMultiValueProperty

implements IMutableProperty

Class implementing a String multi value property. See IProperty and IMutableProperty for details on properties.

See Also:

AbstractProperty, IMutableProperty, IProperty, Serialized Form

Fields inherited from class com.sap.netweaver.bc.rf.common.property.stringtype.StringMultiValueProperty

values

Fields inherited from class com.sap.netweaver.bc.rf.common.property.AbstractProperty

attributes, flags, name, resourceBundles

Constructor Summary

MutableStringMultiValueProperty(IPropertyName name, java.lang.String[] values)
Construct property instance based on its internals.

MutableStringMultiValueProperty(IPropertyName name, java.lang.String[] values, int flags)
Construct property instance based on its internals.

MutableStringMultiValueProperty(IPropertyName name, java.lang.String[] values, java.util.Properties attributes)
Construct property instance based on its internals.

MutableStringMultiValueProperty(IPropertyName name, java.lang.String[] values, java.util.Properties attributes, int flags)
Construct property instance based on its internals.

MutableStringMultiValueProperty(StringMultiValueProperty property)
Construct property instance/copy based on another property template (uaually a property to be changed in parts).

Method Summary

void	addValue(java.lang.String value) Add property value.
void	clearAttributes() Remove all attributes for the property at once.
java.lang.String	getAttribute(java.lang.String attributeName) Get attribute for the property.
void	insertValue(java.lang.String value, int index) Insert property value at given index.
void	removeAttribute(java.lang.String attributeName) Remove attribute from the property.
void	removeValue(int index) Remove property value with given index.
void	removeValue(java.lang.String value) Remove all occurences of the given property value.
void	setAttribute(java.lang.String attributeName, java.lang.String attributeValue) Add attribute for the property.
void	setAttributes(java.util.Properties attributes) Set all attributes for the property at once.
void	setValue(java.lang.String value, int index) Set property value with given index.
void	setValues(java.lang.String[] values) Set array of property values.

Methods inherited from class com.sap.netweaver.bc.rf.common.property.stringtype.StringMultiValueProperty

getType, getValue, getValueAsString, getValues, getValuesAsStrings, isMultiValue

Methods inherited from class com.sap.netweaver.bc.rf.common.property.AbstractProperty

areFlagsSet, equals, getAttributes, getDescription, getDescription, getFlags, getPropertyName, hashCode, isHidden, isLive, isReadOnly, isRequired, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.sap.netweaver.bc.rf.common.property.IProperty

areFlagsSet, getAttributes, getDescription, getDescription, getFlags, getPropertyName, getType, getValueAsString, getValuesAsStrings, isHidden, isLive, isMultiValue, isReadOnly, isRequired

Constructor Detail

MutableStringMultiValueProperty

public MutableStringMultiValueProperty(StringMultiValueProperty property)
                                throws ResourceException

Construct property instance/copy based on another property template (uaually a property to be changed in parts).

Parameters:

property - property used as template

Throws:

ResourceException - when the property creation failed

MutableStringMultiValueProperty

public MutableStringMultiValueProperty(IPropertyName name,
                                       java.lang.String[] values)
                                throws ResourceException

Construct property instance based on its internals.

Parameters:

name - property name

values - property values

Throws:

ResourceException - when the property creation failed

MutableStringMultiValueProperty

public MutableStringMultiValueProperty(IPropertyName name,
                                       java.lang.String[] values,
                                       java.util.Properties attributes)
                                throws ResourceException

Construct property instance based on its internals.

Parameters:

name - property name

values - property values

attributes - property attributes

Throws:

ResourceException - when the property creation failed

MutableStringMultiValueProperty

public MutableStringMultiValueProperty(IPropertyName name,
                                       java.lang.String[] values,
                                       int flags)
                                throws ResourceException

Construct property instance based on its internals.

Parameters:

name - property name

values - property values

flags - bit array holding internal system attributes according to PropertyFlags bit mask fields

Throws:

ResourceException - when the property creation failed

MutableStringMultiValueProperty

public MutableStringMultiValueProperty(IPropertyName name,
                                       java.lang.String[] values,
                                       java.util.Properties attributes,
                                       int flags)
                                throws ResourceException

Construct property instance based on its internals.

Parameters:

name - property name

values - property values

attributes - property attributes

flags - bit array holding internal system attributes according to PropertyFlags bit mask fields

Throws:

ResourceException - when the property creation failed

Method Detail

setValues

public void setValues(java.lang.String[] values)

Set array of property values. The given values array will be stored directly (as is - without being copied). Note that this call disconnects the values array returned from a getValues() call from the property.

Parameters:

values - array of property values

setValue

public void setValue(java.lang.String value,
                     int index)
              throws java.lang.IndexOutOfBoundsException

Set property value with given index.

Parameters:

value - property value

index - index of property value

Throws:

java.lang.IndexOutOfBoundsException - when the index is out of bounds

addValue

public void addValue(java.lang.String value)

Add property value. The array will be reallocated and copied, so beware of the performance drawback. Note that this call disconnects the values array returned from a getValues() call from the property.

Parameters:

value - property value

insertValue

public void insertValue(java.lang.String value,
                        int index)
                 throws java.lang.IndexOutOfBoundsException

Insert property value at given index. The array will be reallocated and copied, so beware of the performance drawback. Note that this call disconnects the values array returned from a getValues() call from the property.

Parameters:

value - property value

index - index of property value

Throws:

java.lang.IndexOutOfBoundsException - when the index is out of bounds

removeValue

public void removeValue(java.lang.String value)

Remove all occurences of the given property value. The array will be reallocated and copied, so beware of the performance drawback. Note that this call disconnects the values array returned from a getValues() call from the property.

Parameters:

value - property value

removeValue

public void removeValue(int index)
                 throws java.lang.IndexOutOfBoundsException

Remove property value with given index. The array will be reallocated and copied, so beware of the performance drawback. Note that this call disconnects the values array returned from a getValues() call from the property.

Parameters:

index - index of property value

Throws:

java.lang.IndexOutOfBoundsException - when the index is out of bounds

setAttributes

public void setAttributes(java.util.Properties attributes)
                   throws ResourceException

Set all attributes for the property at once. The given attribute map will be stored directly (as is - without being copied). Note that this call disconnects the attribute map returned from a getAttributes() call from the property.

Specified by:

setAttributes in interface IMutableProperty

Parameters:

attributes - property map holding all attributes

Throws:

ResourceException - when the attributes map or the property is invalid

clearAttributes

public void clearAttributes()
                     throws ResourceException

Remove all attributes for the property at once.

Specified by:

clearAttributes in interface IMutableProperty

Throws:

ResourceException - when the property is invalid

getAttribute

public java.lang.String getAttribute(java.lang.String attributeName)
                              throws ResourceException

Get attribute for the property.

Specified by:

getAttribute in interface IProperty

Overrides:

getAttribute in class AbstractProperty

Parameters:

attributeName - attribute name

Returns:

attribute value

Throws:

ResourceException - when the attribute name or the property is invalid

setAttribute

public void setAttribute(java.lang.String attributeName,
                         java.lang.String attributeValue)
                  throws ResourceException

Add attribute for the property.

Specified by:

setAttribute in interface IMutableProperty

Parameters:

attributeName - attribute name

attributeValue - attribute value

Throws:

ResourceException - when the attribute name or value or the property is invalid

removeAttribute

public void removeAttribute(java.lang.String attributeName)
                     throws ResourceException

Remove attribute from the property.

Specified by:

removeAttribute in interface IMutableProperty

Parameters:

attributeName - attribute name

Throws:

ResourceException - when the attribute name or the property is invalid