org.apache.struts2.dispatcher.HttpParameters Maven / Gradle / Ivy
/*
* 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.
*/
package org.apache.struts2.dispatcher;
import org.apache.struts2.interceptor.ParameterAware;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;
import java.util.TreeSet;
@SuppressWarnings("unchecked")
public class HttpParameters implements Map, Cloneable {
private Map parameters;
private HttpParameters(Map parameters) {
this.parameters = parameters;
}
public static Builder create(Map requestParameterMap) {
return new Builder(requestParameterMap);
}
public static Builder create() {
return new Builder(new HashMap());
}
public HttpParameters remove(Set paramsToRemove) {
for (String paramName : paramsToRemove) {
parameters.remove(paramName);
}
return this;
}
public HttpParameters remove(final String paramToRemove) {
return remove(new HashSet() {{
add(paramToRemove);
}});
}
public boolean contains(String name) {
return parameters.containsKey(name);
}
/**
* Access to this method will be restricted with the next versiob
* @deprecated since 2.5.6, do not use it
* TODO: reduce access level to `private`
*/
@Deprecated
public Map toMap() {
Map result = new HashMap<>(parameters.size());
for (Map.Entry entry : parameters.entrySet()) {
result.put(entry.getKey(), entry.getValue().getMultipleValues());
}
return result;
}
public HttpParameters appendAll(Map newParams) {
parameters.putAll(newParams);
return this;
}
public void applyParameters(ParameterAware parameterAware) {
parameterAware.setParameters(toMap());
}
@Override
public int size() {
return parameters.size();
}
@Override
public boolean isEmpty() {
return parameters.isEmpty();
}
@Override
public boolean containsKey(Object key) {
return parameters.containsKey(key);
}
@Override
public boolean containsValue(Object value) {
return parameters.containsValue(value);
}
@Override
public Parameter get(Object key) {
if (parameters.containsKey(key)) {
return parameters.get(key);
} else {
return new Parameter.Empty(String.valueOf(key));
}
}
@Override
public Parameter put(String key, Parameter value) {
throw new IllegalAccessError("HttpParameters are immutable, you cannot put value directly!");
}
@Override
public Parameter remove(Object key) {
throw new IllegalAccessError("HttpParameters are immutable, you cannot remove object directly!");
}
@Override
public void putAll(Map m) {
throw new IllegalAccessError("HttpParameters are immutable, you cannot put values directly!");
}
@Override
public void clear() {
throw new IllegalAccessError("HttpParameters are immutable, you cannot clear values directly!");
}
@Override
public Set keySet() {
return Collections.unmodifiableSet(new TreeSet<>(parameters.keySet()));
}
@Override
public Collection values() {
return Collections.unmodifiableCollection(parameters.values());
}
@Override
public Set> entrySet() {
return Collections.unmodifiableSet(parameters.entrySet());
}
@Override
public String toString() {
return parameters.toString();
}
public static class Builder {
private Map requestParameterMap;
private HttpParameters parent;
protected Builder(Map requestParameterMap) {
this.requestParameterMap = new HashMap<>();
this.requestParameterMap.putAll(requestParameterMap);
}
public Builder withParent(HttpParameters parentParams) {
if (parentParams != null) {
parent = parentParams;
}
return this;
}
public Builder withExtraParams(Map params) {
if (params != null) {
requestParameterMap.putAll(params);
}
return this;
}
public Builder withComparator(Comparator orderedComparator) {
requestParameterMap = new TreeMap<>(orderedComparator);
return this;
}
public HttpParameters build() {
Map parameters = (parent == null)
? new HashMap()
: new HashMap<>(parent.parameters);
for (Map.Entry entry : requestParameterMap.entrySet()) {
String name = entry.getKey();
Object value = entry.getValue();
parameters.put(name, new Parameter.Request(name, value));
}
return new HttpParameters(parameters);
}
/**
* Alternate Builder method which avoids wrapping any parameters that are already
* a {@link Parameter} element within another {@link Parameter} wrapper.
*
* @return
*/
public HttpParameters buildNoNestedWrapping() {
Map parameters = (parent == null)
? new HashMap()
: new HashMap<>(parent.parameters);
for (Map.Entry entry : requestParameterMap.entrySet()) {
String name = entry.getKey();
Object value = entry.getValue();
Parameter parameterValue = (value instanceof Parameter)
? (Parameter) value
: new Parameter.Request(name, value);
parameters.put(name, parameterValue);
}
return new HttpParameters(parameters);
}
}
}