Package net.solarnetwork.settings.support

Class BasicGroupSettingSpecifier

java.lang.Object

net.solarnetwork.settings.support.BaseSettingSpecifier

net.solarnetwork.settings.support.BasicGroupSettingSpecifier

All Implemented Interfaces:

GroupSettingSpecifier, MappableSpecifier, SettingSpecifier

public class BasicGroupSettingSpecifier
extends BaseSettingSpecifier
implements GroupSettingSpecifier

Basic implementation of GroupSettingSpecifier.

Version:

1.0

Author:

matt

Nested Class Summary

Nested classes/interfaces inherited from interface net.solarnetwork.settings.MappableSpecifier

MappableSpecifier.Mapper

Constructor Summary

Constructors

Constructor	Description
BasicGroupSettingSpecifier(String groupKey, List<SettingSpecifier> settings)	Construct with the group settings.
BasicGroupSettingSpecifier(String groupKey, List<SettingSpecifier> settings, boolean dynamic)	Construct with settings and dynamic flag.
BasicGroupSettingSpecifier(String groupKey, List<SettingSpecifier> settings, boolean dynamic, String footerText)	Construct with values.
BasicGroupSettingSpecifier(List<SettingSpecifier> settings)	Construct without a key.

Method Summary

Modifier and Type	Method	Description
String	getFooterText()	Localizable text to display at the end of the group's content.
List<SettingSpecifier>	getGroupSettings()	Get the settings in this group.
String	getKey()	Get the key for this setting.
boolean	isDynamic()	Get dynamic flag.
SettingSpecifier	mappedTo(String prefix)	Return a setting specifier mapped to a new path.
SettingSpecifier	mappedWithMapper(MappableSpecifier.Mapper mapper)	Return a setting specifier mapped to a new path, using a MappableSpecifier.Mapper.
SettingSpecifier	mappedWithPlaceholer(String template)	Return a setting specifier mapped to a new path, using a format template.
String	toString()

Methods inherited from class net.solarnetwork.settings.support.BaseSettingSpecifier

getTitle, getType, setTitle

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.solarnetwork.settings.SettingSpecifier

getTitle, getType

Constructor Details

BasicGroupSettingSpecifier

public BasicGroupSettingSpecifier(List<SettingSpecifier> settings)

Construct without a key. The dynamic property will be set to false.

Parameters:

settings - The group settings.

BasicGroupSettingSpecifier

public BasicGroupSettingSpecifier(String groupKey,
 List<SettingSpecifier> settings)

Construct with the group settings. The dynamic property will be set to false.

Parameters:

groupKey - The key for the entire group.

settings - The group settings.

BasicGroupSettingSpecifier

public BasicGroupSettingSpecifier(String groupKey,
 List<SettingSpecifier> settings,
 boolean dynamic)

Construct with settings and dynamic flag.

Parameters:

groupKey - The key for the entire group.

settings - The group settings.

dynamic - The dynamic flag.

BasicGroupSettingSpecifier

public BasicGroupSettingSpecifier(String groupKey,
 List<SettingSpecifier> settings,
 boolean dynamic,
 String footerText)

Construct with values.

Parameters:

groupKey - The key for the entire group.

settings - The group settings.

dynamic - The dynamic flag.

footerText - The footer text.

Method Details

getFooterText

public String getFooterText()

Description copied from interface: GroupSettingSpecifier

Localizable text to display at the end of the group's content.

Specified by:

getFooterText in interface GroupSettingSpecifier

Returns:

localizable

getGroupSettings

public List<SettingSpecifier> getGroupSettings()

Description copied from interface: GroupSettingSpecifier

Get the settings in this group.

Specified by:

getGroupSettings in interface GroupSettingSpecifier

Returns:

the list of group settings

isDynamic

public boolean isDynamic()

Description copied from interface: GroupSettingSpecifier

Get dynamic flag. A dynamic group is one that a user can manage any number of copies of the group settings, adding and removing as necessary.

Specified by:

isDynamic in interface GroupSettingSpecifier

Returns:

The dynamic flag.

getKey

public String getKey()

Description copied from interface: GroupSettingSpecifier

Get the key for this setting.

Specified by:

getKey in interface GroupSettingSpecifier

Returns:

the key to associate with this setting

mappedWithPlaceholer

public SettingSpecifier mappedWithPlaceholer(String template)

Description copied from interface: MappableSpecifier

Return a setting specifier mapped to a new path, using a format template.

Specified by:

mappedWithPlaceholer in interface MappableSpecifier

Parameters:

template - the format template

Returns:

the new instance

mappedTo

public SettingSpecifier mappedTo(String prefix)

Description copied from interface: MappableSpecifier

Return a setting specifier mapped to a new path.

This is to allow delegating setting specifiers to re-map the key.

Specified by:

mappedTo in interface MappableSpecifier

Parameters:

prefix - the new prefix to add to the key

Returns:

the new instance

mappedWithMapper

public SettingSpecifier mappedWithMapper(MappableSpecifier.Mapper mapper)

Description copied from interface: MappableSpecifier

Return a setting specifier mapped to a new path, using a MappableSpecifier.Mapper.

Specified by:

mappedWithMapper in interface MappableSpecifier

Parameters:

mapper - the mapper

Returns:

the new instance

toString

public String toString()

Overrides:

toString in class Object