Package io.microsphere.metadata

Class ReflectiveConfigurationPropertyJSONGenerator

java.lang.Object

io.microsphere.metadata.ReflectiveConfigurationPropertyJSONGenerator

All Implemented Interfaces:

Prioritized, ConfigurationPropertyJSONGenerator, java.lang.Comparable<Prioritized>

public class ReflectiveConfigurationPropertyJSONGenerator
extends java.lang.Object
implements ConfigurationPropertyJSONGenerator

ConfigurationPropertyJSONGenerator class based on Java Reflection API

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:

ConfigurationPropertyJSONGenerator, JSONObject, BeanUtils.resolvePropertiesAsMap(Object)

Field Summary

Fields inherited from interface io.microsphere.lang.Prioritized

COMPARATOR, MAX_PRIORITY, MIN_PRIORITY, NORMAL_PRIORITY

Constructor Summary

Constructors

Constructor	Description
ReflectiveConfigurationPropertyJSONGenerator()

Method Summary

Modifier and Type	Method	Description
java.lang.String	generate(ConfigurationProperty configurationProperty)	Generates a JSON representation of the given ConfigurationProperty.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.microsphere.lang.Prioritized

compareTo, getPriority

Constructor Detail

ReflectiveConfigurationPropertyJSONGenerator

public ReflectiveConfigurationPropertyJSONGenerator()

Method Detail

generate

public java.lang.String generate(ConfigurationProperty configurationProperty)
                          throws java.lang.IllegalArgumentException

Description copied from interface: ConfigurationPropertyJSONGenerator

Generates a JSON representation of the given ConfigurationProperty.

Specified by:

generate in interface ConfigurationPropertyJSONGenerator

Parameters:

configurationProperty - the configuration property to be converted to JSON.

Returns:

a JSON string representation of the configuration property.

Throws:

java.lang.IllegalArgumentException - if the configurationProperty is null.