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, Map<String,String> aParams)
SimpleURL(String sHref, Charset aCharset, Map<String,String> 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(String sKey) Add a parameter without a value
SimpleURL	add(String sKey, BigInteger aValue)
SimpleURL	add(String sKey, boolean bValue)
SimpleURL	add(String sKey, int nValue)
SimpleURL	add(String sKey, long nValue)
SimpleURL	add(String sKey, String sValue)
SimpleURL	addAll(Map<String,String> aParams)
SimpleURL	addIf(String sKey, String sValue, Predicate<String> aFilter) Add the parameter of the passed value predicate evaluates to true.
SimpleURL	addIfNonNull(String sKey, String sValue)
ICommonsOrderedMap<String,String>	directGetAllParams()
boolean	equals(Object o)
ICommonsOrderedMap<String,String>	getAllParams()
String	getAnchor()
SimpleURL	getClone()
String	getParam(String sKey) Get the parameter value of the given key.
int	getParamCount()
String	getPath()
boolean	hasAnchor()
int	hashCode()
boolean	hasParams()
SimpleURL	remove(String sKey) Remove the parameter with the given key.
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, 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,
                 @Nonnull
                 Charset aCharset,
                 @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
                 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.

getParam

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

Description copied from interface: ISimpleURL

Get the parameter value of the given key.

Specified by:

getParam in interface ISimpleURL

Parameters:

sKey - The key to check. May be null.

Returns:

null if no such parameter is present.

directGetAllParams

@Nonnull
 @ReturnsMutableObject(value="design")
public final ICommonsOrderedMap<String,String> directGetAllParams()

Specified by:

directGetAllParams in interface IURLData

Returns:

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

getAllParams

@Nonnull
 @ReturnsMutableCopy
public final ICommonsOrderedMap<String,String> 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 SimpleURL add(@Nonnull @Nonempty
                               String sKey)

Add a parameter without a value

Parameters:

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

Returns:

this

add

@Nonnull
public SimpleURL add(@Nonnull @Nonempty
                               String sKey,
                               @Nonnull
                               String sValue)

add

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

add

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

add

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

add

@Nonnull
public SimpleURL add(@Nonnull @Nonempty
                               String sKey,
                               @Nonnull
                               BigInteger aValue)

addIfNonNull

@Nonnull
public SimpleURL addIfNonNull(@Nonnull @Nonempty
                                        String sKey,
                                        @Nullable
                                        String sValue)

addIf

@Nonnull
public SimpleURL addIf(@Nonnull @Nonempty
                                 String sKey,
                                 @Nullable
                                 String sValue,
                                 @Nonnull
                                 Predicate<String> aFilter)

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

Parameters:

sKey - 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 SimpleURL addAll(@Nullable
                                  Map<String,String> aParams)

remove

@Nonnull
public SimpleURL remove(@Nullable
                                  String sKey)

Remove the parameter with the given key.

Parameters:

sKey - The key to remove

Returns:

this

hasAnchor

public final boolean hasAnchor()

Specified by:

hasAnchor in interface IURLData

Returns:

true if an anchor is present, false otherwise.

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