org.apache.http.params.BasicHttpParams Maven / Gradle / Ivy
Show all versions of httpcore Show documentation
/*
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
*
* Please note access to the internal structures of this class is not
* synchronized and therefore this class may be thread-unsafe.
*
* @since 4.0
*
* @deprecated (4.3) use configuration classes provided 'org.apache.http.config'
* and 'org.apache.http.client.config'
*/
@Deprecated
@Contract(threading = ThreadingBehavior.SAFE)
public class BasicHttpParams extends AbstractHttpParams implements Serializable, Cloneable {
private static final long serialVersionUID = -7086398485908701455L;
/** Map of HTTP parameters that this collection contains. */
private final Map parameters = new ConcurrentHashMap();
public BasicHttpParams() {
super();
}
@Override
public Object getParameter(final String name) {
return this.parameters.get(name);
}
@Override
public HttpParams setParameter(final String name, final Object value) {
if (name == null) {
return this;
}
if (value != null) {
this.parameters.put(name, value);
} else {
this.parameters.remove(name);
}
return this;
}
@Override
public boolean removeParameter(final String name) {
//this is to avoid the case in which the key has a null value
if (this.parameters.containsKey(name)) {
this.parameters.remove(name);
return true;
}
return false;
}
/**
* Assigns the value to all the parameter with the given names
*
* @param names array of parameter names
* @param value parameter value
*/
public void setParameters(final String[] names, final Object value) {
for (final String name : names) {
setParameter(name, value);
}
}
/**
* Is the parameter set?
*
* Uses {@link #getParameter(String)} (which is overrideable) to
* fetch the parameter value, if any.
*
* Also @see {@link #isParameterSetLocally(String)}
*
* @param name parameter name
* @return true if parameter is defined and non-null
*/
public boolean isParameterSet(final String name) {
return getParameter(name) != null;
}
/**
* Is the parameter set in this object?
*
* The parameter value is fetched directly.
*
* Also @see {@link #isParameterSet(String)}
*
* @param name parameter name
* @return true if parameter is defined and non-null
*/
public boolean isParameterSetLocally(final String name) {
return this.parameters.get(name) != null;
}
/**
* Removes all parameters from this collection.
*/
public void clear() {
this.parameters.clear();
}
/**
* Creates a copy of these parameters.
* This implementation calls {@link #clone()}.
*
* @return a new set of params holding a copy of the
* local parameters in this object.
*
* @throws UnsupportedOperationException if the clone() fails
*/
@Override
public HttpParams copy() {
try {
return (HttpParams) clone();
} catch (final CloneNotSupportedException ex) {
throw new UnsupportedOperationException("Cloning not supported");
}
}
/**
* Clones the instance.
* Uses {@link #copyParams(HttpParams)} to copy the parameters.
*/
@Override
public Object clone() throws CloneNotSupportedException {
final BasicHttpParams clone = (BasicHttpParams) super.clone();
copyParams(clone);
return clone;
}
/**
* Copies the locally defined parameters to the argument parameters.
* This method is called from {@link #clone()}.
*
* @param target the parameters to which to copy
* @since 4.2
*/
public void copyParams(final HttpParams target) {
for (final Map.Entry me : this.parameters.entrySet()) {
target.setParameter(me.getKey(), me.getValue());
}
}
/**
* Returns the current set of names.
*
* Changes to the underlying HttpParams are not reflected
* in the set - it is a snapshot.
*
* @return the names, as a Set<String>
* @since 4.2
*/
@Override
public Set getNames() {
return new HashSet(this.parameters.keySet());
}
@Override
public String toString() {
return "[parameters=" + parameters + "]";
}
}