Package org.apache.sling.models.impl.injectors

Class ValueMapInjector

java.lang.Object

org.apache.sling.models.impl.injectors.ValueMapInjector

All Implemented Interfaces:

Injector, InjectAnnotationProcessorFactory, ValuePreparer

public class ValueMapInjector
extends Object
implements Injector, InjectAnnotationProcessorFactory, ValuePreparer

Constructor Summary

Constructors

Constructor	Description
ValueMapInjector()

Method Summary

Modifier and Type	Method	Description
InjectAnnotationProcessor	createAnnotationProcessor(Object adaptable, AnnotatedElement element)
@NotNull String	getName()	Return a logical name for the injector.
protected ResourceResolver	getResourceResolver(Object adaptable)
Object	getValue(@NotNull Object adaptable, String name, @NotNull Type type, @NotNull AnnotatedElement element, @NotNull DisposalCallbackRegistry callbackRegistry)	Produce a value for an injection point.
protected @Nullable ValueMap	getValueMap(Object adaptable)	Retrieve the ValueMap from the given adaptable.
protected boolean	isDeclaredTypeCollection(Type declaredType)
@NotNull Object	prepareValue(@NotNull Object adaptable)	Prepare a value from the adaptable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ValueMapInjector

public ValueMapInjector()

Method Details

getName

@NotNull
public @NotNull String getName()

Description copied from interface: Injector

Return a logical name for the injector. Used in resolving

@Source

annotations.

Specified by:

getName in interface Injector

Returns:

the injector's name

getValue

public Object getValue(@NotNull
 @NotNull Object adaptable,
 String name,
 @NotNull
 @NotNull Type type,
 @NotNull
 @NotNull AnnotatedElement element,
 @NotNull
 @NotNull DisposalCallbackRegistry callbackRegistry)

Description copied from interface: Injector

Produce a value for an injection point.

Specified by:

getValue in interface Injector

Parameters:

adaptable - the object which should be used as the basis for value resolution.

name - the injection point name (may be only null if injector implements the AcceptsNullName interface, otherwise never null)

type - the declared type of the injection point

element - the injection point itself

callbackRegistry - a registry object to register a callback object which will be invoked when the adapted object is disposed.

Returns:

the value to be injected or null if no value could be resolved

prepareValue

@NotNull
public @NotNull Object prepareValue(@NotNull
 @NotNull Object adaptable)

Description copied from interface: ValuePreparer

Prepare a value from the adaptable.

Specified by:

prepareValue in interface ValuePreparer

Parameters:

adaptable - the adaptable

Returns:

a prepared value or ObjectUtils.NULL if a value is not preparable

createAnnotationProcessor

public InjectAnnotationProcessor createAnnotationProcessor(Object adaptable,
 AnnotatedElement element)

Specified by:

createAnnotationProcessor in interface InjectAnnotationProcessorFactory

Parameters:

adaptable - the object from which this model is adapted

element - the field or method which is annotated

Returns:

a ModelAnnotationProcessor in case there is a known injector-specific annotation on the given element found otherwise null. This method should return a InjectAnnotationProcessor2 preferably.

getResourceResolver

protected ResourceResolver getResourceResolver(Object adaptable)

getValueMap

@Nullable
protected @Nullable ValueMap getValueMap(Object adaptable)

Retrieve the ValueMap from the given adaptable. This succeeds, if the adaptable is either

• a ValueMap,
• a SlingHttpServletRequest, in which case the returned ValueMap is the one derived from the request's resource or
• adaptable to a ValueMap.

Otherwise null is returned.

Parameters:

adaptable - Adaptable

Returns:

a ValueMap or null.

isDeclaredTypeCollection

protected boolean isDeclaredTypeCollection(Type declaredType)