com.phloc.commons.url

Class AbstractSimpleURL

java.lang.Object

com.phloc.commons.url.AbstractSimpleURL

All Implemented Interfaces:

IHasStringRepresentation, ISimpleURL, IURLData, Serializable

Direct Known Subclasses:

ReadonlySimpleURL, SimpleURL

@NotThreadSafe
public abstract class AbstractSimpleURL
extends Object
implements ISimpleURL

Abstraction of the string parts of a URL but much simpler (and faster) than URL.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	m_aParams
protected String	m_sAnchor

Fields inherited from interface com.phloc.commons.url.ISimpleURL

EMPTY_URL_STRING

Constructor Summary

Constructors

Constructor and Description
AbstractSimpleURL()
AbstractSimpleURL(IURLData aURL)
AbstractSimpleURL(String sHref)
AbstractSimpleURL(String sHref, Map<String,String> aParams)
AbstractSimpleURL(String sHref, Map<String,String> aParams, String sAnchor)

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	directGetParams()
boolean	equals(Object o)
Map<String,String>	getAllParams()
String	getAnchor()
String	getAsString()
String	getAsStringWithEncodedParameters()
String	getAsStringWithEncodedParameters(Charset aParameterCharset)
String	getAsStringWithEncodedParameters(String sParameterCharset) Deprecated.
String	getParam(String sKey) Get the parameter value of the given key.
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

m_aParams

protected Map<String,String> m_aParams

m_sAnchor

protected String m_sAnchor

Constructor Detail

AbstractSimpleURL

public AbstractSimpleURL()

AbstractSimpleURL

public AbstractSimpleURL(@Nonnull
                 String sHref)

AbstractSimpleURL

public AbstractSimpleURL(@Nonnull
                 String sHref,
                 @Nullable
                 Map<String,String> aParams)

AbstractSimpleURL

public AbstractSimpleURL(@Nonnull
                 String sHref,
                 @Nullable
                 Map<String,String> aParams,
                 @Nullable
                 String sAnchor)

AbstractSimpleURL

public AbstractSimpleURL(@Nonnull
                 IURLData aURL)

Method Detail

getProtocol

@Nullable
public final IURLProtocol getProtocol()

Specified by:

getProtocol in interface IURLData

Returns:

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

hasKnownProtocol

public final boolean hasKnownProtocol()

Specified by:

hasKnownProtocol in interface IURLData

Returns:

true if the URL has a known protocol

getPath

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

Specified by:

hasParams in interface IURLData

Returns:

true if at least one parameter is present.

getParamCount

@Nonnegative
public final int getParamCount()

Specified by:

getParamCount in interface IURLData

Returns:

The number of parameters present. Always ≥ 0.

directGetParams

@Nonnull
@ReturnsMutableObject(reason="design")
public final Map<String,String> directGetParams()

Specified by:

directGetParams in interface IURLData

Returns:

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

getAllParams

@Nonnull
@ReturnsMutableCopy
public final 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 final boolean hasAnchor()

Specified by:

hasAnchor in interface IURLData

Returns:

true if an anchor is present

getAnchor

@Nullable
public final String getAnchor()

Specified by:

getAnchor in interface IURLData

Returns:

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

getParam

@Nullable
public final String getParam(@Nullable
                       String sKey)

Description copied from interface: ISimpleURL

Get the parameter value of the given key.

Specified by:

getParam in interface ISimpleURL

Parameters:

sKey - The key to check. May be null.

Returns:

null if no such parameter is present.

getAsString

@Nonnull
public final String getAsString()

Specified by:

getAsString in interface IHasStringRepresentation

Specified by:

getAsString in interface ISimpleURL

Returns:

The final string representation of this URL not encoding the request parameters.

getAsStringWithEncodedParameters

@Nonnull
public final String getAsStringWithEncodedParameters()

Specified by:

getAsStringWithEncodedParameters in interface ISimpleURL

Returns:

The final string representation of this URL with encoded URL parameter keys and values. Using the default URL charset as determined by URLUtils.CHARSET_URL.

getAsStringWithEncodedParameters

@Nonnull
@Deprecated
public final String getAsStringWithEncodedParameters(@Nonnull@Nonempty
                                                         String sParameterCharset)

Deprecated.

Specified by:

getAsStringWithEncodedParameters in interface ISimpleURL

Parameters:

sParameterCharset - The charset used for encoding the parameters. May neither be null nor empty.

Returns:

The final string representation of this URL with encoded URL parameter keys and values.

getAsStringWithEncodedParameters

@Nonnull
public final String getAsStringWithEncodedParameters(@Nonnull
                                              Charset aParameterCharset)

Specified by:

getAsStringWithEncodedParameters in interface ISimpleURL

Parameters:

aParameterCharset - The charset used for encoding the parameters. May not be null.

Returns:

The final string representation of this URL with encoded URL parameter keys and values.

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