Package com.helger.commons.url

Class SimpleURL

java.lang.Object

com.helger.commons.url.SimpleURL

All Implemented Interfaces:

ICloneable<SimpleURL>, IGenericImplTrait<SimpleURL>, ISimpleURL, IURLParameterList<SimpleURL>

@NotThreadSafe
public class SimpleURL
extends Object
implements ISimpleURL, ICloneable<SimpleURL>, IURLParameterList<SimpleURL>

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

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
SimpleURL()
SimpleURL(ISimpleURL aURL)
SimpleURL(String sHref)
SimpleURL(String sHref, Iterable<? extends URLParameter> aParams, String sAnchor)
SimpleURL(String sHref, Charset aCharset)
SimpleURL(String sHref, Charset aCharset, Iterable<? extends URLParameter> aParams, String sAnchor)
SimpleURL(String sHref, Charset aCharset, Map<String,String> aParams, String sAnchor)
SimpleURL(String sHref, Map<String,String> aParams)
SimpleURL(String sHref, Map<String,String> aParams, String sAnchor)
SimpleURL(URI aURI)
SimpleURL(URI aURI, Charset aCharset)
SimpleURL(URL aURL)
SimpleURL(URL aURL, Charset aCharset)

Method Summary

Modifier and Type	Method	Description
boolean	add(URLParameter aParam)
boolean	equals(Object o)
String	getAnchor()
SimpleURL	getClone()
String	getPath()
int	hashCode()
URLParameterList	params()
SimpleURL	setAnchor(String sAnchor)
SimpleURL	setPath(String sPath)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

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

getAsStringWithEncodedParameters, getAsStringWithEncodedParameters, getAsStringWithoutEncodedParameters, getAsURI, getAsURL, getProtocol, hasAnchor, hasAnchor, hasKnownProtocol

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

add, add, add, add, add, add, add, addAll, addAll, addAll, addIf, addIfNotNull, addRandom

Constructor Detail

SimpleURL

public SimpleURL()

SimpleURL

public SimpleURL(@Nonnull
                 URL aURL)

SimpleURL

public SimpleURL(@Nonnull
                 URL aURL,
                 @Nonnull
                 Charset aCharset)

SimpleURL

public SimpleURL(@Nonnull
                 URI aURI)

SimpleURL

public SimpleURL(@Nonnull
                 URI aURI,
                 @Nonnull
                 Charset aCharset)

SimpleURL

public SimpleURL(@Nonnull
                 String sHref)

SimpleURL

public SimpleURL(@Nonnull
                 String sHref,
                 @Nonnull
                 Charset aCharset)

SimpleURL

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

SimpleURL

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

SimpleURL

public SimpleURL(@Nonnull
                 String sHref,
                 @Nonnull
                 Charset aCharset,
                 @Nullable
                 Map<String,String> aParams,
                 @Nullable
                 String sAnchor)

SimpleURL

public SimpleURL(@Nonnull
                 String sHref,
                 @Nullable
                 Iterable<? extends URLParameter> aParams,
                 @Nullable
                 String sAnchor)

SimpleURL

public SimpleURL(@Nonnull
                 String sHref,
                 @Nonnull
                 Charset aCharset,
                 @Nullable
                 Iterable<? extends URLParameter> aParams,
                 @Nullable
                 String sAnchor)

SimpleURL

public SimpleURL(@Nonnull
                 ISimpleURL aURL)

Method Detail

getPath

@Nonnull
public final String getPath()

Specified by:

getPath in interface ISimpleURL

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").

setPath

@Nonnull
public SimpleURL setPath(@Nonnull
                         String sPath)

params

@Nonnull
@ReturnsMutableObject
public final URLParameterList params()

Specified by:

params in interface ISimpleURL

Returns:

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

add

public boolean add(@Nonnull
                   URLParameter aParam)

Specified by:

add in interface IURLParameterList<SimpleURL>

getAnchor

@Nullable
public final String getAnchor()

Specified by:

getAnchor in interface ISimpleURL

Returns:

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

setAnchor

@Nonnull
public SimpleURL setAnchor(@Nullable
                           String sAnchor)

getClone

@Nonnull
public SimpleURL getClone()

Specified by:

getClone in interface ICloneable<SimpleURL>

Returns:

A 100% deep-copy of the implementing class.

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