org.elastos.carrier.session

Enum CandidateType

java.lang.Object

java.lang.Enum<CandidateType>

org.elastos.carrier.session.CandidateType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CandidateType>

public enum CandidateType
extends java.lang.Enum<CandidateType>

Carrier Stream's candidate type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Host Host candidate.
PeerReflexive Peer reflexive, only valid to ICE transport.
Relayed Relayed Candidate, only valid to ICE tranport.
ServerReflexive Server reflexive, only valid to ICE transport.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	format(CandidateType type) Get the fully formatized string of candidate type.
java.lang.String	toString() Get fully formatized string.
int	value() Get candidate type.
static CandidateType	valueOf(int type) Get candidate type
static CandidateType	valueOf(java.lang.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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Host

public static final CandidateType Host

Host candidate.

ServerReflexive

public static final CandidateType ServerReflexive

Server reflexive, only valid to ICE transport.

PeerReflexive

public static final CandidateType PeerReflexive

Peer reflexive, only valid to ICE transport.

Relayed

public static final CandidateType Relayed

Relayed Candidate, only valid to ICE tranport.

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(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

valueOf

public static CandidateType valueOf(int type)

Get candidate type

Parameters:

type - The value of candidate type.

Returns:

The close reason instance.

Throws:

java.lang.IllegalArgumentException

value

public int value()

Get candidate type.

Returns:

The candidate value.

format

public static java.lang.String format(CandidateType type)

Get the fully formatized string of candidate type.

Parameters:

type - The candidate type instance.

Returns:

The formatized string of candidate type.

toString

public java.lang.String toString()

Get fully formatized string.

Overrides:

toString in class java.lang.Enum<CandidateType>

Returns:

The fully formatized string.