[SLING-11595] Incorrect injectionStrategy Javadocs

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: Models API 1.4.2
• Fix Version/s: Models API 1.5.0, Models Implementation 1.6.0
• Component/s: Sling Models
• Assignee: Stefan Seifert
• Reporter: Karol Lewandowski
• Created: 25/Sep/22 18:14
• Updated: 31/Mar/23 18:30
• Resolved: 28/Mar/23 09:37

Description

It seems that all docs for injectionStrategy in injector annotations are incorrect.

The current docs:

/**
 * if set to REQUIRED injection is mandatory, if set to OPTIONAL injection is optional, in case of DEFAULT 
 * the standard annotations ({@link org.apache.sling.models.annotations.Optional}, {@link org.apache.sling.models.annotations.Required}) are used.
 * If even those are not available the default injection strategy defined on the {@link org.apache.sling.models.annotations.Model} applies.
 * Default value = DEFAULT.
 */ 

state that @Optional and @Required are used only if injectionStrategy = DEFAULT. It is not true, as these annotations take precedence over injectionStrategy.

It is confirmed by implementation of org.apache.sling.models.impl.model.AbstractInjectableElement, but also by test:

• https://github.com/apache/sling-org-apache-sling-models-impl/blob/master/src/test/java/org/apache/sling/models/impl/AnnotationConflictsTest.java#L220:L240

I added a new test case:

• https://github.com/apache/sling-org-apache-sling-models-impl/pull/38

PR created:

• https://github.com/apache/sling-org-apache-sling-models-api/pull/7