org.restcomm.media.ice

Enum CandidateType

java.lang.Object

java.lang.Enum<CandidateType>

org.restcomm.media.ice.CandidateType

All Implemented Interfaces:

Serializable, Comparable<CandidateType>

public enum CandidateType
extends Enum<CandidateType>

The ICE specification defines for candidate types: host, server reflexive, peer reflexive and relayed candidates.

Author:

Henrique Rosa

See Also:

RFC5245

Enum Constant Summary

Enum Constants

Enum Constant and Description
HOST
PRFLX
RELAY
SRFLX

Method Summary

Methods

Modifier and Type	Method and Description
static int	count()
static CandidateType	fromDescription(String description)
String	getDescription()
int	getPreference()
static CandidateType	valueOf(String name) Returns the enum constant of this type with the specified name.
static CandidateType[]	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

HOST

public static final CandidateType HOST

PRFLX

public static final CandidateType PRFLX

SRFLX

public static final CandidateType SRFLX

RELAY

public static final CandidateType RELAY

Method Detail

values

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

Returns:

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

valueOf

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

getDescription

public String getDescription()

getPreference

public int getPreference()

fromDescription

public static CandidateType fromDescription(String description)

count

public static int count()