pl.jalokim.propertiestojson.util

Class PropertiesToJsonConverter

java.lang.Object

pl.jalokim.propertiestojson.util.PropertiesToJsonConverter

public final class PropertiesToJsonConverter
extends Object

Constructor Summary

Constructors

Constructor and Description
PropertiesToJsonConverter() Default implementation of json primitive type resolvers.
PropertiesToJsonConverter(List<TextToConcreteObjectResolver<?>> toObjectsResolvers, List<ObjectToJsonTypeConverter<?>> toJsonTypeResolvers)
PropertiesToJsonConverter(List<TextToConcreteObjectResolver<?>> toObjectsResolvers, List<ObjectToJsonTypeConverter<?>> toJsonTypeResolvers, NullToJsonTypeConverter nullToJsonConverter, TextToJsonNullReferenceResolver textToJsonNullResolver, TextToEmptyStringResolver textToEmptyStringResolver, Boolean skipNull)
PropertiesToJsonConverter(List<TextToConcreteObjectResolver<?>> toObjectsResolvers, List<ObjectToJsonTypeConverter<?>> toJsonTypeResolvers, NullToJsonTypeConverter nullToJsonConverter, TextToJsonNullReferenceResolver textToJsonNullResolver, TextToEmptyStringResolver textToEmptyStringResolver, Boolean skipNull, Charset charset)
PropertiesToJsonConverter(PrimitiveJsonTypeResolver<?>... customPrimitiveResolvers) Deprecated.

Method Summary

Modifier and Type	Method and Description
String	convertFromValuesAsObjectMap(Map<String,Object> properties) It generates Json given Map<String,Object> instance.
String	convertFromValuesAsObjectMap(Map<String,Object> properties, String... includeDomainKeys) It generates Json given Map<String,Object> instance and will converts only included keys or parts of property keys provided by second parameter.
String	convertPropertiesFromFileToJson(File file) It generates Json from properties file stored in provided File.
String	convertPropertiesFromFileToJson(File file, String... includeDomainKeys) It generates Json from properties file stored in provided File and will converts only included keys or parts of property keys provided by second parameter.
String	convertPropertiesFromFileToJson(String pathToFile) It generates Json from properties file stored in provided path as string.
String	convertPropertiesFromFileToJson(String pathToFile, String... includeDomainKeys) It generates Json from properties file stored in provided path as string and will converts only included keys or parts of property keys provided by second parameter.
String	convertToJson(InputStream inputStream) It generates Json from properties stored in provided InputStream.
String	convertToJson(InputStream inputStream, String... includeDomainKeys) It generates Json from properties stored in provided InputStream and will converts only included keys or parts of property keys provided by second parameter.
String	convertToJson(Map<String,String> properties) It generates Json from given Map<String,String> instance.
String	convertToJson(Map<String,String> properties, String... includeDomainKeys) It generates Json from given Map<String,String> instance and will converts only included keys or parts of property keys provided by second parameter.
String	convertToJson(Properties properties) It generates Json from given Java Properties instance.
String	convertToJson(Properties properties, String... includeDomainKeys) It generates Json from given Java Properties instance and will converts only included keys or parts of property keys provided by second parameter.
void	setPropertyKeysOrderResolver(PropertyKeysOrderResolver propertyKeysOrderResolver) It change implementation of order gathering keys from properties

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertiesToJsonConverter

public PropertiesToJsonConverter()

Default implementation of json primitive type resolvers.

PropertiesToJsonConverter

@Deprecated
public PropertiesToJsonConverter(PrimitiveJsonTypeResolver<?>... customPrimitiveResolvers)

Deprecated.

This is deprecated constructor and will be remove in 6.0.0 version. Please migrate you resolvers for new interfaces and build PropertiesToJsonConverter instance through PropertiesToJsonConverterBuilder

For add order or own implementation for for TextToConcreteObjectResolver please use one of below: - and use method PropertiesToJsonConverterBuilder.onlyCustomTextToObjectResolvers(pl.jalokim.propertiestojson.resolvers.primitives.string.TextToConcreteObjectResolver<?>...) - and use method PropertiesToJsonConverterBuilder.defaultAndCustomTextToObjectResolvers(pl.jalokim.propertiestojson.resolvers.primitives.string.TextToConcreteObjectResolver<?>...)

For add order or own implementation for for ObjectToJsonTypeConverter please use one of below: - and use method PropertiesToJsonConverterBuilder.onlyCustomObjectToJsonTypeConverters(pl.jalokim.propertiestojson.resolvers.primitives.object.ObjectToJsonTypeConverter<?>...) - and use method PropertiesToJsonConverterBuilder.defaultAndCustomObjectToJsonTypeConverters(pl.jalokim.propertiestojson.resolvers.primitives.object.ObjectToJsonTypeConverter<?>...)

Parameters:

customPrimitiveResolvers - ordered list

PropertiesToJsonConverter

public PropertiesToJsonConverter(List<TextToConcreteObjectResolver<?>> toObjectsResolvers,
                                 List<ObjectToJsonTypeConverter<?>> toJsonTypeResolvers)

PropertiesToJsonConverter

public PropertiesToJsonConverter(List<TextToConcreteObjectResolver<?>> toObjectsResolvers,
                                 List<ObjectToJsonTypeConverter<?>> toJsonTypeResolvers,
                                 NullToJsonTypeConverter nullToJsonConverter,
                                 TextToJsonNullReferenceResolver textToJsonNullResolver,
                                 TextToEmptyStringResolver textToEmptyStringResolver,
                                 Boolean skipNull)

PropertiesToJsonConverter

public PropertiesToJsonConverter(List<TextToConcreteObjectResolver<?>> toObjectsResolvers,
                                 List<ObjectToJsonTypeConverter<?>> toJsonTypeResolvers,
                                 NullToJsonTypeConverter nullToJsonConverter,
                                 TextToJsonNullReferenceResolver textToJsonNullResolver,
                                 TextToEmptyStringResolver textToEmptyStringResolver,
                                 Boolean skipNull,
                                 Charset charset)

Method Detail

convertPropertiesFromFileToJson

public String convertPropertiesFromFileToJson(String pathToFile)

It generates Json from properties file stored in provided path as string. Every property value will tries resolve to concrete object by given resolvers... It will try convert to some object (number, boolean, list etc, depends on generic type of given TextToConcreteObjectResolver) from string value through method: TextToConcreteObjectResolver.returnObjectWhenCanBeResolved(PrimitiveJsonTypesResolver primitiveJsonTypesResolver, String propertyValue, String propertyKey) The order of resolvers is important because on that depends on which resolver as first will convert from string to some given object...

Next will looks for sufficient converter, firstly will looks for exactly match class type, if not then will looks for closets parent class or parent interface. If will find resolver for parent class or parent interface at the same level, then will get parent super class as first. If will find only closets super interfaces (at the same level) then will throw exception... after successful found resolver it converts from given object to some instance which extends AbstractJsonType through method ObjectToJsonTypeConverter.convertToJsonTypeOrEmpty(PrimitiveJsonTypesResolver primitiveJsonTypesResolver, Object propertyValue, String propertyKey)

Parameters:

pathToFile - path to File

Returns:

simple String with json

Throws:

ReadInputException - when cannot find file

ParsePropertiesException - when structure of properties is not compatible with json structure

convertPropertiesFromFileToJson

public String convertPropertiesFromFileToJson(String pathToFile,
                                              String... includeDomainKeys)

It generates Json from properties file stored in provided path as string and will converts only included keys or parts of property keys provided by second parameter. Every property value will tries resolve to concrete object by given resolvers... It will try convert to some object (number, boolean, list etc, depends on generic type of given TextToConcreteObjectResolver) from string value through method: TextToConcreteObjectResolver.returnObjectWhenCanBeResolved(PrimitiveJsonTypesResolver primitiveJsonTypesResolver, String propertyValue, String propertyKey) The order of resolvers is important because on that depends on which resolver as first will convert from string to some given object...

Next will looks for sufficient converter, firstly will looks for exactly match class type, if not then will looks for closets parent class or parent interface. If will find resolver for parent class or parent interface at the same level, then will get parent super class as first. If will find only closets super interfaces (at the same level) then will throw exception... after successful found resolver it converts from given object to some instance which extends AbstractJsonType through method ObjectToJsonTypeConverter.convertToJsonTypeOrEmpty(PrimitiveJsonTypesResolver primitiveJsonTypesResolver, Object propertyValue, String propertyKey)

Parameters:

pathToFile - path to File

includeDomainKeys - domain head keys which should be parsed to json
example properties:
object1.field1=value1
object1.field2=value2
someObject2.field2=value3
filter "object1"
will parse only nested domain for "object1"

Returns:

simple String with json

Throws:

ReadInputException - when cannot find file

ParsePropertiesException - when structure of properties is not compatible with json structure

convertPropertiesFromFileToJson

public String convertPropertiesFromFileToJson(File file)

It generates Json from properties file stored in provided File. Every property value will tries resolve to concrete object by given resolvers... It will try convert to some object (number, boolean, list etc, depends on generic type of given TextToConcreteObjectResolver) from string value through method: TextToConcreteObjectResolver.returnObjectWhenCanBeResolved(PrimitiveJsonTypesResolver primitiveJsonTypesResolver, String propertyValue, String propertyKey) The order of resolvers is important because on that depends on which resolver as first will convert from string to some given object...

Next will looks for sufficient converter, firstly will looks for exactly match class type, if not then will looks for closets parent class or parent interface. If will find resolver for parent class or parent interface at the same level, then will get parent super class as first. If will find only closets super interfaces (at the same level) then will throw exception... after successful found resolver it converts from given object to some instance which extends AbstractJsonType through method ObjectToJsonTypeConverter.convertToJsonTypeOrEmpty(PrimitiveJsonTypesResolver primitiveJsonTypesResolver, Object propertyValue, String propertyKey)

Parameters:

file - file with properties

Returns:

simple String with json

Throws:

ReadInputException - when cannot find file

ParsePropertiesException - when structure of properties is not compatible with json structure

convertPropertiesFromFileToJson

public String convertPropertiesFromFileToJson(File file,
                                              String... includeDomainKeys)

It generates Json from properties file stored in provided File and will converts only included keys or parts of property keys provided by second parameter. Every property value will tries resolve to concrete object by given resolvers... It will try convert to some object (number, boolean, list etc, depends on generic type of given TextToConcreteObjectResolver) from string value through method: TextToConcreteObjectResolver.returnObjectWhenCanBeResolved(PrimitiveJsonTypesResolver primitiveJsonTypesResolver, String propertyValue, String propertyKey) The order of resolvers is important because on that depends on which resolver as first will convert from string to some given object...

Next will looks for sufficient converter, firstly will looks for exactly match class type, if not then will looks for closets parent class or parent interface. If will find resolver for parent class or parent interface at the same level, then will get parent super class as first. If will find only closets super interfaces (at the same level) then will throw exception... after successful found resolver it converts from given object to some instance which extends AbstractJsonType through method ObjectToJsonTypeConverter.convertToJsonTypeOrEmpty(PrimitiveJsonTypesResolver primitiveJsonTypesResolver, Object propertyValue, String propertyKey)

Parameters:

file - file with properties

includeDomainKeys - domain head keys which should be parsed to json
example properties:
object1.field1=value1
object1.field2=value2
someObject2.field2=value3
filter "object1"
will parse only nested domain for "object1"

Returns:

simple String with json

Throws:

ReadInputException - when cannot find file

ParsePropertiesException - when structure of properties is not compatible with json structure

convertToJson

public String convertToJson(InputStream inputStream)

It generates Json from properties stored in provided InputStream. Every property value will tries resolve to concrete object by given resolvers... It will try convert to some object (number, boolean, list etc, depends on generic type of given TextToConcreteObjectResolver) from string value through method: TextToConcreteObjectResolver.returnObjectWhenCanBeResolved(PrimitiveJsonTypesResolver primitiveJsonTypesResolver, String propertyValue, String propertyKey) The order of resolvers is important because on that depends on which resolver as first will convert from string to some given object...

Next will looks for sufficient converter, firstly will looks for exactly match class type, if not then will looks for closets parent class or parent interface. If will find resolver for parent class or parent interface at the same level, then will get parent super class as first. If will find only closets super interfaces (at the same level) then will throw exception... after successful found resolver it converts from given object to some instance which extends AbstractJsonType through method ObjectToJsonTypeConverter.convertToJsonTypeOrEmpty(PrimitiveJsonTypesResolver primitiveJsonTypesResolver, Object propertyValue, String propertyKey)

Parameters:

inputStream - InputStream with properties

Returns:

simple String with json

Throws:

ReadInputException - when cannot find file

ParsePropertiesException - when structure of properties is not compatible with json structure

convertToJson

public String convertToJson(InputStream inputStream,
                            String... includeDomainKeys)

It generates Json from properties stored in provided InputStream and will converts only included keys or parts of property keys provided by second parameter. Every property value will tries resolve to concrete object by given resolvers... It will try convert to some object (number, boolean, list etc, depends on generic type of given TextToConcreteObjectResolver) from string value through method: TextToConcreteObjectResolver.returnObjectWhenCanBeResolved(PrimitiveJsonTypesResolver primitiveJsonTypesResolver, String propertyValue, String propertyKey) The order of resolvers is important because on that depends on which resolver as first will convert from string to some given object...

Next will looks for sufficient converter, firstly will looks for exactly match class type, if not then will looks for closets parent class or parent interface. If will find resolver for parent class or parent interface at the same level, then will get parent super class as first. If will find only closets super interfaces (at the same level) then will throw exception... after successful found resolver it converts from given object to some instance which extends AbstractJsonType through method ObjectToJsonTypeConverter.convertToJsonTypeOrEmpty(PrimitiveJsonTypesResolver primitiveJsonTypesResolver, Object propertyValue, String propertyKey)

Parameters:

inputStream - InputStream with properties

includeDomainKeys - domain head keys which should be parsed to json
example properties:
object1.field1=value1
object1.field2=value2
someObject2.field2=value3
filter "object1"
will parse only nested domain for "object1"

Returns:

simple String with json

Throws:

ReadInputException - when cannot find file

ParsePropertiesException - when structure of properties is not compatible with json structure

convertToJson

public String convertToJson(Properties properties)

It generates Json from given Java Properties instance. If property value will be string then will not try convert it to another type.

It will only looks for sufficient resolver, firstly will looks for exactly match class type, if not then will looks for closets parent class or parent interface. If will find resolver for parent class or parent interface at the same level, then will get parent super class as first. If will find only closets super interfaces (at the same level) then will throw exception... after successful found resolver it converts from given object to some instance which extends AbstractJsonType through method ObjectToJsonTypeConverter.convertToJsonTypeOrEmpty(PrimitiveJsonTypesResolver primitiveJsonTypesResolver, Object propertyValue, String propertyKey)

Parameters:

properties - Java Properties

Returns:

simple String with json

Throws:

ParsePropertiesException - when structure of properties is not compatible with json structure

convertToJson

public String convertToJson(Properties properties,
                            String... includeDomainKeys)

It generates Json from given Java Properties instance and will converts only included keys or parts of property keys provided by second parameter. If property value will be string then will not try convert it to another type.

It will only looks for sufficient resolver, firstly will looks for exactly match class type, if not then will looks for closets parent class or parent interface. If will find resolver for parent class or parent interface at the same level, then will get parent super class as first. If will find only closets super interfaces (at the same level) then will throw exception... after successful found resolver it converts from given object to some instance which extends AbstractJsonType through method ObjectToJsonTypeConverter.convertToJsonTypeOrEmpty(PrimitiveJsonTypesResolver primitiveJsonTypesResolver, Object propertyValue, String propertyKey)

Parameters:

properties - Java Properties

includeDomainKeys - domain head keys which should be parsed to json
example properties:
object1.field1=value1
object1.field2=value2
someObject2.field2=value3
filter "object1"
will parse only nested domain for "object1"

Returns:

Simple String with json

Throws:

ParsePropertiesException - when structure of properties is not compatible with json structure

convertToJson

public String convertToJson(Map<String,String> properties)

It generates Json from given Map<String,String> instance. Every property value will tries resolve to concrete object by given resolvers... It will try convert to some object (number, boolean, list etc, depends on generic type of given TextToConcreteObjectResolver) from string value through method: TextToConcreteObjectResolver.returnObjectWhenCanBeResolved(PrimitiveJsonTypesResolver primitiveJsonTypesResolver, String propertyValue, String propertyKey) The order of resolvers is important because on that depends on which resolver as first will convert from string to some given object...

Next will looks for sufficient converter, firstly will looks for exactly match class type, if not then will looks for closets parent class or parent interface. If will find resolver for parent class or parent interface at the same level, then will get parent super class as first. If will find only closets super interfaces (at the same level) then will throw exception... after successful found resolver it converts from given object to some instance which extends AbstractJsonType through method ObjectToJsonTypeConverter.convertToJsonTypeOrEmpty(PrimitiveJsonTypesResolver primitiveJsonTypesResolver, Object propertyValue, String propertyKey)

Parameters:

properties - Java Map with properties

Returns:

simple String with json

Throws:

ParsePropertiesException - when structure of properties is not compatible with json structure

convertToJson

public String convertToJson(Map<String,String> properties,
                            String... includeDomainKeys)

It generates Json from given Map<String,String> instance and will converts only included keys or parts of property keys provided by second parameter. Every property value will tries resolve to concrete object by given resolvers... It will try convert to some object (number, boolean, list etc, depends on generic type of given TextToConcreteObjectResolver) from string value through method: TextToConcreteObjectResolver.returnObjectWhenCanBeResolved(PrimitiveJsonTypesResolver primitiveJsonTypesResolver, String propertyValue, String propertyKey) The order of resolvers is important because on that depends on which resolver as first will convert from string to some given object...

Next will looks for sufficient converter, firstly will looks for exactly match class type, if not then will looks for closets parent class or parent interface. If will find resolver for parent class or parent interface at the same level, then will get parent super class as first. If will find only closets super interfaces (at the same level) then will throw exception... after successful found resolver it converts from given object to some instance which extends AbstractJsonType through method ObjectToJsonTypeConverter.convertToJsonTypeOrEmpty(PrimitiveJsonTypesResolver primitiveJsonTypesResolver, Object propertyValue, String propertyKey)

Parameters:

properties - Java Map with properties

includeDomainKeys - domain head keys which should be parsed to json
example properties:
object1.field1=value1
object1.field2=value2
someObject2.field2=value3
filter "object1"
will parse only nested domain for "object1"

Returns:

simple String with json

Throws:

ParsePropertiesException - when structure of properties is not compatible with json structure

convertFromValuesAsObjectMap

public String convertFromValuesAsObjectMap(Map<String,Object> properties)

It generates Json given Map<String,Object> instance. If property value will be string then will not try convert it to another type.

It will only looks for sufficient resolver, firstly will looks for exactly match class type, if not then will looks for closets parent class or parent interface. If will find resolver for parent class or parent interface at the same level, then will get parent super class as first. If will find only closets super interfaces (at the same level) then will throw exception... after successful found resolver it converts from given object to some instance which extends AbstractJsonType through method ObjectToJsonTypeConverter.convertToJsonTypeOrEmpty(PrimitiveJsonTypesResolver primitiveJsonTypesResolver, Object propertyValue, String propertyKey)

Parameters:

properties - Java Map with properties

Returns:

simple String with json

Throws:

ParsePropertiesException - when structure of properties is not compatible with json structure

convertFromValuesAsObjectMap

public String convertFromValuesAsObjectMap(Map<String,Object> properties,
                                           String... includeDomainKeys)

It generates Json given Map<String,Object> instance and will converts only included keys or parts of property keys provided by second parameter. If property value will be string then will not try convert it to another type.

It will only looks for sufficient resolver, firstly will looks for exactly match class type, if not then will looks for closets parent class or parent interface. If will find resolver for parent class or parent interface at the same level, then will get parent super class as first. If will find only closets super interfaces (at the same level) then will throw exception... after successful found resolver it converts from given object to some instance which extends AbstractJsonType through method ObjectToJsonTypeConverter.convertToJsonTypeOrEmpty(PrimitiveJsonTypesResolver primitiveJsonTypesResolver, Object propertyValue, String propertyKey)

Parameters:

properties - Java Map with properties

includeDomainKeys - domain head keys which should be parsed to json
example properties:
object1.field1=value1
object1.field2=value2
someObject2.field2=value3
filter "object1"
will parse only nested domain for "object1"

Returns:

simple String with json

Throws:

ParsePropertiesException - when structure of properties is not compatible with json structure

setPropertyKeysOrderResolver

public void setPropertyKeysOrderResolver(PropertyKeysOrderResolver propertyKeysOrderResolver)

It change implementation of order gathering keys from properties

Parameters:

propertyKeysOrderResolver - another implementation of get ordered properties keys