com.helger.commons.url

Interface IURLData

All Superinterfaces:

Serializable

All Known Subinterfaces:

ISimpleURL

All Known Implementing Classes:

SimpleURL, URLData

public interface IURLData
extends Serializable

Base interface representing the basic elements of a URL from a high level perspective.

Author:

Philip Helger

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()
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()
default IURLProtocol	getProtocol()
default boolean	hasAnchor()
default boolean	hasAnchor(String sAnchor) Check if this URL has an anchor with the passed name.
default boolean	hasKnownProtocol()
boolean	hasParams()

Method Detail

getProtocol

@Nullable
default IURLProtocol getProtocol()

Returns:

The protocol used. May be null for an unknown protocol.

hasKnownProtocol

default boolean hasKnownProtocol()

Returns:

true if the URL has a known protocol

getPath

@Nonnull
String getPath()

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

boolean hasParams()

Returns:

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

getParamCount

@Nonnegative
int getParamCount()

Returns:

The number of parameters present. Always ≥ 0.

directGetAllParams

@Nullable
 @ReturnsMutableObject(value="design")
URLParameterList directGetAllParams()

Returns:

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

getAllParams

@Nonnull
 @ReturnsMutableCopy
URLParameterList getAllParams()

Returns:

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

containsParam

boolean containsParam(@Nullable
                      String sName)

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

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
String getParam(@Nullable
                           String sName)

Get the first parameter value of the given key.

Parameters:

sName - The key to check. May be null.

Returns:

null if no such parameter is present.

getAllParams

@Nonnull
 @ReturnsMutableCopy
ICommonsList<String> getAllParams(@Nullable
                                                                  String sName)

Get all parameter values of the passed key.

Parameters:

sName - The key to check. May be null.

Returns:

A non-null but maybe empty list.

getAnchor

@Nullable
String getAnchor()

Returns:

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

hasAnchor

default boolean hasAnchor()

Returns:

true if an anchor is present, false otherwise.

hasAnchor

default boolean hasAnchor(@Nullable
                          String sAnchor)

Check if this URL has an anchor with the passed name.

Parameters:

sAnchor - The anchor name to check.

Returns:

true if the passed anchor is present.