cz.ues.platform.container.annotations

Annotation Type ComponentStereotype

@Documented
@Target(value=java.lang.annotation.ElementType.ANNOTATION_TYPE)
@Retention(value=RUNTIME)
public @interface ComponentStereotype

Meta annotation used to define component type annotation (e.g. UESComponent etc).
All annotations annotated by this annotation must be annotated by Named and have attribute "value" for definition of component name!
Look at ComponentStereotype.implementationAnnotations() for usage example.

Since:

UES6-00

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.Class<? extends java.lang.annotation.Annotation>[]	implementationAnnotations This attribute could be used only for component annotations with ComponentStereotype.type()=ComponentStereotype.ComponentAnnotationType.INTERFACE or ComponentStereotype.ComponentAnnotationType.INTERFACE_AND_IMPLEMENTATION interpreted as interface type too.
java.lang.String	namePostfix
java.lang.String	namePrefix
ComponentStereotype.ComponentAnnotationType	type Specifies where the component annotation could be used.

Element Detail

namePrefix

public abstract java.lang.String namePrefix

Returns:

The prefix used for component name generation from its class.

Since:

UES6-00

Default:

"N/A"

namePostfix

public abstract java.lang.String namePostfix

Returns:

The postfix used for component name generation from its class.

Since:

UES6-00

Default:

"N/A"

implementationAnnotations

public abstract java.lang.Class<? extends java.lang.annotation.Annotation>[] implementationAnnotations

This attribute could be used only for component annotations with ComponentStereotype.type()=ComponentStereotype.ComponentAnnotationType.INTERFACE or ComponentStereotype.ComponentAnnotationType.INTERFACE_AND_IMPLEMENTATION interpreted as interface type too.

The array of annotation classes must contain only annotations that satisfy following conditions:

1. Annotation must be marked as ComponentStereotype
2. The ComponentStereotype.type() must be set to ComponentStereotype.ComponentAnnotationType.IMPLEMENTATION or ComponentStereotype.ComponentAnnotationType.INTERFACE_AND_IMPLEMENTATION interpreted as implementation type too.
3. The order of annotation classes in array defines the order of annotation interpretation or lookup when needed as in container lookup for components.

The default value is interpreted as the array contains the annotation itself. But attention, the combination of {@link #type()}= {@link ComponentAnnotationType#INTERFACE} and {@link #implementationAnnotations()}={@code is not valid !!! Because component interface without implementation is not usable. So if you want use the same annotation to mark Interface and Implementation, than keep the default values for this attributes. This is used for example on {@link UESComponent} annotation.

Example:

Returns:

The array of Annotation classes used to mark component implementations for component interface marked by annotation specialized by this annotationComponentStereotype.ComponentAnnotationType.

Since:

UES6-00

Default:

{}

type

public abstract ComponentStereotype.ComponentAnnotationType type

Specifies where the component annotation could be used. For more info look at ComponentStereotype.ComponentAnnotationType

Returns:

The component annotation type.

Since:

UES6-00

Default:

cz.ues.platform.container.annotations.ComponentStereotype.ComponentAnnotationType.INTERFACE_AND_IMPLEMENTATION