com.helger.commons.url

Enum EURLProtocol

java.lang.Object

java.lang.Enum<EURLProtocol>

com.helger.commons.url.EURLProtocol

All Implemented Interfaces:

IURLProtocol, Serializable, Comparable<EURLProtocol>

public enum EURLProtocol
extends Enum<EURLProtocol>
implements IURLProtocol

Specifies a list of known protocols.
Should be extended to the list defined at the IANA

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
CALLTO Skype.
DATA Embedded data (RFC2397).
FILE Local file (RFC1738).
FTP ftp (RFC1738).
FTPS ftps.
GEO geographic coordinates (RFC5870).
GOPHER Gopher (RFC4266).
HTTP http (RFC2616).
HTTPS https (RFC2818).
JAVASCRIPT JavaScript
LDAP LDAP (RFC4516).
MAILTO Email (RFC6068).
MMS MS Media Server.
NEWS News (RFC5538).
NNTP NNTP (RFC5538).
POP POP3 (RFC2384).
RSYNC RSync.
RTMP RTMP
RTSP Real time streaming protocol (RFC2326).
RTSPU Real time streaming protocol (unreliable) (RFC2326).
SCP scp.
SFTP sftp.
SHTTP shttp (RFC2660).
SIP session initiation protocol (RFC3261).
SIPS secure session initiation protocol (RFC3261).
TEL Telephone (RFC3966).
TELNET Reference to interactive sessions (RFC4248).
URN URN (RFC2141)
WS Web socket (RFC6455).
WSS Encrypted web socket (RFC6455).

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowsForQueryParameters()
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.
boolean	isUsedInURL(String sURL) Tells if the passed String (URL) belongs to this protocol.
static EURLProtocol	valueOf(String name) Returns the enum constant of this type with the specified name.
static EURLProtocol[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HTTP

public static final EURLProtocol HTTP

http (RFC2616).

HTTPS

public static final EURLProtocol HTTPS

https (RFC2818).

FILE

public static final EURLProtocol FILE

Local file (RFC1738).

FTP

public static final EURLProtocol FTP

ftp (RFC1738).

CALLTO

public static final EURLProtocol CALLTO

Skype.

DATA

public static final EURLProtocol DATA

Embedded data (RFC2397).

FTPS

public static final EURLProtocol FTPS

ftps.

GEO

public static final EURLProtocol GEO

geographic coordinates (RFC5870).

GOPHER

public static final EURLProtocol GOPHER

Gopher (RFC4266).

JAVASCRIPT

public static final EURLProtocol JAVASCRIPT

JavaScript

LDAP

public static final EURLProtocol LDAP

LDAP (RFC4516).

MAILTO

public static final EURLProtocol MAILTO

Email (RFC6068).

MMS

public static final EURLProtocol MMS

MS Media Server.

NEWS

public static final EURLProtocol NEWS

News (RFC5538).

NNTP

public static final EURLProtocol NNTP

NNTP (RFC5538).

POP

public static final EURLProtocol POP

POP3 (RFC2384).

RSYNC

public static final EURLProtocol RSYNC

RSync.

RTMP

public static final EURLProtocol RTMP

RTMP

RTSP

public static final EURLProtocol RTSP

Real time streaming protocol (RFC2326).

RTSPU

public static final EURLProtocol RTSPU

Real time streaming protocol (unreliable) (RFC2326).

SCP

public static final EURLProtocol SCP

scp.

SFTP

public static final EURLProtocol SFTP

sftp.

SHTTP

public static final EURLProtocol SHTTP

shttp (RFC2660).

SIP

public static final EURLProtocol SIP

session initiation protocol (RFC3261).

SIPS

public static final EURLProtocol SIPS

secure session initiation protocol (RFC3261).

TEL

public static final EURLProtocol TEL

Telephone (RFC3966).

TELNET

public static final EURLProtocol TELNET

Reference to interactive sessions (RFC4248).

URN

public static final EURLProtocol URN

URN (RFC2141)

WS

public static final EURLProtocol WS

Web socket (RFC6455).

WSS

public static final EURLProtocol WSS

Encrypted web socket (RFC6455).

Method Detail

values

public static EURLProtocol[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EURLProtocol c : EURLProtocol.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EURLProtocol valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

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)