Class DefaultConfigurationPropertyGenerator

  • All Implemented Interfaces:
    Prioritized, ConfigurationPropertyGenerator, java.lang.Comparable<Prioritized>

    public class DefaultConfigurationPropertyGenerator
    extends java.lang.Object
    implements ConfigurationPropertyGenerator
    The default implementation class of ConfigurationPropertyGenerator.

    Example Usage

    
     ConfigurationProperty property = new ConfigurationProperty("server.port", Integer.class);
     property.setValue(8080);
     property.setDefaultValue(8080);
     property.setRequired(true);
     property.setDescription("The port number for the server");
    
     ConfigurationProperty.Metadata metadata = property.getMetadata();
     metadata.getSources().add("application.properties");
     metadata.getTargets().add("server");
     metadata.setDeclaredClass("com.example.ServerConfig");
     metadata.setDeclaredField("port");
     

    The JSON representation of the above ConfigurationProperty object would be:

    
     {
       "name": "server.port",
       "type": "java.lang.Integer",
       "value": 8080,
       "defaultValue": 8080,
       "required": true,
       "description": "The port number for the server",
       "metadata": {
         "sources": [
           "application.properties"
         ],
         "targets": [
           "server"
         ],
         "declaredClass": "com.example.ServerConfig",
         "declaredField": "port"
       }
     }
     
    Since:
    1.0.0
    Author:
    Mercy
    See Also:
    ConfigurationPropertyGenerator, ConfigurationProperty