com.helger.commons.url

Class URLData

java.lang.Object

com.helger.commons.url.URLData

All Implemented Interfaces:

IURLData, Serializable

@Immutable
public class URLData
extends Object
implements IURLData

Default implementation of the IURLData interface.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static URLData	EMPTY_URL_DATA The string representing an empty URL.

Constructor Summary

Constructors

Constructor and Description
URLData(String sPath)
URLData(String sPath, URLParameterList aParams)
URLData(String sPath, URLParameterList aParams, String sAnchor)

Method Summary

Modifier and Type	Method and Description
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()
String	getParam(String sName) Get the first parameter value of the given key.
int	getParamCount()
String	getPath()
int	hashCode()
boolean	hasParams()
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.IURLData

getProtocol, hasAnchor, hasAnchor, hasKnownProtocol

Field Detail

EMPTY_URL_DATA

public static final URLData EMPTY_URL_DATA

The string representing an empty URL. Must contain at least one character.

Constructor Detail

URLData

public URLData(@Nonnull
               String sPath)

URLData

public URLData(@Nonnull
               String sPath,
               @Nullable
               URLParameterList aParams)

URLData

public URLData(@Nonnull
               String sPath,
               @Nullable
               URLParameterList aParams,
               @Nullable
               String sAnchor)

Method Detail

getPath

@Nonnull
public 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 boolean hasParams()

Specified by:

hasParams in interface IURLData

Returns:

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

getParamCount

@Nonnegative
public 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

@Nullable
 @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.

getAnchor

@Nullable
public String getAnchor()

Specified by:

getAnchor in interface IURLData

Returns:

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

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