Module io.helidon.common.types
Package io.helidon.common.types

Class Annotation.BuilderBase<BUILDER extends Annotation.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends Annotation>

java.lang.Object
io.helidon.common.types.Annotation.BuilderBase<BUILDER,PROTOTYPE>
Type Parameters:
BUILDER - type of the builder extending this abstract builder
PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()
All Implemented Interfaces:
Prototype.Builder<BUILDER,PROTOTYPE>
Direct Known Subclasses:
Annotation.Builder, Qualifier.BuilderBase
Enclosing interface:
Annotation
public abstract static class Annotation.BuilderBase<BUILDER extends Annotation.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends Annotation> extends Object implements Prototype.Builder<BUILDER,PROTOTYPE>
Fluent API builder base for Annotation.

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(Annotation prototype)
      Update this builder from an existing prototype instance. This method disables automatic service discovery.
      Parameters:
      prototype - existing prototype to update this builder from
      Returns:
      updated builder instance

    • from

      public BUILDER from(Annotation.BuilderBase<?,?> builder)
      Update this builder from an existing prototype builder instance.
      Parameters:
      builder - existing builder prototype to update this builder from
      Returns:
      updated builder instance

    • type

      public BUILDER type(Type annoType)
      Annotation type name from annotation type.
      Parameters:
      annoType - annotation class
      Returns:
      updated builder instance

    • value

      public BUILDER value(String value)
      Configure the value of this annotation (property of name value).
      Parameters:
      value - value of the annotation
      Returns:
      updated builder instance

    • property

      public BUILDER property(String name, Object value)
      Configure the value of an annotation property.
      Parameters:
      name - name of the property
      value - value of the property
      Returns:
      updated builder instance

    • typeName

      public BUILDER typeName(TypeName typeName)
      The type name, e.g., Objects -> "java.util.Objects".
      Parameters:
      typeName - the annotation type name
      Returns:
      updated builder instance
      See Also:

    • typeName

      public BUILDER typeName(Consumer<TypeName.Builder> consumer)
      The type name, e.g., Objects -> "java.util.Objects".
      Parameters:
      consumer - consumer of builder of the annotation type name
      Returns:
      updated builder instance
      See Also:

    • typeName

      public BUILDER typeName(Supplier<? extends TypeName> supplier)
      The type name, e.g., Objects -> "java.util.Objects".
      Parameters:
      supplier - supplier of the annotation type name
      Returns:
      updated builder instance
      See Also:

    • values

      @Deprecated(since="4.3.0", forRemoval=true) public BUILDER values(Map<String,?> values)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use Annotation.properties() instead, and accessor methods on this interface
      Key-value map of all the annotation properties. This method replaces all values with the new ones.
      Parameters:
      values - key-value pairs of all the properties present
      Returns:
      updated builder instance
      See Also:

    • addValues

      @Deprecated(since="4.3.0", forRemoval=true) public BUILDER addValues(Map<String,?> values)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use Annotation.properties() instead, and accessor methods on this interface
      Key-value map of all the annotation properties. This method keeps existing values, then puts all new values into the map.
      Parameters:
      values - key-value pairs of all the properties present
      Returns:
      updated builder instance
      See Also:

    • putValue

      @Deprecated(since="4.3.0", forRemoval=true) public BUILDER putValue(String key, Object value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use Annotation.properties() instead, and accessor methods on this interface
      Key-value map of all the annotation properties. This method adds a new value to the map, or replaces it if the key already exists.
      Parameters:
      key - key to add or replace
      value - new value for the key
      Returns:
      updated builder instance
      See Also:

    • properties

      public BUILDER properties(Map<String,? extends AnnotationProperty> properties)
      Properties defined on this annotation. This method replaces all values with the new ones.
      Parameters:
      properties - properties
      Returns:
      updated builder instance
      See Also:

    • addProperties

      public BUILDER addProperties(Map<String,? extends AnnotationProperty> properties)
      Properties defined on this annotation. This method keeps existing values, then puts all new values into the map.
      Parameters:
      properties - properties
      Returns:
      updated builder instance
      See Also:

    • putProperty

      public BUILDER putProperty(String key, AnnotationProperty property)
      Properties defined on this annotation. This method adds a new value to the map, or replaces it if the key already exists.
      Parameters:
      key - key to add or replace
      property - new value for the key
      Returns:
      updated builder instance
      See Also:

    • clearMetaAnnotations

      public BUILDER clearMetaAnnotations()
      Clear all metaAnnotations.
      Returns:
      updated builder instance
      See Also:

    • metaAnnotations

      public BUILDER metaAnnotations(List<? extends Annotation> metaAnnotations)
      A list of inherited annotations (from the whole hierarchy).
      Parameters:
      metaAnnotations - list of all annotations declared on the annotation type, or inherited from them
      Returns:
      updated builder instance
      See Also:

    • addMetaAnnotations

      public BUILDER addMetaAnnotations(List<? extends Annotation> metaAnnotations)
      A list of inherited annotations (from the whole hierarchy).
      Parameters:
      metaAnnotations - list of all annotations declared on the annotation type, or inherited from them
      Returns:
      updated builder instance
      See Also:

    • addMetaAnnotation

      public BUILDER addMetaAnnotation(Annotation metaAnnotation)
      A list of inherited annotations (from the whole hierarchy).
      Parameters:
      metaAnnotation - add single list of all annotations declared on the annotation type, or inherited from them
      Returns:
      updated builder instance
      See Also:

    • addMetaAnnotation

      public BUILDER addMetaAnnotation(Consumer<Annotation.Builder> consumer)
      A list of inherited annotations (from the whole hierarchy).
      Parameters:
      consumer - consumer of builder for list of all annotations declared on the annotation type, or inherited from them
      Returns:
      updated builder instance
      See Also:

    • clearOriginatingElement

      public BUILDER clearOriginatingElement()
      Clear existing value of originatingElement.
      Returns:
      updated builder instance
      See Also:

    • originatingElement

      public BUILDER originatingElement(Object originatingElement)
      The element used to create this instance. The type of the object depends on the environment.
      Parameters:
      originatingElement - originating element
      Returns:
      updated builder instance
      See Also:

    • typeName

      public Optional<TypeName> typeName()
      The type name, e.g., Objects -> "java.util.Objects".
      Returns:
      the annotation type name

    • values

      @Deprecated(since="4.3.0", forRemoval=true) public Map<String,Object> values()
      Deprecated, for removal: This API element is subject to removal in a future version.
      use Annotation.properties() instead, and accessor methods on this interface
      Key-value map of all the annotation properties.
      Returns:
      key-value pairs of all the properties present

    • properties

      public Map<String,AnnotationProperty> properties()
      Properties defined on this annotation.
      Returns:
      properties

    • metaAnnotations

      public List<Annotation> metaAnnotations()
      A list of inherited annotations (from the whole hierarchy).
      Returns:
      list of all annotations declared on the annotation type, or inherited from them

    • originatingElement

      public Optional<Object> originatingElement()
      The element used to create this instance. The type of the object depends on the environment.
      Returns:
      originating element

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • preBuildPrototype

      protected void preBuildPrototype()
      Handles providers and decorators.

    • validatePrototype

      protected void validatePrototype()
      Validates required properties.