io.micronaut.inject.configuration

Class ConfigurationMetadataBuilder<T>

java.lang.Object

io.micronaut.inject.configuration.ConfigurationMetadataBuilder<T>

Type Parameters:

T - The type

Direct Known Subclasses:

JavaConfigurationMetadataBuilder

public abstract class ConfigurationMetadataBuilder<T>
extends Object

A builder for producing metadata for the available ConfigurationProperties.

This data can then be subsequently written to a format readable by IDEs (like spring-configuration-metadata.json for example).

Since:

1.0

Author:

Graeme Rocher

Constructor Summary

Constructors

Constructor and Description
ConfigurationMetadataBuilder()

Method Summary

Modifier and Type	Method and Description
protected abstract String	buildPropertyPath(T owningType, T declaringType, String propertyName) Build a property path for the given declaring type and property name.
protected abstract String	buildTypePath(T owningType, T declaringType) Variation of buildPropertyPath(Object, Object, String) for types.
protected abstract String	buildTypePath(T owningType, T declaringType, AnnotationMetadata annotationMetadata) Variation of buildPropertyPath(Object, Object, String) for types.
protected abstract AnnotationMetadata	getAnnotationMetadata(T type)
static Optional<ConfigurationMetadataBuilder<?>>	getConfigurationMetadataBuilder() Obtains the currently active metadata builder.
List<ConfigurationMetadata>	getConfigurations()
abstract Element[]	getOriginatingElements()
List<PropertyMetadata>	getProperties()
protected abstract String	getTypeString(T type) Convert the given type to a string.
boolean	hasMetadata()
static void	setConfigurationMetadataBuilder(ConfigurationMetadataBuilder<?> builder) Sets or clears the current ConfigurationMetadataBuilder.
ConfigurationMetadata	visitProperties(T type, String description) Visit a ConfigurationProperties class.
ConfigurationMetadata	visitProperties(T type, String description, AnnotationMetadata annotationMetadata) Visit a ConfigurationProperties class.
PropertyMetadata	visitProperty(String propertyType, String name, String description, String defaultValue) Visit a configuration property on the last declared properties instance.
PropertyMetadata	visitProperty(T owningType, T declaringType, String propertyType, String name, String description, String defaultValue) Visit a configuration property.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationMetadataBuilder

public ConfigurationMetadataBuilder()

Method Detail

getOriginatingElements

@NonNull
public abstract Element[] getOriginatingElements()

Returns:

The originating elements for the builder.

getProperties

public List<PropertyMetadata> getProperties()

Returns:

The properties

getConfigurations

public List<ConfigurationMetadata> getConfigurations()

Returns:

The configurations

hasMetadata

public boolean hasMetadata()

Returns:

Whether any metadata is present

visitProperties

public ConfigurationMetadata visitProperties(T type,
                                             @Nullable
                                             String description)

Visit a ConfigurationProperties class.

Parameters:

type - The type of the ConfigurationProperties

description - A description

Returns:

This ConfigurationMetadata

visitProperties

public ConfigurationMetadata visitProperties(T type,
                                             @Nullable
                                             String description,
                                             @NonNull
                                             AnnotationMetadata annotationMetadata)

Visit a ConfigurationProperties class.

Parameters:

type - The type of the ConfigurationProperties

description - A description

annotationMetadata - the annotation metadata

Returns:

This ConfigurationMetadata

visitProperty

public PropertyMetadata visitProperty(T owningType,
                                      T declaringType,
                                      String propertyType,
                                      String name,
                                      @Nullable
                                      String description,
                                      @Nullable
                                      String defaultValue)

Visit a configuration property.

Parameters:

owningType - The type that owns the property

declaringType - The declaring type of the property

propertyType - The property type

name - The property name

description - A description for the property

defaultValue - The default value of the property (only used for constant values such as strings, numbers, enums etc.)

Returns:

This property metadata

visitProperty

public PropertyMetadata visitProperty(String propertyType,
                                      String name,
                                      @Nullable
                                      String description,
                                      @Nullable
                                      String defaultValue)

Visit a configuration property on the last declared properties instance.

Parameters:

propertyType - The property type

name - The property name

description - A description for the property

defaultValue - The default value of the property (only used for constant values such as strings, numbers, enums etc.)

Returns:

This property metadata or null if no existing configuration is active

buildPropertyPath

protected abstract String buildPropertyPath(T owningType,
                                            T declaringType,
                                            String propertyName)

Build a property path for the given declaring type and property name.

For ConfigurationProperties that path is a property is established by looking at the value of the ConfigurationProperties and then calculating the path based on the inheritance tree.

For example consider the following classes:

   @ConfigurationProperties("parent")
   public class ParentProperties {
      String foo;
   }

   @ConfigurationProperties("child")
   public class ChildProperties extends ParentProperties {
      String bar;
   }
 

The path of the property foo will be "parent.foo" whilst the path of the property bar will be "parent.child.bar" factoring in the class hierarchy

Inner classes hierarchies are also taken into account

Parameters:

owningType - The owning type

declaringType - The declaring type

propertyName - The property name

Returns:

The property path

buildTypePath

protected abstract String buildTypePath(T owningType,
                                        T declaringType)

Variation of buildPropertyPath(Object, Object, String) for types.

Parameters:

owningType - The owning type

declaringType - The type

Returns:

The type path

buildTypePath

protected abstract String buildTypePath(T owningType,
                                        T declaringType,
                                        AnnotationMetadata annotationMetadata)

Variation of buildPropertyPath(Object, Object, String) for types.

Parameters:

owningType - The owning type

declaringType - The type

annotationMetadata - The annotation metadata

Returns:

The type path

getTypeString

protected abstract String getTypeString(T type)

Convert the given type to a string.

Parameters:

type - The type

Returns:

The string

getAnnotationMetadata

protected abstract AnnotationMetadata getAnnotationMetadata(T type)

Parameters:

type - The type

Returns:

The annotation metadata for the type

getConfigurationMetadataBuilder

public static Optional<ConfigurationMetadataBuilder<?>> getConfigurationMetadataBuilder()

Obtains the currently active metadata builder.

Returns:

The builder

setConfigurationMetadataBuilder

public static void setConfigurationMetadataBuilder(@Nullable
                                                   ConfigurationMetadataBuilder<?> builder)

Sets or clears the current ConfigurationMetadataBuilder.

Parameters:

builder - the builder