org.jvnet.ws.message
Interface PropertySet

All Known Subinterfaces:

DistributedPropertySet, MessageContext

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

static interface

PropertySet.Property Marks a field on PropertySet as a property of MessageContext.

Method Summary

boolean	containsKey(java.lang.Object key)
java.util.Map<java.lang.String,java.lang.Object>	createMapView() Creates a Map view of this PropertySet.
java.lang.Object	get(java.lang.Object key) Gets the name of the property.
java.lang.Object	put(java.lang.String key, java.lang.Object value) Sets a property.
java.lang.Object	remove(java.lang.Object key)
boolean	supports(java.lang.Object key) Checks if this PropertySet supports a property of the given name.

Method Detail

containsKey

boolean containsKey(java.lang.Object key)

get

java.lang.Object get(java.lang.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

java.lang.Object put(java.lang.String key,
                     java.lang.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(java.lang.Object key)

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

remove

java.lang.Object remove(java.lang.Object key)

createMapView

java.util.Map<java.lang.String,java.lang.Object> createMapView()

Creates a Map view of this PropertySet.

This map is partially live, in the sense that values you set to it will be reflected to PropertySet.

However, this map may not pick up changes made to PropertySet after the view is created.

Returns:

always non-null valid instance.