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, Map<String,String> aParams)
URLData(String sPath, Map<String,String> aParams, String sAnchor)

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	directGetAllParams()
boolean	equals(Object o)
Map<String,String>	getAllParams()
String	getAnchor()
int	getParamCount()
String	getPath()
IURLProtocol	getProtocol()
boolean	hasAnchor()
int	hashCode()
boolean	hasKnownProtocol()
boolean	hasParams()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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
       Map<String,String> aParams)

URLData

public URLData(@Nonnull
       String sPath,
       @Nullable
       Map<String,String> aParams,
       @Nullable
       String sAnchor)

Method Detail

getProtocol

@Nullable
public IURLProtocol getProtocol()

Specified by:

getProtocol in interface IURLData

Returns:

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

hasKnownProtocol

public boolean hasKnownProtocol()

Specified by:

hasKnownProtocol in interface IURLData

Returns:

true if the URL has a known protocol

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)

hasParams

public boolean hasParams()

Specified by:

hasParams in interface IURLData

Returns:

true if at least one parameter is present.

getParamCount

@Nonnegative
public int getParamCount()

Specified by:

getParamCount in interface IURLData

Returns:

The number of parameters present. Always ≥ 0.

directGetAllParams

@Nullable
@ReturnsMutableObject(value="Performance reasons")
public Map<String,String> directGetAllParams()

Specified by:

directGetAllParams in interface IURLData

Returns:

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

getAllParams

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

hasAnchor

public boolean hasAnchor()

Specified by:

hasAnchor in interface IURLData

Returns:

true if an anchor is present

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