Package com.helger.commons.url

Interface IURLParameterList<IMPLTYPE extends IURLParameterList<IMPLTYPE>>

Type Parameters:

IMPLTYPE - Implementation type

All Superinterfaces:

IGenericImplTrait<IMPLTYPE>

All Known Implementing Classes:

SimpleURL, URLParameterList

public interface IURLParameterList<IMPLTYPE extends IURLParameterList<IMPLTYPE>>
extends IGenericImplTrait<IMPLTYPE>

Internal helper interface for objects handling URL parameters

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
boolean	add(URLParameter aURLParam)
default IMPLTYPE	add(String sName)	Add a parameter without a value
default IMPLTYPE	add(String sName, boolean bValue)
default IMPLTYPE	add(String sName, int nValue)
default IMPLTYPE	add(String sName, long nValue)
default IMPLTYPE	add(String sName, String sValue)
default IMPLTYPE	add(String sName, BigInteger aValue)
default IMPLTYPE	add(Map.Entry<String,String> aEntry)
default IMPLTYPE	addAll(String sName, String... aValues)
default IMPLTYPE	addAll(List<? extends URLParameter> aParams)
default IMPLTYPE	addAll(Map<String,String> aParams)
default IMPLTYPE	addIf(String sName, String sValue, Predicate<? super String> aFilter)	Add the parameter of the passed value predicate evaluates to true.
default IMPLTYPE	addIfNotNull(String sName, String sValue)	Add the parameter of the passed value if it is not null.
default IMPLTYPE	addRandom(String sName)	Add a parameter with a random long value

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

Method Detail

add

boolean add(@Nonnull
            URLParameter aURLParam)

add

@Nonnull
default IMPLTYPE 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
default IMPLTYPE add(@Nonnull
                     Map.Entry<String,String> aEntry)

add

@Nonnull
default IMPLTYPE add(@Nonnull @Nonempty
                     String sName,
                     boolean bValue)

add

@Nonnull
default IMPLTYPE add(@Nonnull @Nonempty
                     String sName,
                     int nValue)

add

@Nonnull
default IMPLTYPE add(@Nonnull @Nonempty
                     String sName,
                     long nValue)

add

@Nonnull
default IMPLTYPE add(@Nonnull @Nonempty
                     String sName,
                     @Nullable
                     BigInteger aValue)

add

@Nonnull
default IMPLTYPE add(@Nonnull @Nonempty
                     String sName,
                     @Nullable
                     String sValue)

addRandom

@Nonnull
default IMPLTYPE addRandom(@Nonnull @Nonempty
                           String sName)

Add a parameter with a random long value

Parameters:

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

Returns:

this

Since:

9.0.0

addIf

@Nonnull
default IMPLTYPE addIf(@Nonnull @Nonempty
                       String sName,
                       @Nullable
                       String sValue,
                       @Nonnull
                       Predicate<? super String> aFilter)

Add the parameter of the passed value predicate evaluates to true.

Parameters:

sName - Parameter name. May neither be null nor empty.

sValue - Parameter value. May not be null if the predicate evaluates to true.

aFilter - The predicate to be evaluated on the value. May not be null.

Returns:

this for chaining

addIfNotNull

@Nonnull
default IMPLTYPE addIfNotNull(@Nonnull @Nonempty
                              String sName,
                              @Nullable
                              String sValue)

Add the parameter of the passed value if it is not null.

Parameters:

sName - Parameter name. May neither be null nor empty.

sValue - Parameter value. May be null.

Returns:

this for chaining

addAll

@Nonnull
default IMPLTYPE addAll(@Nullable
                        Map<String,String> aParams)

addAll

@Nonnull
default IMPLTYPE addAll(@Nullable
                        List<? extends URLParameter> aParams)

addAll

@Nonnull
default IMPLTYPE addAll(@Nonnull @Nonempty
                        String sName,
                        @Nullable
                        String... aValues)