com.fortyoneconcepts.valjogen.model

Class Configuration

java.lang.Object

com.fortyoneconcepts.valjogen.model.Configuration

All Implemented Interfaces:

ConfigurationOptionKeys

public class Configuration
extends Object
implements ConfigurationOptionKeys

Contains methods that return the effective configuration taking processor options and annotated elements into account. All getters return simple values. No nulls are ever returned.

Field Summary

Fields

Modifier and Type	Field and Description
private VALJOConfigure	configureAnnotation
private VALJOGenerate	generateAnnotation
private HashMap<String,Supplier<String>>	macros This decl only shows the custom macros.
private Locale	optDefaultLocale
private Map<String,String>	options
private Date	processorExecutionDate
private String	sourceElementName
private SourceVersion	targetSourceVersion

Fields inherited from interface com.fortyoneconcepts.valjogen.model.ConfigurationOptionKeys

baseClazzConstructors, baseClazzName, clazzAnnotations, clazzJavaDoc, clazzModifiers, comment, comparableMembers, customJavaTemplateFileName, dataConversion, debugStringTemplates, ensureNotNullEnabled, equalsEnabled, extraInterfaceNames, finalMembersAndParametersEnabled, finalMethodsEnabled, forceThisAsImmutableSetterReturnType, getterPrefixes, hashEnabled, headerFileName, ignoreMalformedProperties, importClasses, insertInheritDocOnMethodsEnabled, lineWidth, localeTag, LOGFILE, logLevel, memberAnnotations, methodAnnotations, mutability, name, outputPackage, serialVersionUID, setterPrefixes, SOURCEPATH, staticFactoryMethodEnabled, suggestedVariablesPrefix, synchronizedAccessEnabled, toStringEnabled, warnAboutSynthesisedNames

Constructor Summary

Constructors

Constructor and Description
Configuration(String sourceElementName, SourceVersion targetSourceVersion, VALJOGenerate annotation, Locale optDefaultLocale, Map<String,String> options)
Configuration(String sourceElementName, SourceVersion targetSourceVersion, VALJOGenerate annotation, VALJOConfigure configureAnnotation, Locale optDefaultLocale, Map<String,String> options)

Method Summary

Modifier and Type	Method and Description
String[]	getBaseClazzConstructors()
String	getBaseClazzName()
private boolean	getBooleanValue(String optionKey, boolean defaultValue)
String[]	getClazzAnnotations()
String	getClazzJavaDoc()
EnumSet<Modifier>	getClazzModifiers()
String	getComment()
String[]	getComparableMembers()
private Properties	getConfigFileOptions() Return a property object with deserialized configuration file options (if the file exist).
String	getCustomJavaTemplateFileName()
DataConversion	getDataConversion()
private <T extends Enum<T>> T	getEnumValue(String optionKey, Class<T> enumType, T defaultValue)
Date	getExecutionDate()
String[]	getExtraInterfaces()
String[]	getGetterPrefixes()
String	getHeaderFileName()
String[]	getImportClasses()
private int	getIntValue(String optionKey, int defaultValue)
int	getLineWidth()
Locale	getLocale()
String	getLocaleTag()
String	getLogFile()
Level	getLogLevel()
private long	getLongValue(String optionKey, long defaultValue)
List<KeyValuePair<String,String>>	getMemberAnnotations()
List<KeyValuePair<String,String>>	getMemberAnnotations(Predicate<String> overloadNameFilter)
List<KeyValuePair<String,String>>	getMethodAnnotations()
List<KeyValuePair<String,String>>	getMethodAnnotations(Predicate<String> overloadNameFilter)
Mutability	getMutability()
String	getName()
String	getPackage()
long	getSerialVersionUID()
boolean	getSerialVersionUIDSpecified()
String[]	getSetterPrefixes()
String	getSourceElementName()
String	getSourcePath()
private String[]	getStringArrayValue(String optionKey, String[] defaultValue)
private String	getStringValue(String optionKey, String... rawDefaultValues)
String	getSuggestedVariablesPrefix()
SourceVersion	getTargetSourceVersion() The java source target version that generated code must conform to.
boolean	isDebugStringTemplatesEnabled()
boolean	isEnsureNotNullEnabled()
boolean	isEqualsEnabled()
boolean	isFinalMembersAndParametersEnabled()
boolean	isFinalMethodsEnabled()
boolean	isHashEnabled()
boolean	isInsertInheritDocOnMethodsEnabled()
boolean	isMalformedPropertiesIgnored()
boolean	isStaticFactoryMethodEnabled()
boolean	isSynchronizedAccessEnabled()
boolean	isTargetSourceVersionJava6OrHigher() Return true if java source target version is 6.0 or higher.
boolean	isTargetSourceVersionJava7OrHigher() Return true if java source target version is 7.0 or higher.
boolean	isTargetSourceVersionJava8OrHigher() Return true if java source target version is 8.0 or higher.
boolean	isThisAsImmutableSetterReturnTypeEnabled()
boolean	isToStringEnabled()
boolean	isWarningAboutSynthesisedNamesEnabled()
private List<KeyValuePair<String,String>>	pairsToMap(String[] keyValueStrings, Predicate<String> keyFilter)
private String	preformMagicReplacements(String rawValue)
private String[]	preformMagicReplacements(String[] rawValues)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

sourceElementName

private final String sourceElementName

generateAnnotation

private final VALJOGenerate generateAnnotation

configureAnnotation

private final VALJOConfigure configureAnnotation

optDefaultLocale

private final Locale optDefaultLocale

options

private final Map<String,String> options

processorExecutionDate

private final Date processorExecutionDate

targetSourceVersion

private final SourceVersion targetSourceVersion

macros

private final HashMap<String,Supplier<String>> macros

This decl only shows the custom macros. In addition system properties will be added as macros too.

Constructor Detail

Configuration

public Configuration(String sourceElementName,
                     SourceVersion targetSourceVersion,
                     VALJOGenerate annotation,
                     Locale optDefaultLocale,
                     Map<String,String> options)

Configuration

public Configuration(String sourceElementName,
                     SourceVersion targetSourceVersion,
                     VALJOGenerate annotation,
                     VALJOConfigure configureAnnotation,
                     Locale optDefaultLocale,
                     Map<String,String> options)

Method Detail

getTargetSourceVersion

public SourceVersion getTargetSourceVersion()

The java source target version that generated code must conform to.

Returns:

Required java source version of generated code.

isTargetSourceVersionJava6OrHigher

public boolean isTargetSourceVersionJava6OrHigher()

Return true if java source target version is 6.0 or higher.

Returns:

True if at least Java 6.0 version

isTargetSourceVersionJava7OrHigher

public boolean isTargetSourceVersionJava7OrHigher()

Return true if java source target version is 7.0 or higher.

Returns:

True if at least Java 7.0 version

isTargetSourceVersionJava8OrHigher

public boolean isTargetSourceVersionJava8OrHigher()

Return true if java source target version is 8.0 or higher.

Returns:

True if at least Java 8.0 version

getConfigFileOptions

private final Properties getConfigFileOptions()

Return a property object with deserialized configuration file options (if the file exist).

Returns:

The properties from the configuration file or empty object otherwise.

getSourceElementName

public String getSourceElementName()

getExecutionDate

public Date getExecutionDate()

getLocaleTag

public String getLocaleTag()

getLocale

public Locale getLocale()

getLineWidth

public int getLineWidth()

getClazzModifiers

public EnumSet<Modifier> getClazzModifiers()

getMutability

public Mutability getMutability()

getDataConversion

public DataConversion getDataConversion()

isFinalMembersAndParametersEnabled

public boolean isFinalMembersAndParametersEnabled()

isFinalMethodsEnabled

public boolean isFinalMethodsEnabled()

isStaticFactoryMethodEnabled

public boolean isStaticFactoryMethodEnabled()

isEnsureNotNullEnabled

public boolean isEnsureNotNullEnabled()

isSynchronizedAccessEnabled

public boolean isSynchronizedAccessEnabled()

isMalformedPropertiesIgnored

public boolean isMalformedPropertiesIgnored()

getPackage

public String getPackage()

getName

public String getName()

getImportClasses

public String[] getImportClasses()

getExtraInterfaces

public String[] getExtraInterfaces()

getGetterPrefixes

public String[] getGetterPrefixes()

getSetterPrefixes

public String[] getSetterPrefixes()

isThisAsImmutableSetterReturnTypeEnabled

public boolean isThisAsImmutableSetterReturnTypeEnabled()

getBaseClazzName

public String getBaseClazzName()

getBaseClazzConstructors

public String[] getBaseClazzConstructors()

getSuggestedVariablesPrefix

public String getSuggestedVariablesPrefix()

getSerialVersionUID

public long getSerialVersionUID()

getSerialVersionUIDSpecified

public boolean getSerialVersionUIDSpecified()

isEqualsEnabled

public boolean isEqualsEnabled()

isHashEnabled

public boolean isHashEnabled()

getComparableMembers

public String[] getComparableMembers()

isToStringEnabled

public boolean isToStringEnabled()

isInsertInheritDocOnMethodsEnabled

public boolean isInsertInheritDocOnMethodsEnabled()

getHeaderFileName

public String getHeaderFileName()

getCustomJavaTemplateFileName

public String getCustomJavaTemplateFileName()

getClazzJavaDoc

public String getClazzJavaDoc()

getClazzAnnotations

public String[] getClazzAnnotations()

getMethodAnnotations

public List<KeyValuePair<String,String>> getMethodAnnotations()

getMethodAnnotations

public List<KeyValuePair<String,String>> getMethodAnnotations(Predicate<String> overloadNameFilter)

getMemberAnnotations

public List<KeyValuePair<String,String>> getMemberAnnotations()

getMemberAnnotations

public List<KeyValuePair<String,String>> getMemberAnnotations(Predicate<String> overloadNameFilter)

isWarningAboutSynthesisedNamesEnabled

public boolean isWarningAboutSynthesisedNamesEnabled()

getLogLevel

public Level getLogLevel()

isDebugStringTemplatesEnabled

public boolean isDebugStringTemplatesEnabled()

getComment

public String getComment()

getSourcePath

public String getSourcePath()

getLogFile

public String getLogFile()

preformMagicReplacements

private String preformMagicReplacements(String rawValue)

preformMagicReplacements

private String[] preformMagicReplacements(String[] rawValues)

getStringValue

private String getStringValue(String optionKey,
                              String... rawDefaultValues)

getStringArrayValue

private String[] getStringArrayValue(String optionKey,
                                     String[] defaultValue)

getEnumValue

private <T extends Enum<T>> T getEnumValue(String optionKey,
                                           Class<T> enumType,
                                           T defaultValue)

getBooleanValue

private boolean getBooleanValue(String optionKey,
                                boolean defaultValue)

getIntValue

private int getIntValue(String optionKey,
                        int defaultValue)

getLongValue

private long getLongValue(String optionKey,
                          long defaultValue)

pairsToMap

private List<KeyValuePair<String,String>> pairsToMap(String[] keyValueStrings,
                                                     Predicate<String> keyFilter)

toString

public String toString()

Overrides:

toString in class Object