com.sun.xml.ws.api.PropertySet Maven / Gradle / Ivy
Show all versions of webservices-rt Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2017 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
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or 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 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.sun.xml.ws.api;
import java.util.Map;
import java.util.Set;
import java.util.Map.Entry;
/**
* Placeholder for backwards compatibility.
*
* @deprecated Use com.oracle.webservices.api.message.PropertySet instead.
* @author snajper
*/
public abstract class PropertySet extends com.oracle.webservices.api.message.BasePropertySet {
/**
* Represents the list of strongly-typed known properties
* (keyed by property names.)
*
*
* Just giving it an alias to make the use of this class more fool-proof.
* @deprecated
*/
protected static class PropertyMap extends com.oracle.webservices.api.message.BasePropertySet.PropertyMap {}
/**
* @deprecated
*/
protected static PropertyMap parse(final Class clazz) {
com.oracle.webservices.api.message.BasePropertySet.PropertyMap pm = com.oracle.webservices.api.message.BasePropertySet.parse(clazz);
PropertyMap map = new PropertyMap();
map.putAll(pm);
return map;
}
/**
* 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) {
Accessor sp = getPropertyMap().get(key);
if(sp!=null)
return sp.get(this);
throw new IllegalArgumentException("Undefined property "+key);
}
/**
* 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.
*
* @throws ReadOnlyPropertyException
* if the given key is an alias of a strongly-typed field,
* and if the name object given is not assignable to the field.
*
* @see Property
*/
public Object put(String key, Object value) {
Accessor sp = getPropertyMap().get(key);
if(sp!=null) {
Object old = sp.get(this);
sp.set(this,value);
return old;
} else {
throw new IllegalArgumentException("Undefined property "+key);
}
}
public boolean supports(Object key) {
return getPropertyMap().containsKey(key);
}
public Object remove(Object key) {
Accessor sp = getPropertyMap().get(key);
if(sp!=null) {
Object old = sp.get(this);
sp.set(this,null);
return old;
} else {
throw new IllegalArgumentException("Undefined property "+key);
}
}
protected void createEntrySet(Set> core) {
for (final Entry e : getPropertyMap().entrySet()) {
core.add(new Entry() {
public String getKey() {
return e.getKey();
}
public Object getValue() {
return e.getValue().get(PropertySet.this);
}
public Object setValue(Object value) {
Accessor acc = e.getValue();
Object old = acc.get(PropertySet.this);
acc.set(PropertySet.this,value);
return old;
}
});
}
}
protected abstract PropertyMap getPropertyMap();
}