• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/jaxws_classes/com/oracle/webservices/internal/api/message/PropertySet.java@9c07ef4934dd (annotated)

src/share/jaxws_classes/com/oracle/webservices/internal/api/message/PropertySet.java

Thu, 31 Aug 2017 15:18:52 +0800

author

aoqi

date

Thu, 31 Aug 2017 15:18:52 +0800

changeset 637

9c07ef4934dd

parent 374

72e03566f0a6

parent 0

373ffda63c9a

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.oracle.webservices.internal.api.message;
aoqi@0	27
aoqi@0	28	import java.lang.annotation.ElementType;
aoqi@0	29	import java.lang.annotation.Inherited;
aoqi@0	30	import java.lang.annotation.Retention;
aoqi@0	31	import java.lang.annotation.RetentionPolicy;
aoqi@0	32	import java.lang.annotation.Target;
aoqi@0	33	import java.util.Map;
aoqi@0	34
aoqi@0	35	import javax.xml.ws.handler.MessageContext;
aoqi@0	36
aoqi@0	37	/**
aoqi@0	38	* A set of "properties" that can be accessed via strongly-typed fields
aoqi@0	39	* as well as reflexibly through the property name.
aoqi@0	40	*
aoqi@0	41	* @author Kohsuke Kawaguchi
aoqi@0	42	*/
aoqi@0	43	public interface PropertySet {
aoqi@0	44
aoqi@0	45	/**
aoqi@0	46	* Marks a field on {@link PropertySet} as a
aoqi@0	47	* property of {@link MessageContext}.
aoqi@0	48	*
aoqi@0	49	* <p>
aoqi@0	50	* To make the runtime processing easy, this annotation
aoqi@0	51	* must be on a public field (since the property name
aoqi@0	52	* can be set through {@link Map} anyway, you won't be
aoqi@0	53	* losing abstraction by doing so.)
aoqi@0	54	*
aoqi@0	55	* <p>
aoqi@0	56	* For similar reason, this annotation can be only placed
aoqi@0	57	* on a reference type, not primitive type.
aoqi@0	58	*
aoqi@0	59	* @author Kohsuke Kawaguchi
aoqi@0	60	*/
aoqi@0	61	@Inherited
aoqi@0	62	@Retention(RetentionPolicy.RUNTIME)
aoqi@0	63	@Target({ElementType.FIELD,ElementType.METHOD})
aoqi@0	64	public @interface Property {
aoqi@0	65	/**
aoqi@0	66	* Name of the property.
aoqi@0	67	*/
aoqi@0	68	String[] value();
aoqi@0	69	}
aoqi@0	70
aoqi@0	71	public boolean containsKey(Object key);
aoqi@0	72
aoqi@0	73	/**
aoqi@0	74	* Gets the name of the property.
aoqi@0	75	*
aoqi@0	76	* @param key
aoqi@0	77	* This field is typed as {@link Object} to follow the {@link Map#get(Object)}
aoqi@0	78	* convention, but if anything but {@link String} is passed, this method
aoqi@0	79	* just returns null.
aoqi@0	80	*/
aoqi@0	81	public Object get(Object key);
aoqi@0	82
aoqi@0	83	/**
aoqi@0	84	* Sets a property.
aoqi@0	85	*
aoqi@0	86	* <h3>Implementation Note</h3>
aoqi@0	87	* This method is slow. Code inside JAX-WS should define strongly-typed
aoqi@0	88	* fields in this class and access them directly, instead of using this.
aoqi@0	89	*
aoqi@0	90	* @see Property
aoqi@0	91	*/
aoqi@0	92	public Object put(String key, Object value);
aoqi@0	93
aoqi@0	94	/**
aoqi@0	95	* Checks if this {@link PropertySet} supports a property of the given name.
aoqi@0	96	*/
aoqi@0	97	public boolean supports(Object key);
aoqi@0	98
aoqi@0	99	public Object remove(Object key);
aoqi@0	100
aoqi@0	101	/**
aoqi@0	102	* Creates a {@link Map} view of this {@link PropertySet}.
aoqi@0	103	*
aoqi@0	104	* <p>
aoqi@0	105	* This map is partially live, in the sense that values you set to it
aoqi@0	106	* will be reflected to {@link PropertySet}.
aoqi@0	107	*
aoqi@0	108	* <p>
aoqi@0	109	* However, this map may not pick up changes made
aoqi@0	110	* to {@link PropertySet} after the view is created.
aoqi@0	111	*
aoqi@0	112	* @deprecated use newer implementation {@link com.sun.xml.internal.ws.api.PropertySet#asMap()} which produces
aoqi@0	113	* readwrite {@link Map}
aoqi@0	114	*
aoqi@0	115	* @return
aoqi@0	116	* always non-null valid instance.
aoqi@0	117	*/
aoqi@0	118	@Deprecated
aoqi@0	119	public Map<String,Object> createMapView();
aoqi@0	120
aoqi@0	121	/**
aoqi@0	122	* Creates a modifiable {@link Map} view of this {@link PropertySet}.
aoqi@0	123	* <p/>
aoqi@0	124	* Changes done on this {@link Map} or on {@link PropertySet} object work in both directions - values made to
aoqi@0	125	* {@link Map} are reflected to {@link PropertySet} and changes done using getters/setters on {@link PropertySet}
aoqi@0	126	* object are automatically reflected in this {@link Map}.
aoqi@0	127	* <p/>
aoqi@0	128	* If necessary, it also can hold other values (not present on {@link PropertySet}) -
aoqi@0	129	* {@see PropertySet#mapAllowsAdditionalProperties}
aoqi@0	130	*
aoqi@0	131	* @return always non-null valid instance.
aoqi@0	132	*/
aoqi@0	133	public Map<String, Object> asMap();
aoqi@0	134	}