com.helger.commons.url

Class URLParameterList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<ELEMENTTYPE>

com.helger.commons.collection.ext.CommonsArrayList<URLParameter>

com.helger.commons.url.URLParameterList

All Implemented Interfaces:

ICommonsCollection<URLParameter>, ICommonsIterable<URLParameter>, ICommonsList<URLParameter>, ICloneable<ICommonsList<URLParameter>>, Serializable, Cloneable, Iterable<URLParameter>, Collection<URLParameter>, List<URLParameter>, RandomAccess

@NotThreadSafe
public class URLParameterList
extends CommonsArrayList<URLParameter>

A list of URL parameters with a sanity API. It allows for multiple URL parameters with the same name and thereby maintaining the order of the URL parameters.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
URLParameterList()
URLParameterList(List<? extends URLParameter> aOther)

Method Summary

Modifier and Type	Method and Description
URLParameterList	add(Map.Entry<String,String> aEntry)
URLParameterList	add(String sName) Add a parameter without a value
URLParameterList	add(String sName, BigInteger aValue)
URLParameterList	add(String sName, boolean bValue)
URLParameterList	add(String sName, int nValue)
URLParameterList	add(String sName, long nValue)
URLParameterList	add(String sName, String sValue)
URLParameterList	addAll(List<? extends URLParameter> aParams)
URLParameterList	addAll(Map<String,String> aParams)
URLParameterList	addAll(String sName, String... aValues)
boolean	contains(String sName)
boolean	contains(String sName, String sValue)
ICommonsOrderedSet<String>	getAllParamNames()
ICommonsList<String>	getAllParamValues(String sName)
IMultiMapListBased<String,String>	getAsMultiMap()
URLParameterList	getClone()
String	getFirstParamValue(String sName) Get the value of the first parameter with the provided name
URLParameterList	remove(String sName) Remove all parameter with the given name.
URLParameterList	remove(String sName, String sValue) Remove all parameter with the given name and value.

Methods inherited from class com.helger.commons.collection.ext.CommonsArrayList

createInstance

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.collection.ext.ICommonsList

getAll, getAllInstanceOf, getAllMapped, getAllMapped, getAsUnmodifiable, getAtIndex, getFirst, getFirst, getLast, getLast, getSortedInline, removeAndReturnElementAtIndex, removeAtIndex, removeFirst, removeLast, reverse, setFirst, setLast, swapItems

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface com.helger.commons.collection.ext.ICommonsCollection

addAll, addAll, addAll, addAll, addAll, addAll, addAll, addAll, addAllMapped, addAllMapped, addAllMapped, addAllMapped, addAllMapped, addAllMapped, addIf, addIfNotNull, addObject, getAtIndex, getAtIndex, getAtIndex, getAtIndexMapped, getAtIndexMapped, getAtIndexMapped, getAtIndexMapped, getCopyAsList, getCount, getSorted, isNotEmpty, iterator2, removeAll, removeObject, set, setAll, setAll

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface com.helger.commons.collection.ext.ICommonsIterable

containsAny, containsNone, containsOnly, findAll, findAllInstanceOf, findAllMapped, findAllMapped, findAllMapped, findFirst, findFirst, findFirstMapped, findFirstMapped, forEach, forEach, forEachBreakable, getIteratorCount, getIteratorCount

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

URLParameterList

public URLParameterList()

URLParameterList

public URLParameterList(@Nullable
                        List<? extends URLParameter> aOther)

Method Detail

add

@Nonnull
public URLParameterList add(@Nonnull @Nonempty
                                      String sName)

Add a parameter without a value

Parameters:

sName - The name of the parameter. May neither be null nor empty.

Returns:

this

add

@Nonnull
public URLParameterList add(@Nonnull
                                      Map.Entry<String,String> aEntry)

add

@Nonnull
public URLParameterList add(@Nonnull @Nonempty
                                      String sName,
                                      boolean bValue)

add

@Nonnull
public URLParameterList add(@Nonnull @Nonempty
                                      String sName,
                                      int nValue)

add

@Nonnull
public URLParameterList add(@Nonnull @Nonempty
                                      String sName,
                                      long nValue)

add

@Nonnull
public URLParameterList add(@Nonnull @Nonempty
                                      String sName,
                                      @Nonnull
                                      BigInteger aValue)

add

@Nonnull
public URLParameterList add(@Nonnull @Nonempty
                                      String sName,
                                      @Nonnull
                                      String sValue)

addAll

@Nonnull
public final URLParameterList addAll(@Nullable
                                               Map<String,String> aParams)

addAll

@Nonnull
public final URLParameterList addAll(@Nullable
                                               List<? extends URLParameter> aParams)

addAll

@Nonnull
public URLParameterList addAll(@Nonnull @Nonempty
                                         String sName,
                                         @Nullable
                                         String... aValues)

remove

@Nonnull
public URLParameterList remove(@Nullable
                                         String sName)

Remove all parameter with the given name.

Parameters:

sName - The key to remove

Returns:

this

remove

@Nonnull
public URLParameterList remove(@Nullable
                                         String sName,
                                         @Nullable
                                         String sValue)

Remove all parameter with the given name and value.

Parameters:

sName - The key to remove. May be null.

sValue - The value to be removed. May be null.

Returns:

this

contains

public boolean contains(@Nullable
                        String sName)

contains

public boolean contains(@Nullable
                        String sName,
                        @Nullable
                        String sValue)

getAllParamNames

@Nonnull
 @ReturnsMutableCopy
public ICommonsOrderedSet<String> getAllParamNames()

getAllParamValues

@Nonnull
 @ReturnsMutableCopy
public ICommonsList<String> getAllParamValues(@Nullable
                                                                              String sName)

getFirstParamValue

@Nullable
public String getFirstParamValue(@Nullable
                                            String sName)

Get the value of the first parameter with the provided name

Parameters:

sName - The parameter name to search

Returns:

null if no such parameter is present.

getAsMultiMap

@Nonnull
 @ReturnsMutableCopy
public IMultiMapListBased<String,String> getAsMultiMap()

Returns:

A new multi map (map from String to List of String) with all values. Order may be lost. Never null.

getClone

@Nonnull
 @ReturnsMutableCopy
public URLParameterList getClone()

Specified by:

getClone in interface ICloneable<ICommonsList<URLParameter>>

Overrides:

getClone in class CommonsArrayList<URLParameter>

Returns:

A 100% deep-copy of the implementing class.