Class URLParameters

java.lang.Object

java.util.AbstractMap<String,String>

java.util.HashMap<String,String>

java.util.LinkedHashMap<@NonNull String, @NonNull String>

de.gustavblass.commons.URLParameters

All Implemented Interfaces:

Serializable, Cloneable, Map<String,String>, SequencedMap<String,String>

public class URLParameters
extends LinkedHashMap<@NonNull String, @NonNull String>

Represents URL parameters as a LinkedHashMap with the keys as the parameter names and the values as the parameter values.

See Also:

• encode()
• URL encoding
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor	Description
URLParameters()	See LinkedHashMap().
URLParameters(int initialCapacity)	See LinkedHashMap(int).
URLParameters(int initialCapacity, float loadFactor)	See LinkedHashMap(int, float).
URLParameters(int initialCapacity, float loadFactor, boolean accessOrder)	See LinkedHashMap(int, float, boolean).
URLParameters(@NonNull Map<String,String> map)	See LinkedHashMap(Map).

Method Summary

Modifier and Type	Method	Description
@NonNull String	encode()	Encodes the URL parameters such that they can be used in a URL or in a POST request.

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, newLinkedHashMap, putFirst, putLast, removeEldestEntry, replaceAll, reversed, sequencedEntrySet, sequencedKeySet, sequencedValues, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, newHashMap, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from interface java.util.SequencedMap

firstEntry, lastEntry, pollFirstEntry, pollLastEntry

Constructor Details

URLParameters

public URLParameters()

See LinkedHashMap().

URLParameters

public URLParameters(@NonNull
 @NonNull Map<String,String> map)

See LinkedHashMap(Map).

URLParameters

public URLParameters(int initialCapacity)

See LinkedHashMap(int).

URLParameters

public URLParameters(int initialCapacity,
 float loadFactor)

See LinkedHashMap(int, float).

URLParameters

public URLParameters(int initialCapacity,
 float loadFactor,
 boolean accessOrder)

See LinkedHashMap(int, float, boolean).

Method Details

encode

@Contract(pure=true)
@NonNull
public @NonNull String encode()

Encodes the URL parameters such that they can be used in a URL or in a POST request.

Returns:

The encoded parameters as a String in the format key1=value1&key2=value2&...

See Also:

• URL encoding
• Query string