org.microbean.maven.cdi

Class YamlSettingsBuilder

java.lang.Object

org.microbean.maven.cdi.YamlSettingsBuilder

All Implemented Interfaces:

SettingsBuilder

@Alternative
 @ApplicationScoped
public class YamlSettingsBuilder
extends Object
implements SettingsBuilder

A SettingsBuilder implementation that behaves like a DefaultSettingsBuilder implementation but without needlessly requiring round-trip serialization and deserialization of the underlying settings, and that reads YAML files instead of XML files.

Author:

Laird Nelson

See Also:

build(SettingsBuildingRequest), DefaultSettingsBuilder

Constructor Summary

Constructors

Constructor and Description
YamlSettingsBuilder() Creates a new YamlSettingsBuilder with a DefaultSettingsValidator and a MavenSettingsMerger.
YamlSettingsBuilder(SettingsValidator settingsValidator, MavenSettingsMerger merger) Creates a new YamlSettingsBuilder.

Method Summary

Modifier and Type	Method and Description
SettingsBuildingResult	build(SettingsBuildingRequest request) Deserializes a Settings from a stream-based source represented by the supplied SettingsBuildingRequest and returns it wrapped by a SettingsBuildingResult in much the same manner as the DefaultSettingsBuilder.build(SettingsBuildingRequest) method, but using YAML instead of XML, and performing interpolation in a more efficient manner.
Settings	read(Source source, boolean strict, org.codehaus.plexus.interpolation.Interpolator interpolator, SettingsProblemCollector problemCollector) Given a Source, reads settings information from it and creates a new Settings object and returns it.

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlSettingsBuilder

public YamlSettingsBuilder()

Creates a new YamlSettingsBuilder with a DefaultSettingsValidator and a MavenSettingsMerger.

See Also:

YamlSettingsBuilder(SettingsValidator, MavenSettingsMerger)

YamlSettingsBuilder

@Inject
public YamlSettingsBuilder(SettingsValidator settingsValidator,
                                   MavenSettingsMerger merger)

Creates a new YamlSettingsBuilder.

Parameters:

settingsValidator - a SettingsValidator implementation that will validate the Settings object once it has been successfully deserialized; if null then a DefaultSettingsValidator implementation will be used instead

merger - a MavenSettingsMerger that will be used to merge global and user-specific Settings objects; if null, then a new MavenSettingsMerger will be used instead

Method Detail

build

public SettingsBuildingResult build(SettingsBuildingRequest request)
                             throws SettingsBuildingException

Deserializes a Settings from a stream-based source represented by the supplied SettingsBuildingRequest and returns it wrapped by a SettingsBuildingResult in much the same manner as the DefaultSettingsBuilder.build(SettingsBuildingRequest) method, but using YAML instead of XML, and performing interpolation in a more efficient manner.

This method never returns null.

Overrides of this method must not return null.

Specified by:

build in interface SettingsBuilder

Parameters:

request - the SettingsBuildingRequest representing the settings location; must not be null

Returns:

a non-null SettingsBuildingResult

Throws:

NullPointerException - if request is null

SettingsBuildingException - if an error occurred, but also see the return value of the SettingsBuildingResult.getProblems() method

See Also:

read(Source, boolean, Interpolator, SettingsProblemCollector)

read

public Settings read(Source source,
                     boolean strict,
                     org.codehaus.plexus.interpolation.Interpolator interpolator,
                     SettingsProblemCollector problemCollector)
              throws IOException,
                     SettingsParseException

Given a Source, reads settings information from it and creates a new Settings object and returns it.

This method may return null.

Overrides of this method are permitted to return null.

Parameters:

source - the Source representing the location of the settings; may be null in which case null will be returned

strict - whether or not strictness should be in effect

interpolator - an Interpolator for interpolating values within the settings information; may be null

problemCollector - a SettingsProblemCollector to accumulate error information; must not be null

Returns:

a Settings, or null

Throws:

NullPointerException - if problemCollector is null

IOException - if an input or output error occurred

SettingsParseException - if the settings information could not be parsed as a YAML 1.1 document