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
ICommonsOrderedMap<String,String>	directGetAllParams()
ICommonsOrderedMap<String,String>	getAllParams()
String	getAnchor()
int	getParamCount()
String	getPath()
default IURLProtocol	getProtocol()
boolean	hasAnchor()
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")
ICommonsOrderedMap<String,String> directGetAllParams()

Returns:

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

getAllParams

@Nonnull
 @ReturnsMutableCopy
ICommonsOrderedMap<String,String> getAllParams()

Returns:

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

hasAnchor

boolean hasAnchor()

Returns:

true if an anchor is present, false otherwise.

getAnchor

@Nullable
String getAnchor()

Returns:

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