kroxylicious icon indicating copy to clipboard operation
kroxylicious copied to clipboard

Improve the LocalRef hierarchy javadocs

Open robobario opened this issue 4 months ago • 1 comments

Currently it's a bit tough to understand the purpose of:

LocalRef AnyLocalRef AbstractLocalRef

and the concrete types that sometimes extend LocalRef, sometimes extend AbstractLocalRef

With a bit more docs we could explain the rationale behind these types.

If I recall correctly these classes address the issue that the CRD-> java code generation would generate distinct classes for each of these very similar types of objects that define a group,name,kind. We wanted some way to have them deserialize to Ref types that were comparable, so a ProxyRef(a,b,c) is equal to an AnyLocalRef(a,b,c). I'll see if I can track down the conversation.

robobario avatar Sep 04 '25 08:09 robobario

If I recall correctly these classes address the issue that the CRD-> java code generation would generate distinct classes for each of these very similar types of objects that define a group,name,kind. We wanted some way to have them deserialize to Ref types that were comparable, so a ProxyRef(a,b,c) is equal to an AnyLocalRef(a,b,c). I'll see if I can track down the conversation.

I think that sums it up.

k-wall avatar Sep 11 '25 11:09 k-wall