jdk8-mips64-public/jaxws: src/share/jaxws_classes/com/oracle/webservices/internal/api/message/PropertySet.java@0989ad8c0860 (annotated)

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

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

Tue, 09 Apr 2013 14:51:13 +0100

author: alanb
date: Tue, 09 Apr 2013 14:51:13 +0100
changeset 368: 0989ad8c0860
child 374: 72e03566f0a6
permissions: -rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
  * Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.
  *
  * The contents of this file are subject to the terms of either the GNU
  * General Public License Version 2 only ("GPL") or the Common Development
  * and Distribution License("CDDL") (collectively, the "License").  You
  * may not use this file except in compliance with the License.  You can
  * obtain a copy of the License at
  * http://glassfish.java.net/public/CDDL+GPL_1_1.html
  * or packager/legal/LICENSE.txt.  See the License for the specific
  * language governing permissions and limitations under the License.
  *
  * When distributing the software, include this License Header Notice in each
  * file and include the License file at packager/legal/LICENSE.txt.
  *
  * GPL Classpath Exception:
  * Oracle designates this particular file as subject to the "Classpath"
  * exception as provided by Oracle in the GPL Version 2 section of the License
  * file that accompanied this code.
  *
  * Modifications:
  * If applicable, add the following below the License Header, with the fields
  * enclosed by brackets [] replaced by your own identifying information:
  * "Portions Copyright [year] [name of copyright owner]"
  *
  * Contributor(s):
  * If you wish your version of this file to be governed by only the CDDL or
  * only the GPL Version 2, indicate your decision by adding "[Contributor]
  * elects to include this software in this distribution under the [CDDL or GPL
  * Version 2] license."  If you don't indicate a single choice of license, a
  * recipient has the option to distribute your version of this file under
  * either the CDDL, the GPL Version 2 or to extend the choice of license to
  * its licensees as provided above.  However, if you add GPL Version 2 code
  * and therefore, elected the GPL Version 2 license, then the option applies
  * only if the new code is made subject to such option by the copyright
  * holder.
  */
 package com.oracle.webservices.internal.api.message;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 import java.util.Map;
 import javax.xml.ws.handler.MessageContext;
 /**
  * A set of "properties" that can be accessed via strongly-typed fields
  * as well as reflexibly through the property name.
  *
  * @author Kohsuke Kawaguchi
  */
 public interface PropertySet {
     /**
      * Marks a field on {@link PropertySet} as a
      * property of {@link MessageContext}.
      *
      * <p>
      * To make the runtime processing easy, this annotation
      * must be on a public field (since the property name
      * can be set through {@link Map} anyway, you won't be
      * losing abstraction by doing so.)
      *
      * <p>
      * For similar reason, this annotation can be only placed
      * on a reference type, not primitive type.
      *
      * @author Kohsuke Kawaguchi
      */
     @Inherited
     @Retention(RetentionPolicy.RUNTIME)
     @Target({ElementType.FIELD,ElementType.METHOD})
     public @interface Property {
         /**
          * Name of the property.
          */
         String[] value();
     }
     public boolean containsKey(Object key);
     /**
      * Gets the name of the property.
      *
      * @param key
      *      This field is typed as {@link Object} to follow the {@link Map#get(Object)}
      *      convention, but if anything but {@link String} is passed, this method
      *      just returns null.
      */
     public Object get(Object key);
     /**
      * Sets a property.
      *
      * <h3>Implementation Note</h3>
      * 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 Property
      */
     public Object put(String key, Object value);
     /**
      * Checks if this {@link PropertySet} supports a property of the given name.
      */
     public boolean supports(Object key);
     public Object remove(Object key);
     /**
      * Creates a {@link Map} view of this {@link PropertySet}.
      *
      * <p>
      * This map is partially live, in the sense that values you set to it
      * will be reflected to {@link PropertySet}.
      *
      * <p>
      * However, this map may not pick up changes made
      * to {@link PropertySet} after the view is created.
      *
      * @deprecated use newer implementation {@link com.sun.xml.internal.ws.api.PropertySet#asMap()} which produces
      * readwrite {@link Map}
      *
      * @return
      *      always non-null valid instance.
      */
     @Deprecated
     public Map<String,Object> createMapView();
     /**
      * Creates a modifiable {@link Map} view of this {@link PropertySet}.
      * <p/>
      * Changes done on this {@link Map} or on {@link PropertySet} object work in both directions - values made to
      * {@link Map} are reflected to {@link PropertySet} and changes done using getters/setters on {@link PropertySet}
      * object are automatically reflected in this {@link Map}.
      * <p/>
      * If necessary, it also can hold other values (not present on {@link PropertySet}) -
      * {@see PropertySet#mapAllowsAdditionalProperties}
      *
      * @return always non-null valid instance.
      */
     public Map<String, Object> asMap();
 }

Mercurial > jdk8-mips64-public > jaxws / annotate

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

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