javadoc

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

Author: csviri

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

@@ -21,13 +21,21 @@
 
 /**
  * Provides id for the target resource. This mapper is used across multiple components of the
- * framework, like the {@link
- * io.javaoperatorsdk.operator.processing.dependent.AbstractExternalDependentResource}, {@link
- * ExternalResourceCachingEventSource}, and {@link
- * io.javaoperatorsdk.operator.processing.dependent.KubernetesBulkDependentResource}.
+ * framework, like:
+ *
+ * <ul>
+ *   <li>{@link io.javaoperatorsdk.operator.processing.dependent.AbstractExternalDependentResource}
+ *   <li>{@link ExternalResourceCachingEventSource}
+ *   <li>{@link io.javaoperatorsdk.operator.processing.dependent.KubernetesBulkDependentResource}
+ * </ul>
+ *
+ * @see ResourceIDProvider<ID>
  */
 public interface ResourceIDMapper<R, ID> {
 
+  /**
+   * @return id for the target resource.
+   */
   ID idFor(R resource);
 
   /**

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

@@ -16,18 +16,23 @@
 package io.javaoperatorsdk.operator.processing;
 
 /**
- * Provides the identifier for an object that represents a resource. This ID is used to select the
- * target external resource for a dependent resource from the resources returned by `{@link
- * io.javaoperatorsdk.operator.api.reconciler.Context#getSecondaryResources(Class)}`. It is also
- * used in {@link ResourceIDMapper} for event sources in external resources. But also for bulk
- * dependent resource see {@link
- * io.javaoperatorsdk.operator.processing.dependent.ExternalBulkDependentResource} and external
- * event sources, see {@link
- * io.javaoperatorsdk.operator.processing.event.source.ExternalResourceCachingEventSource}
+ * Provides the identifier for an object that represents a resource. This ID is used:
  *
- * @param <ID>
+ * <ul>
+ *   <li>to select the target external resource for a dependent resource from the resources returned
+ *       by {@link io.javaoperatorsdk.operator.api.reconciler.Context#getSecondaryResources(Class)},
+ *   <li>used in {@link ResourceIDMapper} for event sources in external resources. But also for bulk
+ *       dependent resource see {@link
+ *       io.javaoperatorsdk.operator.processing.dependent.ExternalBulkDependentResource},
+ *   <li>and external event sources, see {@link
+ *       io.javaoperatorsdk.operator.processing.event.source.ExternalResourceCachingEventSource}
+ * </ul>
+ *
+ * @see ResourceIDMapper
+ * @param <ID> type of the id
  */
 public interface ResourceIDProvider<ID> {
 
+  /** ID for the resource POJO that implement this interface. */
   ID resourceId();
 }

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

@@ -44,7 +44,8 @@
  * <p>There are two related concepts to understand:
  *
  * <ul>
- *   <li>CacheKeyMapper - maps/extracts a key used to reference the associated resource in the cache
+ *   <li>ResourceIDMapper - maps/extracts a key used to reference the associated resource in the
+ *       cache
  *   <li>Object equals usage - compares if the two resources are the same or same version.
  * </ul>
  *