com.sap.netweaver.bc.rf.common.property.xmltype
Class XmlMultiValueProperty

[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.xmltype.XmlMultiValueProperty

All Implemented Interfaces:

IProperty, java.io.Serializable

Direct Known Subclasses:

MutableXmlMultiValueProperty, XmlMultiValueProperty

public class XmlMultiValueProperty

extends AbstractProperty

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

See Also:

AbstractProperty, IMutableProperty, IProperty, Serialized Form

Field Summary

protected java.lang.String[]

values

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

attributes, flags, name, resourceBundles

Constructor Summary

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

Method Summary

PropertyType	getType() Get immutable type of this property.
java.lang.String	getValue(int index) Get property value with given index.
java.lang.String	getValueAsString() Get the property value converted to a string.
java.lang.String[]	getValues() Get array of property values.
java.lang.String[]	getValuesAsStrings() Get the property values converted to a string array.
boolean	isMultiValue() Returns true if this property is a multi-value property.

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

areFlagsSet, equals, getAttribute, 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

Field Detail

values

protected java.lang.String[] values

Constructor Detail

XmlMultiValueProperty

public XmlMultiValueProperty(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

XmlMultiValueProperty

public XmlMultiValueProperty(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

XmlMultiValueProperty

public XmlMultiValueProperty(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

XmlMultiValueProperty

public XmlMultiValueProperty(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

XmlMultiValueProperty

protected XmlMultiValueProperty(IPropertyName name,
                                java.lang.String[] values,
                                java.util.Properties attributes,
                                int flags,
                                ResourceBundles resourceBundles)
                         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

resourceBundles - resource bundles containing (localized) property description

Throws:

ResourceException - when the property creation failed

Method Detail

getType

public PropertyType getType()

Get immutable type of this property.

Returns:

immutable type of this property

isMultiValue

public boolean isMultiValue()

Returns true if this property is a multi-value property.

Returns:

true if this property is a multi-value property

getValueAsString

public java.lang.String getValueAsString()
                                  throws ResourceException

Get the property value converted to a string. If this is a multi value property just return the first value.

Returns:

property value converted to a string

Throws:

ResourceException - when the property is invalid

getValuesAsStrings

public java.lang.String[] getValuesAsStrings()
                                      throws ResourceException

Get the property values converted to a string array. If this is a single value property just return an array with the value as only element.

Returns:

array of property values converted to strings

Throws:

ResourceException - when the property is invalid

getValues

public java.lang.String[] getValues()

Get array of property values. The returned values array will be the stored one (as is - without being copied). Note that the stored values array is no longer connected to the property when it is set by a setValues() call or completely exchanged otherwise.

Returns:

array of property values

getValue

public java.lang.String getValue(int index)
                          throws java.lang.IndexOutOfBoundsException

Get property value with given index.

Parameters:

index - index of property value

Returns:

property value with given index

Throws:

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