org.ice4j

Enum Transport

java.lang.Object

java.lang.Enum<Transport>

org.ice4j.Transport

All Implemented Interfaces:

Serializable, Comparable<Transport>

public enum Transport
extends Enum<Transport>

The Transport enumeration contains all currently known transports that ICE may be interacting with (but not necessarily support).

Author:

Emil Ivov

Enum Constant Summary

Enum Constants

Enum Constant and Description
DTLS Represents a datagram TLS (DTLS) transport.
SCTP Represents an SCTP transport.
SSLTCP Represents an Google's SSL TCP transport.
TCP Represents a TCP transport.
TLS Represents a TLS transport.
UDP Represents a UDP transport.

Field Summary

Fields

Modifier and Type	Field and Description
private String	transportName The name of this Transport.

Method Summary

Modifier and Type	Method and Description
static Transport	parse(String transportName) Returns a Transport instance corresponding to the specified transportName.
String	toString() Returns the name of this Transport (e.g.
static Transport	valueOf(String name) Returns the enum constant of this type with the specified name.
static Transport[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TCP

public static final Transport TCP

Represents a TCP transport.

UDP

public static final Transport UDP

Represents a UDP transport.

TLS

public static final Transport TLS

Represents a TLS transport.

DTLS

public static final Transport DTLS

Represents a datagram TLS (DTLS) transport.

SCTP

public static final Transport SCTP

Represents an SCTP transport.

SSLTCP

public static final Transport SSLTCP

Represents an Google's SSL TCP transport.

Field Detail

transportName

private final String transportName

The name of this Transport.

Method Detail

values

public static Transport[] 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 (Transport c : Transport.values())
    System.out.println(c);

Returns:

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

valueOf

public static Transport 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

toString

public String toString()

Returns the name of this Transport (e.g. "udp" or "tcp").

Overrides:

toString in class Enum<Transport>

Returns:

the name of this Transport (e.g. "udp" or "tcp").

parse

public static Transport parse(String transportName)
                       throws IllegalArgumentException

Returns a Transport instance corresponding to the specified transportName. For example, for name "udp", this method would return UDP.

Parameters:

transportName - the name that we'd like to parse.

Returns:

a Transport instance corresponding to the specified transportName.

Throws:

IllegalArgumentException - in case transportName is not a valid or currently supported transport.