Skip to content

Commit

Permalink
Improve Javadoc cross-references for discovery selectors
Browse files Browse the repository at this point in the history
  • Loading branch information
sbrannen committed Dec 11, 2018
1 parent 031d692 commit 12d4304
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@
* {@link DiscoveryFilter} that is applied to the name of a {@link Class}.
*
* @since 1.0
* @see #includeClassNamePatterns
* @see #includeClassNamePatterns(String...)
* @see #excludeClassNamePatterns(String...)
* @see PackageNameFilter
*/
@API(status = STABLE, since = "1.0")
public interface ClassNameFilter extends DiscoveryFilter<String> {
Expand Down Expand Up @@ -49,6 +51,7 @@ public interface ClassNameFilter extends DiscoveryFilter<String> {
* @param patterns regular expressions to match against fully qualified
* class names; never {@code null}, empty, or containing {@code null}
* @see Class#getName()
* @see #excludeClassNamePatterns(String...)
*/
static ClassNameFilter includeClassNamePatterns(String... patterns) {
return new IncludeClassNameFilter(patterns);
Expand All @@ -65,6 +68,7 @@ static ClassNameFilter includeClassNamePatterns(String... patterns) {
* @param patterns regular expressions to match against fully qualified
* class names; never {@code null}, empty, or containing {@code null}
* @see Class#getName()
* @see #includeClassNamePatterns(String...)
*/
static ClassNameFilter excludeClassNamePatterns(String... patterns) {
return new ExcludeClassNameFilter(patterns);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@
* {@link DiscoveryFilter} that is applied to the name of a {@link Package}.
*
* @since 1.0
* @see #includePackageNames
* @see #includePackageNames(String...)
* @see #excludePackageNames(String...)
* @see ClassNameFilter
*/
@API(status = STABLE, since = "1.0")
public interface PackageNameFilter extends DiscoveryFilter<String> {
Expand All @@ -37,6 +39,8 @@ public interface PackageNameFilter extends DiscoveryFilter<String> {
* @param names package names that we be compared against fully qualified
* package names; never {@code null}, empty, or containing {@code null}
* @see Package#getName()
* @see #includePackageNames(List)
* @see #excludePackageNames(String...)
*/
static PackageNameFilter includePackageNames(String... names) {
return new IncludePackageNameFilter(names);
Expand All @@ -53,6 +57,8 @@ static PackageNameFilter includePackageNames(String... names) {
* @param names package names that we be compared against fully qualified
* package names; never {@code null}, empty, or containing {@code null}
* @see Package#getName()
* @see #includePackageNames(String...)
* @see #excludePackageNames(String...)
*/
static PackageNameFilter includePackageNames(List<String> names) {
return includePackageNames(names.toArray(new String[0]));
Expand All @@ -69,6 +75,8 @@ static PackageNameFilter includePackageNames(List<String> names) {
* @param names package names that we be compared against fully qualified
* package names; never {@code null}, empty, or containing {@code null}
* @see Package#getName()
* @see #excludePackageNames(List)
* @see #includePackageNames(String...)
*/
static PackageNameFilter excludePackageNames(String... names) {
return new ExcludePackageNameFilter(names);
Expand All @@ -85,6 +93,8 @@ static PackageNameFilter excludePackageNames(String... names) {
* @param names package names that we be compared against fully qualified
* package names; never {@code null}, empty, or containing {@code null}
* @see Package#getName()
* @see #excludePackageNames(String...)
* @see #includePackageNames(String...)
*/
static PackageNameFilter excludePackageNames(List<String> names) {
return excludePackageNames(names.toArray(new String[0]));
Expand Down

0 comments on commit 12d4304

Please sign in to comment.