org.apache.ws.resource.properties
Interface ResourcePropertySet

public interface ResourcePropertySet

This interface defines the API used to access a collection of resource properties contained in a resource.

Method Summary

boolean	add(ResourceProperty property) Adds a resource property to the set and makes it available to queries and subscriptions, etc.
void	clear() Removes all properties.
ResourceProperty	get(javax.xml.namespace.QName propName) Retrieves a resource property.
ResourcePropertySetMetaData	getMetaData() Returns the metadata associated with this resource property set.
boolean	isEmpty() Returns true if, and only if, this set contains no properties.
java.util.Iterator	iterator() Returns an iterator over ResourceProperty entries.
boolean	remove(javax.xml.namespace.QName propName) Removes a resource property.
int	size() Returns the number of properties in this set.
org.w3c.dom.Element	toElement() Returns the entire resource property document as a DOM Element.
javax.xml.soap.SOAPElement	toSOAPElement() Returns the entire resource property document as a SAAJ SOAPElement.
java.lang.String	toXML() Returns the XML representation of this property set (i.e.

Method Detail

isEmpty

public boolean isEmpty()

Returns true if, and only if, this set contains no properties.

Returns:

true if, and only if, this set contains no properties

getMetaData

public ResourcePropertySetMetaData getMetaData()

Returns the metadata associated with this resource property set.

Returns:

the metadata associated with this resource property set

add

public boolean add(ResourceProperty property)
            throws MetaDataViolationException

Adds a resource property to the set and makes it available to queries and subscriptions, etc.

Parameters:

property - the ResourceProperty to add.

Throws:

MetaDataViolationException

clear

public void clear()
           throws MetaDataViolationException

Removes all properties.

Throws:

MetaDataViolationException

get

public ResourceProperty get(javax.xml.namespace.QName propName)

Retrieves a resource property.

Parameters:

propName - the name of the ResourceProperty to retrieve.

Returns:

the ResourceProperty that was retrieved. Null if the property does not exist.

iterator

public java.util.Iterator iterator()

Returns an iterator over ResourceProperty entries.

Returns:

an iterator over ResourceProperty entries.

remove

public boolean remove(javax.xml.namespace.QName propName)
               throws MetaDataViolationException

Removes a resource property.

Parameters:

propName - the name of the ResourceProperty to remove.

Returns:

the ResourceProperty that was removed. Null if the property does not exist or was not removed.

Throws:

MetaDataViolationException

size

public int size()

Returns the number of properties in this set.

Returns:

the number of properties

toElement

public org.w3c.dom.Element toElement()
                              throws org.apache.commons.lang.SerializationException

Returns the entire resource property document as a DOM Element.

Throws:

org.apache.commons.lang.SerializationException

toSOAPElement

public javax.xml.soap.SOAPElement toSOAPElement()
                                         throws org.apache.commons.lang.SerializationException

Returns the entire resource property document as a SAAJ SOAPElement.

Throws:

org.apache.commons.lang.SerializationException

toXML

public java.lang.String toXML()

Returns the XML representation of this property set (i.e. the resource properties document).

Returns:

the XML representation of this property set