Skip to content

Commit a7c61aa

Browse files
committed
javadoc facelift
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
1 parent 322c815 commit a7c61aa

2 files changed

Lines changed: 9 additions & 7 deletions

File tree

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/ResourceOperations.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@
3737
/**
3838
* Provides useful operations to manipulate resources (server-side apply, patch, etc.) in an
3939
* idiomatic way, in particular to make sure that the latest version of the resource is present in
40-
* the caches for the next reconciliation.
40+
* the caches for the next reconciliation. In other words provides read-cache-after-write
41+
* consistency.
4142
*
4243
* @param <P> the resource type on which this object operates
4344
*/

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/ManagedInformerEventSource.java

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -254,8 +254,8 @@ public Stream<R> byIndexStream(String indexName, String indexKey) {
254254
}
255255

256256
/**
257-
* Like {@link #list(String, Predicate)} but providing stronger consistency. This is needed when
258-
* resources are updated using {@link
257+
* Like {@link #list(String, Predicate)} but for read-cache-after-write consistency. This is
258+
* useful when resources are updated using {@link
259259
* io.javaoperatorsdk.operator.api.reconciler.ResourceOperations}.
260260
*/
261261
public Stream<R> listWithStrongConsistency(String namespace, Predicate<R> predicate) {
@@ -264,16 +264,17 @@ public Stream<R> listWithStrongConsistency(String namespace, Predicate<R> predic
264264
}
265265

266266
/**
267-
* Like {@link #list(Predicate)} but providing stronger consistency. This is needed when resources
268-
* are updated using {@link io.javaoperatorsdk.operator.api.reconciler.ResourceOperations}.
267+
* Like {@link #list(Predicate)} but for read-cache-after-write consistency. This is useful when
268+
* resources are updated using {@link
269+
* io.javaoperatorsdk.operator.api.reconciler.ResourceOperations}.
269270
*/
270271
public Stream<R> listWithStrongConsistency(Predicate<R> predicate) {
271272
return mergeWithWithTempCacheResources(cache.list(predicate), null, predicate);
272273
}
273274

274275
/**
275-
* Like {@link #byIndexStream(String, String)} but providing stronger consistency. This is needed
276-
* when resources are updated using {@link
276+
* Like {@link #byIndexStream(String, String)} but for read-cache-after-write consistency. This is
277+
* useful when resources are updated using {@link
277278
* io.javaoperatorsdk.operator.api.reconciler.ResourceOperations}.
278279
*/
279280
public Stream<R> byIndexStreamWithStrongConsistency(String indexName, String indexKey) {

0 commit comments

Comments
 (0)