Skip to content

Commit 04bb336

Browse files
committed
Polish ResourcePatternHints Javadoc
1 parent dc07ca1 commit 04bb336

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

spring-core/src/main/java/org/springframework/aot/hint/ResourcePatternHints.java

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@
2525
import org.springframework.lang.Nullable;
2626

2727
/**
28-
* A collection of {@link ResourcePatternHint} describing whether
29-
* resources should be made available at runtime through a matching
30-
* mechanism or inclusion/exclusion.
28+
* A collection of {@link ResourcePatternHint} describing whether resources should
29+
* be made available at runtime using a matching algorithm based on include/exclude
30+
* patterns.
3131
*
3232
* @author Stephane Nicoll
3333
* @author Brian Clozel
@@ -75,7 +75,7 @@ public static class Builder {
7575
}
7676

7777
/**
78-
* Includes the resources matching the specified pattern.
78+
* Include resources matching the specified patterns.
7979
* @param reachableType the type that should be reachable for this hint to apply
8080
* @param includes the include patterns (see {@link ResourcePatternHint} documentation)
8181
* @return {@code this}, to facilitate method chaining
@@ -88,7 +88,7 @@ public Builder includes(@Nullable TypeReference reachableType, String... include
8888
}
8989

9090
/**
91-
* Includes the resources matching the specified pattern.
91+
* Include resources matching the specified patterns.
9292
* @param includes the include patterns (see {@link ResourcePatternHint} documentation)
9393
* @return {@code this}, to facilitate method chaining
9494
*/
@@ -97,9 +97,9 @@ public Builder includes(String... includes) {
9797
}
9898

9999
/**
100-
* Exclude resources matching the specified pattern.
100+
* Exclude resources matching the specified patterns.
101101
* @param reachableType the type that should be reachable for this hint to apply
102-
* @param excludes the excludes pattern (see {@link ResourcePatternHint} documentation)
102+
* @param excludes the exclude patterns (see {@link ResourcePatternHint} documentation)
103103
* @return {@code this}, to facilitate method chaining
104104
*/
105105
public Builder excludes(TypeReference reachableType, String... excludes) {
@@ -110,22 +110,23 @@ public Builder excludes(TypeReference reachableType, String... excludes) {
110110
}
111111

112112
/**
113-
* Exclude resources matching the specified pattern.
114-
* @param excludes the excludes pattern (see {@link ResourcePatternHint} documentation)
113+
* Exclude resources matching the specified patterns.
114+
* @param excludes the exclude patterns (see {@link ResourcePatternHint} documentation)
115115
* @return {@code this}, to facilitate method chaining
116116
*/
117117
public Builder excludes(String... excludes) {
118118
return excludes(null, excludes);
119119
}
120120

121121
/**
122-
* Creates a {@link ResourcePatternHints} based on the state of this
122+
* Create {@link ResourcePatternHints} based on the state of this
123123
* builder.
124-
* @return a resource pattern hint
124+
* @return resource pattern hints
125125
*/
126126
ResourcePatternHints build() {
127127
return new ResourcePatternHints(this);
128128
}
129129

130130
}
131+
131132
}

0 commit comments

Comments
 (0)