com.helger.commons.url

Interface ISimpleURL

All Superinterfaces:

IHasStringRepresentation, IURLData, Serializable

All Known Implementing Classes:

AbstractSimpleURL, ReadonlySimpleURL, SimpleURL

public interface ISimpleURL
extends IURLData, IHasStringRepresentation

Interface for a simple URL that works around the issues with the Java default URL.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMPTY_URL_STRING The string representing an empty URL.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAsString()
String	getAsStringWithEncodedParameters()
String	getAsStringWithEncodedParameters(Charset aCharset)
String	getAsStringWithEncodedParameters(String sCharset) Deprecated.
String	getParam(String sKey) Get the parameter value of the given key.

Methods inherited from interface com.helger.commons.url.IURLData

directGetParams, getAllParams, getAnchor, getParamCount, getPath, getProtocol, hasAnchor, hasKnownProtocol, hasParams

Field Detail

EMPTY_URL_STRING

static final String EMPTY_URL_STRING

The string representing an empty URL. Must contain at least one character.

See Also:

Constant Field Values

Method Detail

getParam

@Nullable
String getParam(@Nullable
                       String sKey)

Get the parameter value of the given key.

Parameters:

sKey - The key to check. May be null.

Returns:

null if no such parameter is present.

getAsString

@Nonnull
String getAsString()

Specified by:

getAsString in interface IHasStringRepresentation

Returns:

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

getAsStringWithEncodedParameters

@Nonnull
String getAsStringWithEncodedParameters()

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
String getAsStringWithEncodedParameters(@Nonnull@Nonempty
                                                         String sCharset)

Deprecated.

Parameters:

sCharset - 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
String getAsStringWithEncodedParameters(@Nonnull
                                              Charset aCharset)

Parameters:

aCharset - 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.