org.ws4d.java.types

Class AttributableSupport

java.lang.Object

org.ws4d.java.types.AttributableSupport

All Implemented Interfaces:

Attributable

Direct Known Subclasses:

Fault, IOType, OperationCommons, ServiceCommons.PortType, WSDLOperation

public class AttributableSupport
extends java.lang.Object
implements Attributable

A standard implementation of the Attributable interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected HashMap	attributes

Constructor Summary

Constructors

Constructor and Description
AttributableSupport() Default constructor.
AttributableSupport(HashMap attributes) Creates a new instance with the given attributes.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
CustomAttributeValue	getAttribute(QName name) Returns the value of the attribute with the given name or null, if this attribute is not available (or if its value is actually explicitly set to null ).
HashMap	getAttributes() Returns all attributes explicitly set for this Attributable instance.
boolean	hasAttributes() Returns true only if this instance has at least one attribute set.
int	hashCode()
void	serializeAttributes(XmlSerializer serializer) Serializes the attributes stored within this instance, if any.
void	setAttribute(QName name, CustomAttributeValue value) Sets the value for the attribute with the specified name.
void	setAttribute(QName name, java.lang.String value) Sets the value for the attribute with the specified name.
void	setAttributes(HashMap attributes) Sets all attributes at once to those contained within argument attributes.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

attributes

protected HashMap attributes

Constructor Detail

AttributableSupport

public AttributableSupport()

Default constructor.

AttributableSupport

public AttributableSupport(HashMap attributes)

Creates a new instance with the given attributes.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getAttribute

public CustomAttributeValue getAttribute(QName name)

Description copied from interface: Attributable

Returns the value of the attribute with the given name or null, if this attribute is not available (or if its value is actually explicitly set to null ).

Specified by:

getAttribute in interface Attributable

Parameters:

name - the name of the attribute of which to query the value

Returns:

the value of the named attribute or null

setAttribute

public void setAttribute(QName name,
                         CustomAttributeValue value)

Description copied from interface: Attributable

Sets the value for the attribute with the specified name. Throws a java.lang.IllegalArgumentException in case name is null.

Specified by:

setAttribute in interface Attributable

Parameters:

name - the name of the attribute to set, must not be null

value - the value to set the named attribute to (may be null

setAttribute

public void setAttribute(QName name,
                         java.lang.String value)

Description copied from interface: Attributable

Sets the value for the attribute with the specified name. The value will be represented as plain String. It will be wrapped within a new instance of StringAttributeValue. This method throws a java.lang.IllegalArgumentException in case name is null.

This is a shorthand for setAttribute(name, new StringAttributeValue(value)).

Specified by:

setAttribute in interface Attributable

Parameters:

name - the name of the attribute to set, must not be null

value - the value to set the named attribute to (may be null

getAttributes

public HashMap getAttributes()

Description copied from interface: Attributable

Returns all attributes explicitly set for this Attributable instance. Note that depending on the actual implementation the returned reference may point at the 'life map', i .e. the actual storage for the attributes. Thus, modifications to that map should be performed with care and keeping this in mind.

Specified by:

getAttributes in interface Attributable

Returns:

all already set attributes

setAttributes

public void setAttributes(HashMap attributes)

Description copied from interface: Attributable

Sets all attributes at once to those contained within argument attributes. Note that depending on the actual implementation it is possible that the map attributes points at may be used for the actual internal storage of the attributes (i.e. without copying it). That is why, after passing it to this method, modifications to this map should be made with care. This method throws a java.lang.IllegalArgumentException in cases where attributes is null.

Specified by:

setAttributes in interface Attributable

Parameters:

attributes - the new attributes to set

hasAttributes

public boolean hasAttributes()

Description copied from interface: Attributable

Returns true only if this instance has at least one attribute set. Returns false in any other case.

Specified by:

hasAttributes in interface Attributable

Returns:

true only if there is at least one attribute set within this instance

serializeAttributes

public void serializeAttributes(XmlSerializer serializer)
                         throws java.io.IOException

Description copied from interface: Attributable

Serializes the attributes stored within this instance, if any.

Specified by:

serializeAttributes in interface Attributable

Parameters:

serializer - the serializer to which to send output

Throws:

java.io.IOException - in case writing to serializer fails for any reason