Javadoc updates

This commit is contained in:
Joakim Erdfelt 2015-12-18 11:02:32 -07:00
parent 47eb7f02a9
commit 24b9d39c0f
3 changed files with 18 additions and 5 deletions

View File

@ -19,6 +19,7 @@
package org.eclipse.jetty.util;
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;
import java.util.function.Predicate;
@ -65,9 +66,12 @@ public class IncludeExclude<ITEM>
}
/**
* Construct an IncludeExclude
* Construct an IncludeExclude.
* <p>
* If the {@link Set} class also implements {@link Predicate}, then that Predicate is
* used to match against the set, otherwise a simple {@link Set#contains(Object)} test is used.
* @param setClass The type of {@link Set} to using internally
* @param predicate A predicate function to test if a passed ITEM is matched by the passed SET}
* @param <SET> the {@link Set} type
*/
@SuppressWarnings("unchecked")
public <SET extends Set<ITEM>> IncludeExclude(Class<SET> setClass)
@ -99,12 +103,18 @@ public class IncludeExclude<ITEM>
* Construct an IncludeExclude
*
* @param includeSet the Set of items that represent the included space
* @param includePredicate the Predicate for included item testing (null for simple {@link Set#contains(Object)} test)
* @param includePredicate the Predicate for included item testing
* @param excludeSet the Set of items that represent the excluded space
* @param excludePredicate the Predicate for excluded item testing (null for simple {@link Set#contains(Object)} test)
* @param excludePredicate the Predicate for excluded item testing
* @param <SET> the {@link Set} type
*/
public <SET extends Set<ITEM>> IncludeExclude(Set<ITEM> includeSet, Predicate<ITEM> includePredicate, Set<ITEM> excludeSet, Predicate<ITEM> excludePredicate)
{
Objects.requireNonNull(includeSet,"Include Set");
Objects.requireNonNull(includePredicate,"Include Predicate");
Objects.requireNonNull(excludeSet,"Exclude Set");
Objects.requireNonNull(excludePredicate,"Exclude Predicate");
_includes = includeSet;
_includePredicate = includePredicate;
_excludes = excludeSet;

View File

@ -52,8 +52,8 @@ public class Loader
/** Load a class.
* <p>Load a class either from the thread context classloader or if none, the system
* loader</p>
* @param name the name of the new class to load
*
* @param name the name of the new class to load
* @return Class
* @throws ClassNotFoundException if not able to find the class
*/
@ -70,6 +70,8 @@ public class Loader
* Load a class from the same classloader as the passed <code>loadClass</code>, or if none
* then use {@link #loadClass(String)}
*
* @param loaderClass a similar class, belong in the same classloader of the desired class to load
* @param name the name of the new class to load
* @return Class
* @throws ClassNotFoundException if not able to find the class
*/

View File

@ -76,6 +76,7 @@ public interface Promise<C>
*
* @param completable the CompletableFuture to convert into a promise
* @return a promise that when completed, completes the given CompletableFuture
* @param <T> the type of the result
*/
static <T> Promise<T> from(CompletableFuture<? super T> completable)
{