com.phloc.commons.url

Class URLProtocol

java.lang.Object

com.phloc.commons.url.URLProtocol

All Implemented Interfaces:

IURLProtocol, Serializable

public class URLProtocol
extends Object
implements IURLProtocol

A simple implementation of the IURLProtocol interface.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
URLProtocol(String sProtocol, boolean bAllowsForQueryParameters)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowsForQueryParameters()
boolean	equals(Object o)
String	getProtocol()
String	getWithProtocol(String sURL) Prefix the passed URL with this protocol.
String	getWithProtocolIfNone(String sURL) Prefix the passed URL with this protocol if the URL does not have a protocol yet.
int	hashCode()
boolean	isUsedInURL(String sURL) Tells if the passed String (URL) belongs to this protocol.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

URLProtocol

public URLProtocol(@Nonnull@Nonempty
           String sProtocol,
           boolean bAllowsForQueryParameters)

Method Detail

getProtocol

@Nonnull
@Nonempty
public String getProtocol()

Specified by:

getProtocol in interface IURLProtocol

Returns:

The underlying text representation of the protocol.

isUsedInURL

public boolean isUsedInURL(@Nullable
                  String sURL)

Tells if the passed String (URL) belongs to this protocol.

Specified by:

isUsedInURL in interface IURLProtocol

Parameters:

sURL - The URL to check. May be null.

Returns:

true if the passed URL starts with this protocol

getWithProtocol

@Nullable
public String getWithProtocol(@Nullable
                              String sURL)

Description copied from interface: IURLProtocol

Prefix the passed URL with this protocol.

Specified by:

getWithProtocol in interface IURLProtocol

Parameters:

sURL - The URL to be prefixed. May be null.

Returns:

null if the parameter is null. The protocol is prepended independent whether the URL already has a protocol or not.

getWithProtocolIfNone

@Nullable
public String getWithProtocolIfNone(@Nullable
                                    String sURL)

Description copied from interface: IURLProtocol

Prefix the passed URL with this protocol if the URL does not have a protocol yet.

Specified by:

getWithProtocolIfNone in interface IURLProtocol

Parameters:

sURL - The URL to be prefixed. May be null.

Returns:

null if the parameter is null. The protocol is prepended if the URL not already has a protocol.

allowsForQueryParameters

public boolean allowsForQueryParameters()

Specified by:

allowsForQueryParameters in interface IURLProtocol

Returns:

true if this protocol can handle HTTP query parameters (?x=y&z=1)

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