Merge branch 'javadoc'
This commit is contained in:
commit
bed87bcbd3
17
pom.xml
17
pom.xml
@ -43,6 +43,19 @@
|
|||||||
|
|
||||||
<build>
|
<build>
|
||||||
<plugins>
|
<plugins>
|
||||||
|
<plugin>
|
||||||
|
<groupId>org.apache.felix</groupId>
|
||||||
|
<artifactId>maven-bundle-plugin</artifactId>
|
||||||
|
</plugin>
|
||||||
|
<plugin>
|
||||||
|
<groupId>org.apache.maven.plugins</groupId>
|
||||||
|
<artifactId>maven-javadoc-plugin</artifactId>
|
||||||
|
<version>2.10.4</version>
|
||||||
|
<configuration>
|
||||||
|
<show>private</show>
|
||||||
|
<nohelp>true</nohelp>
|
||||||
|
</configuration>
|
||||||
|
</plugin>
|
||||||
<plugin>
|
<plugin>
|
||||||
<groupId>org.apache.maven.plugins</groupId>
|
<groupId>org.apache.maven.plugins</groupId>
|
||||||
<artifactId>maven-surefire-plugin</artifactId>
|
<artifactId>maven-surefire-plugin</artifactId>
|
||||||
@ -52,10 +65,6 @@
|
|||||||
</includes>
|
</includes>
|
||||||
</configuration>
|
</configuration>
|
||||||
</plugin>
|
</plugin>
|
||||||
<plugin>
|
|
||||||
<groupId>org.apache.felix</groupId>
|
|
||||||
<artifactId>maven-bundle-plugin</artifactId>
|
|
||||||
</plugin>
|
|
||||||
</plugins>
|
</plugins>
|
||||||
|
|
||||||
<pluginManagement>
|
<pluginManagement>
|
||||||
|
|||||||
@ -111,8 +111,8 @@ public class CandidatePair
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* The {@link TransactionID} of the client transaction for a connectivity
|
* The {@link TransactionID} of the client transaction for a connectivity
|
||||||
* check over this pair in case it is in the {@link CandidatePairState#
|
* check over this pair in case it is in the
|
||||||
* IN_PROGRESS} state.
|
* {@link CandidatePairState#IN_PROGRESS} state.
|
||||||
*/
|
*/
|
||||||
private TransactionID connCheckTranID = null;
|
private TransactionID connCheckTranID = null;
|
||||||
|
|
||||||
|
|||||||
@ -79,11 +79,12 @@ class CandidatePrioritizer
|
|||||||
* <code>comp1.equals(comp2)</code> implies that
|
* <code>comp1.equals(comp2)</code> implies that
|
||||||
* <tt>sgn(comp1.compare(o1, o2))==sgn(comp2.compare(o1, o2))</tt> for
|
* <tt>sgn(comp1.compare(o1, o2))==sgn(comp2.compare(o1, o2))</tt> for
|
||||||
* every object reference <tt>o1</tt> and <tt>o2</tt>.<p>
|
* every object reference <tt>o1</tt> and <tt>o2</tt>.<p>
|
||||||
* <p/>
|
* <p>
|
||||||
* Note that it is <i>always</i> safe <i>not</i> to override
|
* Note that it is <i>always</i> safe <i>not</i> to override
|
||||||
* <tt>Object.equals(Object)</tt>. However, overriding this method may,
|
* <tt>Object.equals(Object)</tt>. However, overriding this method may,
|
||||||
* in some cases, improve performance by allowing programs to determine
|
* in some cases, improve performance by allowing programs to determine
|
||||||
* that two distinct Comparators impose the same order.
|
* that two distinct Comparators impose the same order.
|
||||||
|
* </p>
|
||||||
*
|
*
|
||||||
* @param obj the reference object with which to compare.
|
* @param obj the reference object with which to compare.
|
||||||
*
|
*
|
||||||
|
|||||||
@ -492,7 +492,7 @@ public class HostCandidateHarvester
|
|||||||
* @return the newly created <tt>DatagramSocket</tt>.
|
* @return the newly created <tt>DatagramSocket</tt>.
|
||||||
*
|
*
|
||||||
* @throws IllegalArgumentException if either <tt>minPort</tt> or
|
* @throws IllegalArgumentException if either <tt>minPort</tt> or
|
||||||
* <tt>maxPort</tt> is not a valid port number or if <tt>minPort >
|
* <tt>maxPort</tt> is not a valid port number or if <tt>minPort >
|
||||||
* maxPort</tt>.
|
* maxPort</tt>.
|
||||||
* @throws IOException if an error occurs while the underlying resolver lib
|
* @throws IOException if an error occurs while the underlying resolver lib
|
||||||
* is using sockets.
|
* is using sockets.
|
||||||
@ -577,7 +577,7 @@ public class HostCandidateHarvester
|
|||||||
* @return the newly created <tt>DatagramSocket</tt>.
|
* @return the newly created <tt>DatagramSocket</tt>.
|
||||||
*
|
*
|
||||||
* @throws IllegalArgumentException if either <tt>minPort</tt> or
|
* @throws IllegalArgumentException if either <tt>minPort</tt> or
|
||||||
* <tt>maxPort</tt> is not a valid port number or if <tt>minPort >
|
* <tt>maxPort</tt> is not a valid port number or if <tt>minPort >
|
||||||
* maxPort</tt>.
|
* maxPort</tt>.
|
||||||
* @throws IOException if an error occurs while the underlying resolver lib
|
* @throws IOException if an error occurs while the underlying resolver lib
|
||||||
* is using sockets.
|
* is using sockets.
|
||||||
|
|||||||
@ -1433,7 +1433,7 @@ public class StunCandidateHarvest
|
|||||||
* instance. The <tt>StunCandidateHarvest</tt> is referenced by a
|
* instance. The <tt>StunCandidateHarvest</tt> is referenced by a
|
||||||
* <tt>WeakReference</tt> in an attempt to reduce the risk that the
|
* <tt>WeakReference</tt> in an attempt to reduce the risk that the
|
||||||
* <tt>Thread</tt> may live regardless of the fact that the specified
|
* <tt>Thread</tt> may live regardless of the fact that the specified
|
||||||
* <tt>StunCandidateHarvest<tt> may no longer be reachable.
|
* <tt>StunCandidateHarvest</tt> may no longer be reachable.
|
||||||
*/
|
*/
|
||||||
private final WeakReference<StunCandidateHarvest> harvest;
|
private final WeakReference<StunCandidateHarvest> harvest;
|
||||||
|
|
||||||
|
|||||||
@ -45,7 +45,7 @@ public class EventDispatcher
|
|||||||
* The <tt>Map</tt> of <tt>EventDispatcher</tt>s which keep the
|
* The <tt>Map</tt> of <tt>EventDispatcher</tt>s which keep the
|
||||||
* registrations of STUN request and indication listeners registered for
|
* registrations of STUN request and indication listeners registered for
|
||||||
* STUN requests and indications from specific local
|
* STUN requests and indications from specific local
|
||||||
* <tt>TransportAddress<tt>es.
|
* <tt>TransportAddress</tt>es.
|
||||||
*/
|
*/
|
||||||
private final Map<TransportAddress, EventDispatcher> children
|
private final Map<TransportAddress, EventDispatcher> children
|
||||||
= new Hashtable<>();
|
= new Hashtable<>();
|
||||||
|
|||||||
@ -88,7 +88,7 @@ public class Logger
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Checks whether messages with a particular level should be logged
|
* Checks whether messages with a particular level should be logged
|
||||||
* according to the log level configured for this {@link Logger.}
|
* according to the log level configured for this {@link Logger}.
|
||||||
* @param level the log level.
|
* @param level the log level.
|
||||||
*/
|
*/
|
||||||
public boolean isLoggable(Level level)
|
public boolean isLoggable(Level level)
|
||||||
@ -131,7 +131,7 @@ public class Logger
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Logs a message with level {@link Level.SEVERE}, if that level is
|
* Logs a message with level {@link Level#SEVERE}, if that level is
|
||||||
* loggable according to the log level configured for this {@link Logger}.
|
* loggable according to the log level configured for this {@link Logger}.
|
||||||
* @param msg the message to log.
|
* @param msg the message to log.
|
||||||
*/
|
*/
|
||||||
@ -141,7 +141,7 @@ public class Logger
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Logs a message with level {@link Level.WARNING}, if that level is
|
* Logs a message with level {@link Level#WARNING}, if that level is
|
||||||
* loggable according to the log level configured for this {@link Logger}.
|
* loggable according to the log level configured for this {@link Logger}.
|
||||||
* @param msg the message to log.
|
* @param msg the message to log.
|
||||||
*/
|
*/
|
||||||
@ -151,7 +151,7 @@ public class Logger
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Logs a message with level {@link Level.INFO}, if that level is
|
* Logs a message with level {@link Level#INFO}, if that level is
|
||||||
* loggable according to the log level configured for this {@link Logger}.
|
* loggable according to the log level configured for this {@link Logger}.
|
||||||
* @param msg the message to log.
|
* @param msg the message to log.
|
||||||
*/
|
*/
|
||||||
@ -161,7 +161,7 @@ public class Logger
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Logs a message with level {@link Level.CONFIG}, if that level is
|
* Logs a message with level {@link Level#CONFIG}, if that level is
|
||||||
* loggable according to the log level configured for this {@link Logger}.
|
* loggable according to the log level configured for this {@link Logger}.
|
||||||
* @param msg the message to log.
|
* @param msg the message to log.
|
||||||
*/
|
*/
|
||||||
@ -171,7 +171,7 @@ public class Logger
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Logs a message with level {@link Level.FINE}, if that level is
|
* Logs a message with level {@link Level#FINE}, if that level is
|
||||||
* loggable according to the log level configured for this {@link Logger}.
|
* loggable according to the log level configured for this {@link Logger}.
|
||||||
* @param msg the message to log.
|
* @param msg the message to log.
|
||||||
*/
|
*/
|
||||||
@ -181,7 +181,7 @@ public class Logger
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Logs a message with level {@link Level.FINER}, if that level is
|
* Logs a message with level {@link Level#FINER}, if that level is
|
||||||
* loggable according to the log level configured for this {@link Logger}.
|
* loggable according to the log level configured for this {@link Logger}.
|
||||||
* @param msg the message to log.
|
* @param msg the message to log.
|
||||||
*/
|
*/
|
||||||
@ -191,7 +191,7 @@ public class Logger
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Logs a message with level {@link Level.FINEST}, if that level is
|
* Logs a message with level {@link Level#FINEST}, if that level is
|
||||||
* loggable according to the log level configured for this {@link Logger}.
|
* loggable according to the log level configured for this {@link Logger}.
|
||||||
* @param msg the message to log.
|
* @param msg the message to log.
|
||||||
*/
|
*/
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user