org.yarnandtail.andhow.export

Class ExportCollector

java.lang.Object

org.yarnandtail.andhow.export.ExportCollector

public class ExportCollector
extends Object

Implementations of Collector that can be used collect a stream() of PropertyExports into key-value pair Maps or Properties.

See AndHow#export() for export details and examples.

Method Summary

Modifier and Type	Method and Description
static org.yarnandtail.andhow.export.ExportCollector.ObjectMap	objectMap() Returns a Collector that collects PropertyExports into a Map<String, Object> collection of key-value pairs.
static org.yarnandtail.andhow.export.ExportCollector.ObjectProperties	objectProperties(Object nullValue) Returns a Collector that collects PropertyExports into a Properties object with key-value entries that have Strings keys and Object values.
static org.yarnandtail.andhow.export.ExportCollector.StringMap	stringMap() Returns a Collector that collects PropertyExports into a Map<String, String> collection of key-value pairs.
static org.yarnandtail.andhow.export.ExportCollector.StringProperties	stringProperties(String nullValueString) Returns a Collector that collects PropertyExports into a Properties object with key-value entries that are Strings.

Methods inherited from class java.lang.Object

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

Method Detail

stringMap

public static org.yarnandtail.andhow.export.ExportCollector.StringMap stringMap()

Returns a Collector that collects PropertyExports into a Map<String, String> collection of key-value pairs.

Usage example:

 Map<String, String> export =
  AndHow.instance().export(MyClass.class)
    .collect(ExportCollector.stringMap());
 

Note: This method calls PropertyExport.getValueAsString() for the 'value' part of the key-value pair. That value can be remapped - See PropertyExport.mapValueAsString(String).

See AndHow#export() for export details and more examples.

Returns:

A Collector that creates a Map<String, String> from a PropertyExport stream.

stringProperties

public static org.yarnandtail.andhow.export.ExportCollector.StringProperties stringProperties(String nullValueString)

Returns a Collector that collects PropertyExports into a Properties object with key-value entries that are Strings.

Usage example:

 Map<String, String> export =
  AndHow.instance().export(MyClass.class)
    .collect(ExportCollector.stringProperties());
 

Note: This method calls PropertyExport.getValueAsString() for the 'value' part of the key-value pair. That value can be remapped - See PropertyExport.mapValueAsString(String).

See AndHow#export() for export details and more examples.

Parameters:

nullValueString - The value to use for Properties that have a null value, since Properties cannot contain null values.

Returns:

A Collector that creates a Properties with String values from a PropertyExport stream.

objectMap

public static org.yarnandtail.andhow.export.ExportCollector.ObjectMap objectMap()

Returns a Collector that collects PropertyExports into a Map<String, Object> collection of key-value pairs.

Usage example:

 Map<String, String> export =
  AndHow.instance().export(MyClass.class)
    .collect(ExportCollector.objectMap());
 

Note: This method calls PropertyExport.getValue() for the 'value' part of the key-value pair. That value can be remapped - See PropertyExport.mapValue(Object).

See AndHow#export() for export details and more examples.

Returns:

A Collector that creates a Map<String, Object> from a PropertyExport stream.

objectProperties

public static org.yarnandtail.andhow.export.ExportCollector.ObjectProperties objectProperties(Object nullValue)

Returns a Collector that collects PropertyExports into a Properties object with key-value entries that have Strings keys and Object values.

Usage example:

 Map<String, String> export =
  AndHow.instance().export(MyClass.class)
    .collect(ExportCollector.objectProperties());
 

Note: This method calls PropertyExport.getValue() for the 'value' part of the key-value pair. That value can be remapped - See PropertyExport.mapValue(Object).

See AndHow#export() for export details and more examples.

Parameters:

nullValue - The value to use for Properties that have a null value, since Properties cannot contain null values.

Returns:

A Collector that creates a Properties with String keys and Object values from a PropertyExport stream.