com.paypal.sdk.http.Headers Maven / Gradle / Ivy
/*
* PaypalServerSDKLib
*
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
package com.paypal.sdk.http;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;
import io.apimatic.coreinterfaces.http.HttpHeaders;
/**
* Class for creating and managing HTTP Headers.
*/
public class Headers implements HttpHeaders {
private Map> headers;
/**
* Default constructor.
*/
public Headers() {
this.headers = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
}
/**
* Constructor that creates a new instance using a given Map.
* @param headers The Map to use for creating an instance of this class.
*/
public Headers(Map> headers) {
this.headers = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
for (Map.Entry> kv : headers.entrySet()) {
add(kv.getKey(), kv.getValue());
}
}
/**
* Copy Constructor.
* @param h Headers Instance to be cloned.
*/
public Headers(Headers h) {
this.headers = cloneHeaderMap(h.headers);
}
/**
* Use to check if the given name is present in headers.
* @param headerName String name for header to be checked.
* @return true if headerName is found, false otherwise.
*/
public boolean has(String headerName) {
return this.headers.containsKey(headerName);
}
/**
* Returns a Set containing all header names.
* @return A Set containing all header names.
*/
public Set names() {
return headers.keySet();
}
/**
* Get the first value associated with a given header name,
* or null if the header name is not found.
* @param headerName The header name to find the associated value for.
* @return The first value associated with the given header name.
*/
public String value(String headerName) {
if (headers.containsKey(headerName)) {
return headers.get(headerName).get(0);
}
return null;
}
/**
* Get a List of all values associated with a given header name,
* or null if the header name is not found.
* @param headerName The header name to find the associated values for.
* @return A List of values associated with the given header name.
*/
public List values(String headerName) {
if (headers.containsKey(headerName)) {
return headers.get(headerName);
}
return null;
}
/**
* Returns a Map of the headers, giving only one value for each header name.
* @return A Map of header names and values.
*/
public Map asSimpleMap() {
Map copy = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
for (Map.Entry> kv : this.headers.entrySet()) {
if (kv.getValue() != null) {
copy.put(kv.getKey(), kv.getValue().get(0));
}
}
return copy;
}
/**
* Returns a simulated MultiMap of the headers.
* @return A Map of header names and values.
*/
public Map> asMultimap() {
return cloneHeaderMap(this.headers);
}
/**
* Clones a header map.
* @param headerMap A Map containing header names and values as Entry pairs.
* @return A Map of header names and values.
*/
private Map> cloneHeaderMap(Map> headerMap) {
Map> copy = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
for (Map.Entry> kv : headerMap.entrySet()) {
if (kv.getValue() != null) {
copy.put(kv.getKey(), kv.getValue());
}
}
return copy;
}
/**
* Adds a value for a header name to this object, neither headerName nor value can be null.
* @param headerName The header name to add the value against.
* @param value The value to add.
*/
public void add(String headerName, String value) {
if (headerName == null || value == null) {
return;
}
if (this.headers.containsKey(headerName)) {
this.headers.get(headerName).add(value);
} else {
List values = new ArrayList();
values.add(value);
this.headers.put(headerName, values);
}
}
/**
* Adds a List of values for a header name to this object, neither headerName nor values can be
* null.
* @param headerName The header name to add the values against.
* @param values The List of values to add.
*/
public void add(String headerName, List values) {
if (headerName == null || values == null) {
return;
}
if (this.headers.containsKey(headerName)) {
for (String value : values) {
if (value != null) {
this.headers.get(headerName).add(value);
}
}
} else {
List copyOfValues = new ArrayList();
for (String value : values) {
if (value != null) {
copyOfValues.add(value);
}
}
if (!copyOfValues.isEmpty()) {
this.headers.put(headerName, copyOfValues);
}
}
}
/**
* Adds a value for a header name to this object and returns the Headers instance.
* Neither headerName nor values can be null.
* @param headerName The header name to add the value against.
* @param value The value to add.
* @return The current instance after adding the provided header name and value.
*/
public Headers createHeader(String headerName, String value) {
add(headerName, value);
return this;
}
/**
* Adds values from a Map to this object.
* @param headers A Map containing header names and values as Entry pairs.
*/
public void addAllFromMap(Map headers) {
for (Map.Entry kv : headers.entrySet()) {
this.add(kv.getKey(), kv.getValue());
}
}
/**
* Adds values from a simulated Multi-Map to this object.
* @param headers A Map containing header names and values as Entry pairs.
*/
public void addAllFromMultiMap(Map> headers) {
for (Map.Entry> kv : headers.entrySet()) {
this.add(kv.getKey(), kv.getValue());
}
}
/**
* Adds all the entries in a Headers object to this object.
* @param headers The object whose values are to be added to this object.
*/
public void addAll(HttpHeaders headers) {
for (Map.Entry> kv : headers.asMultimap().entrySet()) {
this.add(kv.getKey(), kv.getValue());
}
}
/**
* Removes the mapping for a header name if it is present,
* and get the value to which this map previously associated the key,
* or null if the map contained no mapping for the key.
* @param headerName The header name to remove the associated values for
* @return A List of values associated with the given header name.
*/
public List remove(String headerName) {
if (headers.containsKey(headerName)) {
return headers.remove(headerName);
}
return null;
}
/**
* Converts this Headers into string format.
* @return String representation of this class
*/
@Override
public String toString() {
return "Headers " + headers;
}
}