sting

Annotation Type StingProvider

@Documented
 @Retention(value=RUNTIME)
 @Target(value=ANNOTATION_TYPE)
public @interface StingProvider

Annotation that indicates the class that provides the service. The class that provides the service may be either a Fragment annotated type or an Injectable annotated type. This annotation is applied to another frameworks annotation to simplify integration with Sting. Sting will process this annotation when the framework annotation is applied to a type element and that Sting attempts to include that type. Sting can attempt to include the type either by the type being added to an Injector.includes() annotation parameter, a Fragment.includes() annotation parameter, or by being an unresolved service referenced in component graph that sting attempts to autodetect.

It should be noted that Sting will attempt to use any annotation with this name and shape so that frameworks do not need a direct code dependency on Sting.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value The name pattern of the class that provides the service.

Element Detail

value

@Nonnull public abstract String value

The name pattern of the class that provides the service. The name is relative to the reference type (See above for how to determine the reference type). The package is the same package as the reference type. The pattern can include constant string parts as well as the following replacements:

• [SimpleName]: The simple name of the class. i.e. For a top-level class like come.example.MyElement the simple name is "MyElement". For a nested class like come.example.MyElement.ElementType.Kind the simple name is "Kind".
• [CompoundName]: The compound name of the class. i.e. For a top-level class like come.example.MyElement the compound name is "MyElement". For a nested class like come.example.MyElement.ElementType.Kind the simple name is "MyElement.ElementType.Kind".
• [EnclosingName]: The compound name of the class with the simple name elided. i.e. For a top-level class like come.example.MyElement the enclosing name is "". For a nested class like come.example.MyElement.ElementType.Kind the enclosing name is "MyElement.ElementType.".
• [FlatEnclosingName]: The enclosing name of the class with the dots replaced with underscores. i.e. For a top-level class like come.example.MyElement the flat enclosing name is "". For a nested class like come.example.MyElement.ElementType.Kind the flat enclosing name is "MyElement_ElementType_".

A typical pattern used by a framework such as Arez is "[FlatEnclosingName]Arez_[SimpleName]"..

Returns:

the pattern to produce a name.