Class Configuration

java.lang.Object

java.util.AbstractMap<String,Object>

java.util.HashMap<String,Object>

java.util.LinkedHashMap<String,Object>

io.micronaut.projectgen.core.feature.config.Configuration

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>, SequencedMap<String,Object>

Direct Known Subclasses:

ApplicationConfiguration, BootstrapConfiguration

public class Configuration
extends LinkedHashMap<String,Object>

Models application environment configuration to specify where the configuration is rooted for the given configuration values (key/value pairs).

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BLANK_LINE_PREFIX
static final String	COMMENT_PREFIX
static final List<String>	PREFIXES

Constructor Summary

Constructors

Constructor	Description
Configuration(@NonNull String path, @NonNull String fileName, @NonNull String templateKey)	A configuration rooted at path, with the given map of configurations.

Method Summary

Modifier and Type	Method	Description
void	addCommaSeparatedValue(String key, String value)
void	addListItem(String key, String value)
Configuration	addNested(NestedConfiguration nestedConfiguration)	Adds nested configuration.
Configuration	addNested(String path, Object value)	Add a nested value for the given path.
Configuration	addNested(Map<String,Object> values)	Add nested values for the given path.
void	blankLine()	Add a blank line.
void	comment(String comment)
boolean	containsKey(Object key)
boolean	equals(Object o)
Object	get(Object key)
@NonNull String	getFileName()
@NonNull String	getFullPath(String extension)
@NonNull String	getPath()
@NonNull String	getTemplateKey()
int	hashCode()
static String	sourceSetPath(@NonNull String sourceSet)	configuration path for source set.

Methods inherited from class LinkedHashMap

clear, containsValue, entrySet, forEach, getOrDefault, keySet, newLinkedHashMap, putFirst, putLast, removeEldestEntry, replaceAll, reversed, sequencedEntrySet, sequencedKeySet, sequencedValues, values

Methods inherited from class HashMap

clone, compute, computeIfAbsent, computeIfPresent, isEmpty, merge, newHashMap, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class AbstractMap

toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Map

compute, computeIfAbsent, computeIfPresent, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from interface SequencedMap

firstEntry, lastEntry, pollFirstEntry, pollLastEntry

Field Details

COMMENT_PREFIX

public static final String COMMENT_PREFIX

See Also:

• Constant Field Values

BLANK_LINE_PREFIX

public static final String BLANK_LINE_PREFIX

See Also:

• Constant Field Values

PREFIXES

public static final List<String> PREFIXES

Constructor Details

Configuration

public Configuration(@NonNull
 @NonNull String path,
 @NonNull
 @NonNull String fileName,
 @NonNull
 @NonNull String templateKey)

A configuration rooted at path, with the given map of configurations.

Parameters:

path - configuration path

fileName - Filename

templateKey - Template Key

Method Details

sourceSetPath

public static String sourceSetPath(@NonNull
 @NonNull String sourceSet)

configuration path for source set.

Parameters:

sourceSet - where the configuration is rooted, e.g. main, test

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,Object>

Overrides:

containsKey in class HashMap<String,Object>

get

public Object get(Object key)

Specified by:

get in interface Map<String,Object>

Overrides:

get in class LinkedHashMap<String,Object>

addNested

public Configuration addNested(String path,
 Object value)

Add a nested value for the given path.

Parameters:

path - The path

value - The value

Returns:

this configuration

addNested

public Configuration addNested(NestedConfiguration nestedConfiguration)

Adds nested configuration.

Parameters:

nestedConfiguration - Nested Configuration

Returns:

this configuration

addNested

public Configuration addNested(Map<String,Object> values)

Add nested values for the given path.

Parameters:

values - A map of path to value entries

Returns:

this configuration

getPath

@NonNull
public @NonNull String getPath()

Returns:

path

getFileName

@NonNull
public @NonNull String getFileName()

Returns:

filename

getFullPath

@NonNull
public @NonNull String getFullPath(String extension)

Parameters:

extension - extension

Returns:

full path

getTemplateKey

@NonNull
public @NonNull String getTemplateKey()

Returns:

template key

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<String,Object>

Overrides:

equals in class AbstractMap<String,Object>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,Object>

Overrides:

hashCode in class AbstractMap<String,Object>

addCommaSeparatedValue

public void addCommaSeparatedValue(String key,
 String value)

Parameters:

key - key

value - value

addListItem

public void addListItem(String key,
 String value)

Parameters:

key - key

value - value

comment

public void comment(String comment)

Parameters:

comment - a comment to a configuration file.

blankLine

public void blankLine()

Add a blank line.