Mutability or deepcopy requirements on interface javadocs #2648

wylswz · 2024-12-24T09:33:48Z

wylswz
Dec 24, 2024

Do you think it is helpful to have documentations of whether resource object accepted or returned by interfaces should be deep copied?

For instance,

public interface BulkDependentResource<R, P extends HasMetadata>
    extends Creator<R, P>, Deleter<P> {
  /**
   * Retrieves a map of desired secondary resources associated with the specified primary resource,
   * identified by an arbitrary key.
   *
   * @param primary the primary resource with which we want to identify which secondary resources
   *        are associated
   * @param context the {@link Context} associated with the current reconciliation
   * @return a Map associating desired secondary resources with the specified primary via arbitrary
   *         identifiers
   */
  // currently the implementers have no idea about whether P primary should be copied before being mutated
  // or R shoud be copied before being returned without reading invokers of this interface
  Map<String, R> desiredResources(P primary, Context<P> context);
}

metacosm · 2024-12-24T09:54:36Z

metacosm
Dec 24, 2024
Maintainer

Yes, it might indeed be helpful. In the case of the desired methods, though, the intent is to compute a desired state based on data from the primary, and therefore the primary resource shouldn't be modified at all, just read from.

2 replies

csviri Dec 24, 2024
Maintainer

Yes, so note that prior v5 when accessing the resources through context, it was automatically cloned. From v5 this it is not, but can be turned on. For SSA it is anyways natural to not modify an object, but to construct a new one (actually it is quite natural when some thinks in desired state to construct (usually) from the primary.

csviri Dec 24, 2024
Maintainer

see also: https://javaoperatorsdk.io/blog/2024/12/06/version-5-released-beta1/#cloning-accessing-secondary-resources

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Mutability or deepcopy requirements on interface javadocs #2648

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Replies: 1 comment 2 replies

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Select a reply

Uh oh!

Mutability or deepcopy requirements on interface javadocs #2648

Uh oh!

Uh oh!

wylswz Dec 24, 2024

Replies: 1 comment · 2 replies

Uh oh!

metacosm Dec 24, 2024 Maintainer

Uh oh!

Uh oh!

csviri Dec 24, 2024 Maintainer

Uh oh!

Uh oh!

csviri Dec 24, 2024 Maintainer

wylswz
Dec 24, 2024

Replies: 1 comment 2 replies

metacosm
Dec 24, 2024
Maintainer

csviri Dec 24, 2024
Maintainer

csviri Dec 24, 2024
Maintainer