dk.heick.properties.collections

Class PropertiesJavaDefinitionPrinter

java.lang.Object

dk.heick.properties.collections.PropertiesJavaDefinitionPrinter

public class PropertiesJavaDefinitionPrinter
extends Object

This will take a Properties instance a generate public static final Property.... definitions.
It will try to load the comments if they are available.

This is a convenient class when converting your existing properties handling to use this library.

If suggestType is true and the value not null, it will try an analyze the value to see which matches best and output that type.
Otherwise it will make a "dummy" definition which do not compile since the generator have no idea of type, default values and PropertyIO.

Has been a part of the library since 1.2 but refactored in 1.5 Be aware of :

• The likelyhood that a file or directory validates is small, and will properly end up as StringPropertyTypes. Manuel check this.
• The default type is StringPropertyType, the is no matches on the distinct types.

The following properties is not tested for, hence these are no part of the generated properties, be aware of this.

• FilenameFilterPropertyType
• EnumPropertyType - Demands constructor input.
• FileStructurePropertyType - Demands node structor as constructor input.
• ListKeyValuePropertyType - Demands knowledge of types to expect.
• ListPropertyType - It tries to determine of any string value is a list of types, but no always succesfull.
• RegularExpressionPropertyType - Demands constructor input.
• SequencePropertyType - Will be determined as an integer.
• StringPropertiesPropertyType - Difficult to determine.
• RangePropertyType - Difficult to determine.
• DateFormatPropertyType - To many resulting in this type, not constrictive enough.
• DecimalFormatPropertyType - To many resulting in this type, not constrictive enough.

Since:

1.5

Author:

Frederik Heick

See Also:

CommentedProperties

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	PropertiesJavaDefinitionPrinter.ListTypedJavaDefinition
(package private) static class	PropertiesJavaDefinitionPrinter.TypedJavaDefinition

Constructor Summary

Constructors

Constructor and Description
PropertiesJavaDefinitionPrinter()

Method Summary

Modifier and Type	Method and Description
static List<String>	generateJavaDefinitionsAsList(CommentedProperties properties, boolean suggestType, boolean writeJavaClassComments, boolean writePropertyJavaComments, boolean writePropertyDescription, boolean writePropertyDescriptionInSeperateInterface) Generates java code, from a commented properties instance.
static List<String>	generateJavaDefinitionsAsList(File file, boolean suggestType, boolean writeJavaClassComments, boolean writePropertyJavaComments, boolean writePropertyDescription, boolean writePropertyDescriptionInSeperateInterface) Loads a file into a CommentedProperties instance and parses the properties.
static List<String>	generateJavaDefinitionsAsList(Properties properties, boolean suggestType) Generates java code, from a properties instance.
static List<String>	generateJavaDefinitionsAsList(PropertyIO io, boolean suggestType) Use a PropertyIO to load the properties that shall be parsed.
static List<String>	generateJavaDefinitionsAsList(String text, boolean suggestType, boolean writeJavaClassComments, boolean writePropertyJavaComments, boolean writePropertyDescription, boolean writePropertyDescriptionInSeperateInterface) Loads a text into a CommentedProperties instance and parses the properties.
static boolean	getBooleanParameter(String value, boolean defaultValue) Gets a boolean value from a string value.
static org.apache.commons.logging.Log	getLogger()
static void	main(String[] args)

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertiesJavaDefinitionPrinter

public PropertiesJavaDefinitionPrinter()

Method Detail

generateJavaDefinitionsAsList

public static List<String> generateJavaDefinitionsAsList(String text,
                                                         boolean suggestType,
                                                         boolean writeJavaClassComments,
                                                         boolean writePropertyJavaComments,
                                                         boolean writePropertyDescription,
                                                         boolean writePropertyDescriptionInSeperateInterface)
                                                  throws IOException

Loads a text into a CommentedProperties instance and parses the properties.

Parameters:

text - the text to parse.

suggestType - should the generator, suggest a type property properly will be or just return a dummy type.

writeJavaClassComments - Taking all the lines starting with '##' before the first property and writes as Class Javadoc. Ignoring all lines that starts with '##!'

writePropertyJavaComments - Taking all the lines starting with '#' or '!' before a property and writes as it as Javadoc for the Property . Ignoring all lines that starts with '#!'.

writePropertyDescription - Taking all the lines starting with '#' or '!' before a property and writes as it as description string for the Property. Ignoring all lines that starts with '#!'.

writePropertyDescriptionInSeperateInterface - As in 'Write Property Description',but the description will be put in a seperate interface to avoid the Property definition line to get exceedingly long.

Returns:

a list of generate java code lines.

Throws:

IOException - if any error generating the code.

See Also:

CommentedProperties

generateJavaDefinitionsAsList

public static List<String> generateJavaDefinitionsAsList(File file,
                                                         boolean suggestType,
                                                         boolean writeJavaClassComments,
                                                         boolean writePropertyJavaComments,
                                                         boolean writePropertyDescription,
                                                         boolean writePropertyDescriptionInSeperateInterface)
                                                  throws IOException

Loads a file into a CommentedProperties instance and parses the properties.

Parameters:

file - the file to load.

suggestType - should the generator, suggest a type property properly will be or just return a dummy type.

writeJavaClassComments - Taking all the lines starting with '##' before the first property and writes as Class Javadoc. Ignoring all lines that starts with '##!'

writePropertyJavaComments - Taking all the lines starting with '#' or '!' before a property and writes as it as Javadoc for the Property . Ignoring all lines that starts with '#!'.

writePropertyDescription - Taking all the lines starting with '#' or '!' before a property and writes as it as description string for the Property. Ignoring all lines that starts with '#!'.

writePropertyDescriptionInSeperateInterface - As in 'Write Property Description',but the description will be put in a seperate interface to avoid the Property definition line to get exceedingly long.

Returns:

a list of generate java code lines.

Throws:

IOException - if any error generating the code.

generateJavaDefinitionsAsList

public static List<String> generateJavaDefinitionsAsList(PropertyIO io,
                                                         boolean suggestType)

Use a PropertyIO to load the properties that shall be parsed.
Since this is a PropertyIO no comments can be parsed.

Parameters:

io - the PropertyIO to load properties from.

suggestType - should the generator, suggest a type property properly will be or just return a dummy type.

Returns:

a list of generate java code lines.

See Also:

PropertyIO

generateJavaDefinitionsAsList

public static List<String> generateJavaDefinitionsAsList(Properties properties,
                                                         boolean suggestType)

Generates java code, from a properties instance.

Parameters:

properties - the properties

suggestType - suggestType should the generator, suggest a type property properly will be or just return a dummy type.

Returns:

a list of generate java code lines.

See Also:

Properties

main

public static void main(String[] args)

getBooleanParameter

public static boolean getBooleanParameter(String value,
                                          boolean defaultValue)

Gets a boolean value from a string value.

Parameters:

value - the string value

defaultValue - the default if the string is null.

Returns:

true if the string is "true", false if the string is "false", otherwise defaultValue.

generateJavaDefinitionsAsList

public static List<String> generateJavaDefinitionsAsList(CommentedProperties properties,
                                                         boolean suggestType,
                                                         boolean writeJavaClassComments,
                                                         boolean writePropertyJavaComments,
                                                         boolean writePropertyDescription,
                                                         boolean writePropertyDescriptionInSeperateInterface)

Generates java code, from a commented properties instance.

Parameters:

properties - the commented properties

suggestType - should the generator, suggest a type property properly will be or just return a dummy type.

writeJavaClassComments - Taking all the lines starting with '##' before the first property and writes as Class Javadoc. Ignoring all lines that starts with '##!'

writePropertyJavaComments - Taking all the lines starting with '#' or '!' before a property and writes as it as Javadoc for the Property . Ignoring all lines that starts with '#!'.

writePropertyDescription - Taking all the lines starting with '#' or '!' before a property and writes as it as description string for the Property. Ignoring all lines that starts with '#!'.

writePropertyDescriptionInSeperateInterface - As in 'Write Property Description',but the description will be put in a seperate interface to avoid the Property definition line to get exceedingly long.

Returns:

a list of generate java code lines.

See Also:

CommentedProperties

getLogger

public static org.apache.commons.logging.Log getLogger()