Package org.apache.sling.models.annotations.injectorspecific

Annotation Type ScriptVariable

  • @Target({METHOD,FIELD,PARAMETER})
@Retention(RUNTIME)
@InjectAnnotation
public @interface ScriptVariable
    Annotation to be used on either methods, fields or constructor parameters to let Sling Models inject a script variable (from the org.apache.sling.api.scripting.SlingBindings)

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      InjectionStrategy injectionStrategy
      if set to REQUIRED injection is mandatory, if set to OPTIONAL injection is optional, in case of DEFAULT the standard annotations (Optional, Required) are used.
      java.lang.String name
      Specifies the name of the script variable.
      boolean optional
      Deprecated.
      Use injectionStrategy() instead.

    • Element Detail

      • name

        java.lang.String name
        Specifies the name of the script variable. If empty or not set, then the name is derived from the method or field.
        Default:
        ""

      • optional

        @Deprecated
boolean optional
        Deprecated.
        Use injectionStrategy() instead.
        If set to true, the model can be instantiated even if there is no scripting value with the specified name. Default = false.
        Default:
        false

      • injectionStrategy

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