com.helger.commons.url

Class SimpleURL

java.lang.Object

com.helger.commons.url.SimpleURL

All Implemented Interfaces:

ICloneable<SimpleURL>, ISimpleURL, IURLData, Serializable

@NotThreadSafe
public class SimpleURL
extends Object
implements ISimpleURL, ICloneable<SimpleURL>

Abstraction of the string parts of a URL but much simpler (and faster) than URL.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SimpleURL()
SimpleURL(IURLData aURL)
SimpleURL(String sHref)
SimpleURL(String sHref, Charset aCharset)
SimpleURL(String sHref, Charset aCharset, Iterable<? extends URLParameter> aParams, String sAnchor)
SimpleURL(String sHref, Charset aCharset, Map<String,String> aParams, String sAnchor)
SimpleURL(String sHref, Iterable<? extends URLParameter> aParams, String sAnchor)
SimpleURL(String sHref, Map<String,String> aParams)
SimpleURL(String sHref, Map<String,String> aParams, String sAnchor)
SimpleURL(URL aURL)
SimpleURL(URL aURL, Charset aCharset)

Method Summary

Modifier and Type	Method and Description
SimpleURL	add(Map.Entry<String,String> aEntry)
SimpleURL	add(String sName) Add a parameter without a value
SimpleURL	add(String sName, BigInteger aValue)
SimpleURL	add(String sName, boolean bValue)
SimpleURL	add(String sName, int nValue)
SimpleURL	add(String sName, long nValue)
SimpleURL	add(String sName, String sValue)
SimpleURL	add(URLParameter aParam)
SimpleURL	addAll(Iterable<? extends URLParameter> aParams)
SimpleURL	addAll(Map<String,String> aParams)
SimpleURL	addIf(String sName, String sValue, Predicate<String> aFilter) Add the parameter of the passed value predicate evaluates to true.
SimpleURL	addIfNotNull(String sName, String sValue) Add the parameter of the passed value if it is not null.
boolean	containsParam(String sName) Check if at least one parameter with the given name is contained.
URLParameterList	directGetAllParams()
boolean	equals(Object o)
URLParameterList	getAllParams()
ICommonsList<String>	getAllParams(String sName) Get all parameter values of the passed key.
String	getAnchor()
SimpleURL	getClone()
String	getParam(String sName) Get the first parameter value of the given key.
int	getParamCount()
String	getPath()
int	hashCode()
boolean	hasParams()
SimpleURL	remove(String sName) Remove all parameters with the given name.
SimpleURL	remove(String sName, String sValue) Remove all parameter with the given name.
SimpleURL	setAnchor(String sAnchor)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.url.ISimpleURL

getAsStringWithEncodedParameters, getAsStringWithEncodedParameters, getAsStringWithoutEncodedParameters

Methods inherited from interface com.helger.commons.url.IURLData

getProtocol, hasAnchor, hasAnchor, hasKnownProtocol

Constructor Detail

SimpleURL

public SimpleURL()

SimpleURL

public SimpleURL(@Nonnull
                 URL aURL)

SimpleURL

public SimpleURL(@Nonnull
                 URL aURL,
                 @Nonnull
                 Charset aCharset)

SimpleURL

public SimpleURL(@Nonnull
                 String sHref)

SimpleURL

public SimpleURL(@Nonnull
                 String sHref,
                 @Nonnull
                 Charset aCharset)

SimpleURL

public SimpleURL(@Nonnull
                 String sHref,
                 @Nullable
                 Map<String,String> aParams)

SimpleURL

public SimpleURL(@Nonnull
                 String sHref,
                 @Nullable
                 Map<String,String> aParams,
                 @Nullable
                 String sAnchor)

SimpleURL

public SimpleURL(@Nonnull
                 String sHref,
                 @Nonnull
                 Charset aCharset,
                 @Nullable
                 Map<String,String> aParams,
                 @Nullable
                 String sAnchor)

SimpleURL

public SimpleURL(@Nonnull
                 String sHref,
                 @Nullable
                 Iterable<? extends URLParameter> aParams,
                 @Nullable
                 String sAnchor)

SimpleURL

public SimpleURL(@Nonnull
                 String sHref,
                 @Nonnull
                 Charset aCharset,
                 @Nullable
                 Iterable<? extends URLParameter> aParams,
                 @Nullable
                 String sAnchor)

SimpleURL

public SimpleURL(@Nonnull
                 IURLData aURL)

Method Detail

getPath

@Nonnull
public final String getPath()

Specified by:

getPath in interface IURLData

Returns:

The path part of the URL (everything before the "?" and the "#", incl. the protocol). Never null but maybe empty (e.g. for "?x=y").

hasParams

public final boolean hasParams()

Specified by:

hasParams in interface IURLData

Returns:

true if at least one parameter is present, false otherwise.

getParamCount

@Nonnegative
public final int getParamCount()

Specified by:

getParamCount in interface IURLData

Returns:

The number of parameters present. Always ≥ 0.

containsParam

public final boolean containsParam(@Nullable
                                   String sName)

Description copied from interface: IURLData

Check if at least one parameter with the given name is contained.

Specified by:

containsParam in interface IURLData

Parameters:

sName - The name to check. May be null.

Returns:

true if at least one parameter with this name is present, false otherwise.

getParam

@Nullable
public final String getParam(@Nullable
                                        String sName)

Description copied from interface: IURLData

Get the first parameter value of the given key.

Specified by:

getParam in interface IURLData

Parameters:

sName - The key to check. May be null.

Returns:

null if no such parameter is present.

getAllParams

@Nullable
public final ICommonsList<String> getAllParams(@Nullable
                                                          String sName)

Description copied from interface: IURLData

Get all parameter values of the passed key.

Specified by:

getAllParams in interface IURLData

Parameters:

sName - The key to check. May be null.

Returns:

A non-null but maybe empty list.

directGetAllParams

@Nonnull
 @ReturnsMutableObject(value="design")
public final URLParameterList directGetAllParams()

Specified by:

directGetAllParams in interface IURLData

Returns:

A map of all query string parameters. May be null.

getAllParams

@Nonnull
 @ReturnsMutableCopy
public final URLParameterList getAllParams()

Specified by:

getAllParams in interface IURLData

Returns:

A map of all query string parameters in the order they were passed on. Never null.

add

@Nonnull
public final SimpleURL 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 final SimpleURL add(@Nonnull
                                     Map.Entry<String,String> aEntry)

add

@Nonnull
public final SimpleURL add(@Nonnull @Nonempty
                                     String sName,
                                     @Nullable
                                     String sValue)

add

@Nonnull
public final SimpleURL add(@Nonnull
                                     URLParameter aParam)

add

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

add

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

add

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

add

@Nonnull
public final SimpleURL add(@Nonnull @Nonempty
                                     String sName,
                                     @Nullable
                                     BigInteger aValue)

addIfNotNull

@Nonnull
public final SimpleURL 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

addIf

@Nonnull
public final SimpleURL addIf(@Nonnull @Nonempty
                                       String sName,
                                       @Nullable
                                       String sValue,
                                       @Nonnull
                                       Predicate<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

addAll

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

addAll

@Nonnull
public final SimpleURL addAll(@Nullable
                                        Iterable<? extends URLParameter> aParams)

remove

@Nonnull
public SimpleURL remove(@Nullable
                                  String sName)

Remove all parameters with the given name.

Parameters:

sName - The key to remove. May be null in which case nothing happens.

Returns:

this

remove

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

Remove all parameter with the given name.

Parameters:

sName - The key to remove. May be null.

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

Returns:

this

getAnchor

@Nullable
public final String getAnchor()

Specified by:

getAnchor in interface IURLData

Returns:

The name of the anchor (everything after the "#") or null if none is defined.

setAnchor

@Nonnull
public SimpleURL setAnchor(@Nullable
                                     String sAnchor)

getClone

@Nonnull
public SimpleURL getClone()

Specified by:

getClone in interface ICloneable<SimpleURL>

Returns:

A 100% deep-copy of the implementing class.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object