Module com.sun.xml.ws

Package com.oracle.webservices.api.message

Interface PropertySet

All Known Subinterfaces:

DistributedPropertySet, MessageContext

All Known Implementing Classes:

AddressingPropertySet, BaseDistributedPropertySet, BasePropertySet, Packet, RequestContext, ServletConnectionImpl, ThrowableContainerPropertySet, WsaPropertyBag, WSDLDirectProperties, WSDLPortProperties, WSDLProperties, WSHTTPConnection, XMLPropertyBag

public interface PropertySet

A set of "properties" that can be accessed via strongly-typed fields as well as reflexibly through the property name.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static @interface	PropertySet.Property	Marks a field on PropertySet as a property of MessageContext.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	asMap()	Creates a modifiable Map view of this PropertySet.
boolean	containsKey(Object key)
Object	get(Object key)	Gets the name of the property.
Object	put(String key, Object value)	Sets a property.
Object	remove(Object key)
boolean	supports(Object key)	Checks if this PropertySet supports a property of the given name.

Method Details

containsKey

boolean containsKey(Object key)

get

Object get(Object key)

Gets the name of the property.

Parameters:

key - This field is typed as Object to follow the Map.get(Object) convention, but if anything but String is passed, this method just returns null.

put

Object put(String key,
 Object value)

Sets a property.

Implementation Note This method is slow. Code inside JAX-WS should define strongly-typed fields in this class and access them directly, instead of using this.

See Also:

• PropertySet.Property

supports

boolean supports(Object key)

Checks if this PropertySet supports a property of the given name.

remove

Object remove(Object key)

asMap

Map<String,Object> asMap()

Creates a modifiable Map view of this PropertySet.
Changes done on this Map or on PropertySet object work in both directions - values made to Map are reflected to PropertySet and changes done using getters/setters on PropertySet object are automatically reflected in this Map.
If necessary, it also can hold other values (not present on PropertySet) - see BasePropertySet.mapAllowsAdditionalProperties()

Returns:

always non-null valid instance.