Candidate (ice4j 2.0.0-SNAPSHOT API)

java.lang.Object
- org.ice4j.ice.Candidate<T>

All Implemented Interfaces:

Comparable<T>

Direct Known Subclasses:

LocalCandidate, RemoteCandidate
```
public abstract class Candidate<T extends Candidate<?>>
extends Object
implements Comparable<T>
```
A candidate represents a transport address that is a potential point of contact for receipt of media. Candidates also have properties - their type (server reflexive, relayed or host), priority, foundation, and base.
At this point this class only supports UDP candidates. Implementation of support for other transport protocols should mean that this class should become abstract and some transport specific components like to socket for example should be brought down the inheritance chain.

Author:

Emil Ivov, Lyubomir Marinov

Field Summary

Fields
Modifier and Type	Field and Description
`private T`	`base` The base of a server reflexive candidate is the host candidate from which it was derived.
`private CandidateType`	`candidateType` The type of this candidate.
`private String`	`foundation` An arbitrary string that is the same for two candidates that have the same type, base IP address, protocol (UDP, TCP, etc.) and STUN or TURN server.
`private TransportAddress`	`mappedAddress` The address that our TURN/STUN server returned as mapped if this is a relayed or a reflexive `Candidate`.
`static int`	`MAX_LOCAL_PREFERENCE` The maximum value for a candidate's local preference.
`static int`	`MAX_TYPE_PREFERENCE` The maximum value for a candidate's type preference.
`static int`	`MIN_LOCAL_PREFERENCE` The minimum value for a candidate's local preference.
`static int`	`MIN_TYPE_PREFERENCE` The minimum value for a candidate's type preference.
`private Component`	`parentComponent` The component that this candidate was created for.
`protected long`	`priority` A unique priority number that MUST be a positive integer between 1 and (2**32 - 1).
`private T`	`relatedCandidate` The related candidate: - null for a host candidate, - the base address (host candidate) for a reflexive candidate, - the mapped address (the mapped address of the TURN allocate response) for a relayed candidate.
`private TransportAddress`	`relayServerAddress` The address of the relay server (i.e.
`private TransportAddress`	`stunServerAddress` The address of the STUN server that was used to obtain this `Candidate`.
`private CandidateTcpType`	`tcpType` The `CandidateTcpType` for this `Candidate`.
`private TransportAddress`	`transportAddress` The transport address represented by this candidate.
`private boolean`	`virtual` Specifies whether the address associated with this candidate belongs to a VPN interface.

Constructor Summary

Constructors
Constructor and Description
`Candidate(TransportAddress transportAddress, Component parentComponent, CandidateType type, T relatedCandidate)` Creates a candidate for the specified transport address and properties.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canReach(Candidate<?> dst)` Determines whether this `Candidate`'s`TransportAddress` is theoretically usable for communication with that of `dst`.
`int`	`compareTo(T candidate)` Compares this `Candidate` with the specified one based on their priority and returns a negative integer, zero, or a positive integer if this `Candidate` has a lower, equal, or greater priority than the second.
`long`	`computeGTalkPriority()` Computes the priority for this `Candidate` based on the procedures defined in the Google Talk specification.
`long`	`computeGTalkPriorityForType(CandidateType candidateType)` Computes the priority this `Candidate` would have if it were of the specified `candidateType` and based on the procedures defined in the Google Talk specification.
`long`	`computePriority()` Computes the priority for this `Candidate` based on the procedures defined in the ICE specification..
`long`	`computePriorityForType(CandidateType candidateType)` Computes the priority this `Candidate` would have if it were of the specified `candidateType` and based on the procedures defined in the ICE specification.
`boolean`	`equals(Object obj)` Indicates whether some other Candidate is "equal to" this one.
`protected abstract T`	`findRelatedCandidate(TransportAddress relatedAddress)` Find the candidate corresponding to the address given in parameter.
`T`	`getBase()` Returns this `Candidate`'s base.
`protected int`	`getDefaultPreference()` Returns an integer indicating the preference that this `Candidate` should be considered with for becoming a default candidate.
`String`	`getFoundation()` Returns a `String` containing the foundation of this `Candidate`.
`TransportAddress`	`getHostAddress()` Returns this candidate host address.
`private int`	`getLocalPreference()` Calculates and returns the local preference for this `Candidate`
`TransportAddress`	`getMappedAddress()` Returns the address that was returned to us a "mapped address" from a TURN or a STUN server in case this `Candidate` is relayed or reflexive and `null` otherwise.
`Component`	`getParentComponent()` Returns a reference to the `Component` that this candidate belongs to.
`long`	`getPriority()` Returns the priority of this candidate.
`TransportAddress`	`getReflexiveAddress()` Returns this candidate reflexive address.
`TransportAddress`	`getRelatedAddress()` Returns a `TransportAddress` related to this `Candidate`.
`T`	`getRelatedCandidate()` Returns the related candidate corresponding to the address given in parameter: - null for a host candidate, - the base address (host candidate) for a reflexive candidate, - the mapped address (the mapped address of the TURN allocate response) for a relayed candidate.
`TransportAddress`	`getRelayedAddress()` Returns this candidate relayed address.
`TransportAddress`	`getRelayServerAddress()` Returns the address of the relay server (i.e.
`TransportAddress`	`getStunServerAddress()` Returns the address of the STUN server that was used to obtain this `Candidate` or `null` if this is not a server reflexive candidate.
`CandidateTcpType`	`getTcpType()` Gets the `CandidateTcpType` for this `Candidate`.
`Transport`	`getTransport()` Returns the `Transport` for this `Candidate`.
`TransportAddress`	`getTransportAddress()` Returns the transport address that this candidate is representing.
`CandidateType`	`getType()` Returns the type of this candidate which should be an instance of the `CandidateType` enumeration.
`private static int`	`getTypePreference(CandidateType candidateType)` Returns the type preference that should be used when computing priority for `Candidate`s of the specified `candidateType`.
`abstract String`	`getUfrag()` Get the local ufrag.
`int`	`hashCode()`
`abstract boolean`	`isDefault()` Determines whether this `Candidate` is the default one for its parent component.
`boolean`	`isVirtual()` Determines whether the address associated with this candidate belongs to a VPN interface.
`void`	`setBase(T base)` Sets this `Candidate`'s base.
`void`	`setCandidateType(CandidateType candidateType)` Sets the type of this candidate which should be an instance of the `CandidateType` enumeration.
`void`	`setFoundation(String foundation)` Sets this `Candidate`'s foundation.
`protected void`	`setMappedAddress(TransportAddress address)` Sets the address that was returned to us a "mapped address" from a TURN or a STUN server in case this `Candidate` is relayed.
`protected void`	`setRelayServerAddress(TransportAddress address)` Sets the address of the relay server (i.e.
`protected void`	`setStunServerAddress(TransportAddress address)` Sets the address of the STUN server that was used to obtain this `Candidate`.
`void`	`setTcpType(CandidateTcpType tcpType)` Sets the `CandidateTcpType` for this `Candidate`.
`void`	`setVirtual(boolean virtual)` Specifies whether the address associated with this candidate belongs to a VPN interface.
`String`	`toShortString()` Returns short `String` representation of this `Candidate`.
`String`	`toString()` Returns a `String` representation of this `Candidate` containing its `TransportAddress`, base, foundation, priority and whatever other properties may be relevant.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MAX_TYPE_PREFERENCE
```
public static final int MAX_TYPE_PREFERENCE
```
    The maximum value for a candidate's type preference.
    
    See Also:
    
    Constant Field Values
  - MIN_TYPE_PREFERENCE
```
public static final int MIN_TYPE_PREFERENCE
```
    The minimum value for a candidate's type preference.
    
    See Also:
    
    Constant Field Values
  - MAX_LOCAL_PREFERENCE
```
public static final int MAX_LOCAL_PREFERENCE
```
    The maximum value for a candidate's local preference.
    
    See Also:
    
    Constant Field Values
  - MIN_LOCAL_PREFERENCE
```
public static final int MIN_LOCAL_PREFERENCE
```
    The minimum value for a candidate's local preference.
    
    See Also:
    
    Constant Field Values
  - transportAddress
```
private final TransportAddress transportAddress
```
    The transport address represented by this candidate.
  - candidateType
```
private CandidateType candidateType
```
    The type of this candidate. At this point the ICE specification (and hence this implementation) only defines for candidate types: host, server reflexive, peer reflexive and relayed candidates. Others may be added in the future.
  - foundation
```
private String foundation
```
    An arbitrary string that is the same for two candidates that have the same type, base IP address, protocol (UDP, TCP, etc.) and STUN or TURN server. If any of these are different then the foundation will be different. Two candidate pairs with the same foundation pairs are likely to have similar network characteristics. Foundations are used in the frozen algorithm.
  - base
```
private T extends Candidate<?> base
```
    The base of a server reflexive candidate is the host candidate from which it was derived. A host candidate is also said to have a base, equal to that candidate itself. Similarly, the base of a relayed candidate is that candidate itself.
  - priority
```
protected long priority
```
    A unique priority number that MUST be a positive integer between 1 and (2**32 - 1). This priority will be set and used by ICE algorithms to determine the order of the connectivity checks and the relative preference for candidates.
  - virtual
```
private boolean virtual
```
    Specifies whether the address associated with this candidate belongs to a VPN interface. In many cases (e.g. when running on a 1.5 JVM) we won't be able to determine whether an interface is virtual or not. If we are however (that is when running a more recent JVM) we will reflect it in this property.
  - parentComponent
```
private final Component parentComponent
```
    The component that this candidate was created for. Every candidate is always associated with a specific component for which it is a candidate.
  - stunServerAddress
```
private TransportAddress stunServerAddress
```
    The address of the STUN server that was used to obtain this Candidate. Will be null if this is not a server reflexive candidate.
  - relayServerAddress
```
private TransportAddress relayServerAddress
```
    The address of the relay server (i.e. TURN, Jingle Nodes, ...) that was used to obtain this Candidate. Will be null if this is not a relayed candidate.
  - mappedAddress
```
private TransportAddress mappedAddress
```
    The address that our TURN/STUN server returned as mapped if this is a relayed or a reflexive Candidate. Will remain null if this is a host candidate.
  - relatedCandidate
```
private T extends Candidate<?> relatedCandidate
```
    The related candidate: - null for a host candidate, - the base address (host candidate) for a reflexive candidate, - the mapped address (the mapped address of the TURN allocate response) for a relayed candidate. - null for a peer reflexive candidate : there is no way to know the related address.
  - tcpType
```
private CandidateTcpType tcpType
```
    The CandidateTcpType for this Candidate.
- Constructor Detail
  - Candidate
```
public Candidate(TransportAddress transportAddress,
                 Component parentComponent,
                 CandidateType type,
                 T relatedCandidate)
```
    Creates a candidate for the specified transport address and properties.
    
    Parameters:
    
    transportAddress - the transport address that this candidate is encapsulating.
    
    parentComponent - the Component that this candidate belongs to.
    
    type - the CandidateType for this Candidate.
    
    relatedCandidate - The related candidate: - null for a host candidate, - the base address (host candidate) for a reflexive candidate, - the mapped address (the mapped address of the TURN allocate response) for a relayed candidate. - null for a peer reflexive candidate : there is no way to know the related address.
- Method Detail
  - getType
```
public CandidateType getType()
```
    Returns the type of this candidate which should be an instance of the CandidateType enumeration.
    
    Returns:
    
    a CandidateType indicating the type of this Candidate.
  - setCandidateType
```
public void setCandidateType(CandidateType candidateType)
```
    Sets the type of this candidate which should be an instance of the CandidateType enumeration.
    
    Parameters:
    
    candidateType - a CandidateType instance indicating the type of this Candidate.
  - getFoundation
```
public String getFoundation()
```
    Returns a String containing the foundation of this Candidate. A foundation is an arbitrary String that is the same for candidates that have the same type, base IP address, transport protocol (UDP, TCP, etc.) and STUN or TURN server. If any of these are different then the foundation will be different. Two candidate pairs with the same foundation pairs are likely to have similar network characteristics. Typically, candidates for RTP and RTCP streams will share the same foundation. Foundations are used in the frozen algorithm.
    
    Returns:
    
    the foundation of this Candidate.
  - setFoundation
```
public void setFoundation(String foundation)
```
    Sets this Candidate's foundation. A foundation is an arbitrary string that is always the same for candidates that have the same type, base IP address, protocol (UDP, TCP, etc.) and STUN or TURN server. If any of these are different then the foundation will be different. Two candidate pairs with the same foundation pairs are likely to have similar network characteristics. Foundations are used in the frozen algorithm.
    
    Parameters:
    
    foundation - the foundation of this Candidate.
  - getBase
```
public T getBase()
```
    Returns this Candidate's base. The base of a server reflexive candidate is the host candidate from which it was derived. A host candidate is also said to have a base, equal to that candidate itself. Similarly, the base of a relayed candidate is that candidate itself.
    
    Returns:
    
    the base Candidate for this Candidate.
  - setBase
```
public void setBase(T base)
```
    Sets this Candidate's base. The base of a server reflexive candidate is the host candidate from which it was derived. A host candidate is also said to have a base, equal to that candidate itself. Similarly, the base of a relayed candidate is that candidate itself.
    
    Parameters:
    
    base - the base Candidate of this Candidate.
  - getPriority
```
public long getPriority()
```
    Returns the priority of this candidate. Priority is a unique priority number that MUST be a positive integer between 1 and (2**32 - 1). This priority will be set and used by ICE algorithms to determine the order of the connectivity checks and the relative preference for candidates.
    
    Returns:
    
    a number between 1 and (2**32 - 1) indicating the priority of this candidate.
  - getTransportAddress
```
public TransportAddress getTransportAddress()
```
    Returns the transport address that this candidate is representing.
    
    Returns:
    
    the TransportAddress encapsulated by this Candidate.
  - equals
```
public boolean equals(Object obj)
               throws NullPointerException
```
    Indicates whether some other Candidate is "equal to" this one. We consider candidates equal when they are redundant, i.e.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the reference object with which to compare.
    
    Returns:
    
    true if this Candidate is equal to the obj argument; false otherwise.
    
    Throws:
    
    NullPointerException - if obj is null;
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getParentComponent
```
public Component getParentComponent()
```
    Returns a reference to the Component that this candidate belongs to.
    
    Returns:
    
    a reference to the Component that this candidate belongs to.
  - computePriority
```
public long computePriority()
```
    Computes the priority for this Candidate based on the procedures defined in the ICE specification..
    
    Returns:
    
    the priority for this Candidate as per the procedures defined in the ICE specification..
  - computeGTalkPriority
```
public long computeGTalkPriority()
```
    Computes the priority for this Candidate based on the procedures defined in the Google Talk specification.
    
    Returns:
    
    the priority for this Candidate as per the procedures defined in the ICE specification..
  - computePriorityForType
```
public long computePriorityForType(CandidateType candidateType)
```
    Computes the priority this Candidate would have if it were of the specified candidateType and based on the procedures defined in the ICE specification. The reason we need this method in addition to the computePriority() one is the need to be able to compute the priority of a peer reflexive candidate that we might learn during connectivity checks through this Candidate.
    
    Parameters:
    
    candidateType - the hypothetical type that we'd like to use when computing the priority for this Candidate.
    
    Returns:
    
    the priority this Candidate would have had if it were of the specified candidateType.
  - computeGTalkPriorityForType
```
public long computeGTalkPriorityForType(CandidateType candidateType)
```
    Computes the priority this Candidate would have if it were of the specified candidateType and based on the procedures defined in the Google Talk specification.
    
    Parameters:
    
    candidateType - the hypothetical type that we'd like to use when computing the priority for this Candidate.
    
    Returns:
    
    the priority this Candidate would have had if it were of the specified candidateType.
  - getTypePreference
```
private static int getTypePreference(CandidateType candidateType)
```
    Returns the type preference that should be used when computing priority for Candidates of the specified candidateType. The type preference MUST be an integer from 0 to 126 inclusive, and represents the preference for the type of the candidate (where the types are local, server reflexive, peer reflexive and relayed). A 126 is the highest preference, and a 0 is the lowest. Setting the value to a 0 means that candidates of this type will only be used as a last resort. The type preference MUST be identical for all candidates of the same type and MUST be different for candidates of different types. The type preference for peer reflexive candidates MUST be higher than that of server reflexive candidates.
    
    Parameters:
    
    candidateType - the CandidateType that we'd like to obtain a preference for.
    
    Returns:
    
    the type preference for this Candidate as per the procedures in the ICE specification.
  - getLocalPreference
```
private int getLocalPreference()
```
    Calculates and returns the local preference for this Candidate
    The local preference MUST be an integer from 0 to 65535 inclusive. It represents a preference for the particular IP address from which the candidate was obtained, in cases where an agent is multihomed. 65535 represents the highest preference, and a zero, the lowest. When there is only a single IP address, this value SHOULD be set to 65535. More generally, if there are multiple candidates for a particular component for a particular media stream which have the same type, the local preference MUST be unique for each one. In this specification, this only happens for multihomed hosts. If a host is multihomed because it is dual stacked, the local preference SHOULD be set equal to the precedence value for IP addresses described in RFC 3484.
    
    Returns:
    
    the local preference for this Candidate.
  - isVirtual
```
public boolean isVirtual()
```
    Determines whether the address associated with this candidate belongs to a VPN interface. In many cases (e.g. when running on a 1.5 JVM) we won't be able to determine whether an interface is virtual or not. If we are however (that is when running a more recent JVM) we will reflect it in this property. Note that the isVirtual property is not really an ICE concept. The ICE specs only mention it and give basic guidelines as to how it should be handled so other implementations maybe dealing with it differently.
    
    Returns:
    
    true if we were able to determine that the address associated with this Candidate comes from a virtual interface and false if otherwise.
  - setVirtual
```
public void setVirtual(boolean virtual)
```
    Specifies whether the address associated with this candidate belongs to a VPN interface. In many cases (e.g. when running on a 1.5 JVM) we won't be able to determine whether an interface is virtual or not. If we are however (that is when running a more recent JVM) we will reflect it in this property. Note that the isVirtual property is not really an ICE concept. The ICE specs only mention it and give basic guidelines as to how it should be handled so other implementations maybe dealing with it differently.
    
    Parameters:
    
    virtual - true if we were able to determine that the address associated with this Candidate comes from a virtual interface and false if otherwise.
  - getStunServerAddress
```
public TransportAddress getStunServerAddress()
```
    Returns the address of the STUN server that was used to obtain this Candidate or null if this is not a server reflexive candidate.
    
    Returns:
    
    the address of the STUN server that was used to obtain this Candidate or null if this is not a server reflexive candidate.
  - setStunServerAddress
```
protected void setStunServerAddress(TransportAddress address)
```
    Sets the address of the STUN server that was used to obtain this Candidate. Only makes sense if this is a relayed candidate.
    
    Parameters:
    
    address - the address of the STUN server that was used to obtain this Candidate or null if this is not a server reflexive candidate.
  - getRelayServerAddress
```
public TransportAddress getRelayServerAddress()
```
    Returns the address of the relay server (i.e. TURN, Jingle Nodes, ...) that was used to obtain this Candidate or null if this is not a relayed candidate.
    
    Returns:
    
    the address of the relay server that was used to obtain this Candidate or null if this is not a relayed candidate.
  - setRelayServerAddress
```
protected void setRelayServerAddress(TransportAddress address)
```
    Sets the address of the relay server (i.e. TURN, Jingle Nodes, ...) that was used to obtain this Candidate. Only makes sense if this is a relayed candidate.
    
    Parameters:
    
    address - the address of the relay server that was used to obtain this Candidate or null if this is not a relayed candidate.
  - getMappedAddress
```
public TransportAddress getMappedAddress()
```
    Returns the address that was returned to us a "mapped address" from a TURN or a STUN server in case this Candidate is relayed or reflexive and null otherwise. Note that the address returned by this method would be equal to the transport address for reflexive Candidates but not for relayed ones.
    
    Returns:
    
    the address that our TURN/STUN server returned as mapped if this is a relayed or a reflexive Candidate or null if this is a host candidate.
  - setMappedAddress
```
protected void setMappedAddress(TransportAddress address)
```
    Sets the address that was returned to us a "mapped address" from a TURN or a STUN server in case this Candidate is relayed.
    
    Parameters:
    
    address - the address that our TURN/STUN server returned as mapped if this is a relayed or a reflexive Candidate.
  - getTransport
```
public Transport getTransport()
```
    Returns the Transport for this Candidate. This is a convenience method only and it is equivalent to retrieving the transport of this Candidate's transport address.
    
    Returns:
    
    the Transport that this Candidate was obtained for/with.
  - getRelatedAddress
```
public TransportAddress getRelatedAddress()
```
    Returns a TransportAddress related to this Candidate. Related addresses are present for server reflexive, peer reflexive and relayed candidates. If a candidate is server or peer reflexive, the related address is equal to the base of this Candidate. If the candidate is relayed, the returned address is equal to the mapped address. If the candidate is a host candidate then the method returns null.
    
    Returns:
    
    the TransportAddress of the base if this is a reflexive candidate, the mapped address in the case of a relayed candidate, and null if this is a host or a remote candidate.
  - findRelatedCandidate
```
protected abstract T findRelatedCandidate(TransportAddress relatedAddress)
```
    Find the candidate corresponding to the address given in parameter.
    
    Parameters:
    
    relatedAddress - The related address: - null for a host candidate, - the base address (host candidate) for a reflexive candidate, - the mapped address (the mapped address of the TURN allocate response) for a relayed candidate. - null for a peer reflexive candidate : there is no way to know the related address.
    
    Returns:
    
    The related candidate corresponding to the address given in parameter: - null for a host candidate, - the base address (host candidate) for a reflexive candidate, - the mapped address (the mapped address of the TURN allocate response) for a relayed candidate. - null for a peer reflexive candidate : there is no way to know the related address.
  - toString
```
public String toString()
```
    Returns a String representation of this Candidate containing its TransportAddress, base, foundation, priority and whatever other properties may be relevant.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a String representation of this Candidate.
  - toShortString
```
public String toShortString()
```
    Returns short String representation of this Candidate.
    
    Returns:
    
    short String representation of this Candidate.
  - getDefaultPreference
```
protected int getDefaultPreference()
```
    Returns an integer indicating the preference that this Candidate should be considered with for becoming a default candidate.
    
    Returns:
    
    an integer indicating the preference that this Candidate should be considered with for becoming a default candidate.
  - canReach
```
public boolean canReach(Candidate<?> dst)
```
    Determines whether this Candidate'sTransportAddress is theoretically usable for communication with that of dst. Same as calling:
    getTransportAddress().canReach(dst.getTransportAddress())
    
    Parameters:
    
    dst - the Candidate that we'd like to check for reachability from this one.
    
    Returns:
    
    true if this Candidate shares the same Transport and family as dst or false otherwise.
  - isDefault
```
public abstract boolean isDefault()
```
    Determines whether this Candidate is the default one for its parent component.
    
    Returns:
    
    true if this Candidate is the default for its parent component and false if it isn't or if it has no parent Component yet.
  - getUfrag
```
public abstract String getUfrag()
```
    Get the local ufrag.
    
    Returns:
    
    local ufrag
  - getHostAddress
```
public TransportAddress getHostAddress()
```
    Returns this candidate host address.
    
    Returns:
    
    This candidate host address.
  - getReflexiveAddress
```
public TransportAddress getReflexiveAddress()
```
    Returns this candidate reflexive address.
    
    Returns:
    
    This candidate reflexive address. Null if this candidate does not use a peer/server reflexive address.
  - getRelayedAddress
```
public TransportAddress getRelayedAddress()
```
    Returns this candidate relayed address.
    
    Returns:
    
    This candidate relayed address. Null if this candidate does not use a relay.
  - getRelatedCandidate
```
public T getRelatedCandidate()
```
    Returns the related candidate corresponding to the address given in parameter: - null for a host candidate, - the base address (host candidate) for a reflexive candidate, - the mapped address (the mapped address of the TURN allocate response) for a relayed candidate. - null for a peer reflexive candidate : there is no way to know the related address.
    
    Returns:
    
    The related candidate corresponding to the address given in parameter: - null for a host candidate, - the base address (host candidate) for a reflexive candidate, - the mapped address (the mapped address of the TURN allocate response) for a relayed candidate. - null for a peer reflexive candidate : there is no way to know the related address.
  - compareTo
```
public int compareTo(T candidate)
```
    Compares this Candidate with the specified one based on their priority and returns a negative integer, zero, or a positive integer if this Candidate has a lower, equal, or greater priority than the second.
    
    Specified by:
    
    compareTo in interface Comparable<T extends Candidate<?>>
    
    Parameters:
    
    candidate - the second Candidate to compare.
    
    Returns:
    
    a negative integer, zero, or a positive integer as the first Candidate has a lower, equal, or greater priority than the second.
  - getTcpType
```
public CandidateTcpType getTcpType()
```
    Gets the CandidateTcpType for this Candidate.
    
    Returns:
    
    the CandidateTcpType for this Candidate.
  - setTcpType
```
public void setTcpType(CandidateTcpType tcpType)
```
    Sets the CandidateTcpType for this Candidate.
    
    Parameters:
    
    tcpType - the CandidateTcpType to set.

Class Candidate<T extends Candidate<?>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_TYPE_PREFERENCE

MIN_TYPE_PREFERENCE

MAX_LOCAL_PREFERENCE

MIN_LOCAL_PREFERENCE

transportAddress

candidateType

foundation

base

priority

virtual

parentComponent

stunServerAddress

relayServerAddress

mappedAddress

relatedCandidate

tcpType

Constructor Detail

Candidate

Method Detail

getType

setCandidateType

getFoundation

setFoundation

getBase

setBase

getPriority

getTransportAddress

equals

hashCode

getParentComponent

computePriority

computeGTalkPriority

computePriorityForType

computeGTalkPriorityForType

getTypePreference

getLocalPreference

isVirtual

setVirtual

getStunServerAddress

setStunServerAddress

getRelayServerAddress

setRelayServerAddress

getMappedAddress

setMappedAddress

getTransport

getRelatedAddress

findRelatedCandidate

toString

toShortString

getDefaultPreference

canReach

isDefault

getUfrag

getHostAddress

getReflexiveAddress

getRelayedAddress

getRelatedCandidate

compareTo

getTcpType

setTcpType