Skip to content

Commit adeabcc

Browse files
committed
improve javadoc for ResourceIDMapper.singleResourceResourceIDMapper
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
1 parent 1bf7b17 commit adeabcc

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/ResourceIDMapper.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,10 @@ public interface ResourceIDMapper<R, ID> {
4040

4141
/**
4242
* Can be used if a polling event source handles only single secondary resource and the id is
43-
* String. See also docs for: {@link ExternalResourceCachingEventSource}
43+
* String. See also docs for: {@link ExternalResourceCachingEventSource}; or in {@link
44+
* io.javaoperatorsdk.operator.processing.dependent.AbstractExternalDependentResource} when there
45+
* is always only one secondary resource for that dependent resource. By definition cannot be used
46+
* for a BulkDependent resources.
4447
*
4548
* @return static id mapper, all resources are mapped for same id.
4649
* @param <R> secondary resource type

0 commit comments

Comments
 (0)