fix javadoc

This commit is contained in:
Greg Wilkins 2016-09-01 17:38:09 +10:00
parent f7c32c5fc7
commit d43b9af428
2 changed files with 16 additions and 14 deletions

View File

@ -29,7 +29,8 @@ import java.util.Set;
* <p>The type of the underlying {@link Set} used may be passed into the
* constructor, so special sets like Servlet PathMap may be used.
* <p>
* @param <P> The type of element
* @param <P> The type of element of the set (often a pattern)
* @param <T> The type of the instance passed to the predicate
*/
public class IncludeExcludeSet<P,T> implements Predicate<T>
{
@ -65,7 +66,7 @@ public class IncludeExcludeSet<P,T> implements Predicate<T>
/**
* Construct an IncludeExclude
* @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 type of a set to use as the backing store
*/
public <SET extends Set<P>> IncludeExcludeSet(Class<SET> setClass)
{
@ -102,6 +103,7 @@ public class IncludeExcludeSet<P,T> implements Predicate<T>
* @param includePredicate the Predicate for included item testing (null for simple {@link Set#contains(Object)} test)
* @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 <SET> The type of a set to use as the backing store
*/
public <SET extends Set<P>> IncludeExcludeSet(Set<P> includeSet, Predicate<T> includePredicate, Set<P> excludeSet, Predicate<T> excludePredicate)
{

View File

@ -30,19 +30,19 @@ import java.util.Set;
* <p>This is a {@link Set} of String patterns that are used to match
* a {@link Predicate} over InetAddress for containment semantics.
* The patterns that may be set are:
* <dl>
* <dt>InetAddress</dt><tt>A single InetAddress either in hostname or address format.
* All formats supported by {@link InetAddress} are accepted. Not ethat using hostname
* matches may force domain lookups. eg. "[::1]", "1.2.3.4", "::ffff:127.0.0.1"</tt>
* <dt>InetAddress/CIDR</dt><tt>An InetAddress with a integer number of bits to indicate
* the significant prefix. eg. "192.168.0.0/16" will match from "192.168.0.0" to
* "192.168.255.255" </tt>
* <dt>InetAddress-InetAddress</dt><tt>An inclusive range of InetAddresses.
* eg. "[a000::1]-[afff::]", "192.168.128.0-192.168.128.255"</tt>
* <dt>Legacy format</dt><tt>The legacy format used by {@link IPAddressMap} for IPv4 only.
* eg. "10.10.10-14.0-128"</tt>
* </dl>
* </p>
* <dl>
* <dt>InetAddress</dt><dd>A single InetAddress either in hostname or address format.
* All formats supported by {@link InetAddress} are accepted. Not ethat using hostname
* matches may force domain lookups. eg. "[::1]", "1.2.3.4", "::ffff:127.0.0.1"</dd>
* <dt>InetAddress/CIDR</dt><dd>An InetAddress with a integer number of bits to indicate
* the significant prefix. eg. "192.168.0.0/16" will match from "192.168.0.0" to
* "192.168.255.255" </dd>
* <dt>InetAddress-InetAddress</dt><dd>An inclusive range of InetAddresses.
* eg. "[a000::1]-[afff::]", "192.168.128.0-192.168.128.255"</dd>
* <dt>Legacy format</dt><dd>The legacy format used by {@link IPAddressMap} for IPv4 only.
* eg. "10.10.10-14.0-128"</dd>
* </dl>
* <p>This class is designed to work with {@link IncludeExcludeSet}</p>
* @see IncludeExcludeSet
*/