com.phloc.commons.url

Interface IURLData

All Superinterfaces:

Serializable

All Known Subinterfaces:

ISimpleURL

All Known Implementing Classes:

AbstractSimpleURL, ReadonlySimpleURL, 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

Methods

Modifier and Type	Method and Description
Map<String,String>	directGetParams()
Map<String,String>	getAllParams()
String	getAnchor()
int	getParamCount()
String	getPath()
IURLProtocol	getProtocol()
boolean	hasAnchor()
boolean	hasKnownProtocol()
boolean	hasParams()

Method Detail

getProtocol

@Nullable
IURLProtocol getProtocol()

Returns:

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

hasKnownProtocol

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)

hasParams

boolean hasParams()

Returns:

true if at least one parameter is present.

getParamCount

@Nonnegative
int getParamCount()

Returns:

The number of parameters present. Always ≥ 0.

directGetParams

@Nullable
@ReturnsMutableObject(reason="design")
Map<String,String> directGetParams()

Returns:

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

getAllParams

@Nonnull
@ReturnsMutableCopy
Map<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

getAnchor

@Nullable
String getAnchor()

Returns:

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