PropertyExportImpl.PropertyExportWrap (AndHow Annotation Processor 1.5.0 API)

java.lang.Object
- org.yarnandtail.andhow.internal.export.PropertyExportImpl.PropertyExportWrap

All Implemented Interfaces:

PropertyExport

Enclosing class:

PropertyExportImpl
```
protected static class PropertyExportImpl.PropertyExportWrap
extends Object
implements PropertyExport
```
A wrapper class that make it easy to wrap, delegate and override methods.

Constructor Summary

Constructors
Constructor and Description

PropertyExportWrap(PropertyExport inner)
Construct a wrapper instance that wraps 'inner' and delegates to it for all methods.

Constructors
Constructor and Description
`PropertyExportWrap(PropertyExport inner)` Construct a wrapper instance that wraps 'inner' and delegates to it for all methods.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Exporter.EXPORT_CANONICAL_NAME`	`getCanonicalNameOption()` Option read from the containing `ManualExportAllowed` annotation to determine if the canonical name of the Property should be included.
`Class<?>`	`getContainingClass()` The class directly containing the Property.
`List<String>`	`getExportNames()` The complete list of export names for this property, which may be null, empty or many.
`Exporter.EXPORT_OUT_ALIASES`	`getOutAliasOption()` Option read from the containing `ManualExportAllowed` annotation to determine if 'out' aliases of the Property should be included.
`Property<?>`	`getProperty()` The Property being exported.
`Object`	`getValue()` Fetch the Object value of the Property, e.g., an Integer Property will return an Integer.
`String`	`getValueAsString()` Fetch the value as a String from the Property.
`PropertyExport`	`mapNames(List<String> exportNames)` Intended for using with Java `stream()`s, this method maps this instance to a new one with new export names.
`PropertyExport`	`mapValue(Object value)` Intended for using with Java `stream()`s, this method maps this instance to a new one with a new Object value for the Property, i.e., the 'value' part of a key-value pair.
`PropertyExport`	`mapValueAsString(String value)` Intended for using with Java `stream()`s, this method maps this instance to a new one with a new String value for the Property, i.e., the 'value' part of a key-value pair.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PropertyExportWrap
```
public PropertyExportWrap(PropertyExport inner)
```
    Construct a wrapper instance that wraps 'inner' and delegates to it for all methods.
    
    Parameters:
    
    inner - The instance to delegate to for methods.
- Method Detail
  - getProperty
```
public Property<?> getProperty()
```
    Description copied from interface: PropertyExport
    
    The Property being exported.
    
    Specified by:
    
    getProperty in interface PropertyExport
    
    Returns:
    
    A Property instance. Not null.
  - getContainingClass
```
public Class<?> getContainingClass()
```
    Description copied from interface: PropertyExport
    
    The class directly containing the Property.
    
    Specified by:
    
    getContainingClass in interface PropertyExport
    
    Returns:
    
    The containing class. Not null.
  - getCanonicalNameOption
```
public Exporter.EXPORT_CANONICAL_NAME getCanonicalNameOption()
```
    Description copied from interface: PropertyExport
    
    Option read from the containing ManualExportAllowed annotation to determine if the canonical name of the Property should be included.
    If included, the canonical name would be included in the list of names returned from PropertyExport.getExportNames() and then ultimately as one of the names in the final key-value pairs.
    
    Specified by:
    
    getCanonicalNameOption in interface PropertyExport
    
    Returns:
    
    An EXPORT_CANONICAL_NAME value. Not null.
  - getOutAliasOption
```
public Exporter.EXPORT_OUT_ALIASES getOutAliasOption()
```
    Description copied from interface: PropertyExport
    
    Option read from the containing ManualExportAllowed annotation to determine if 'out' aliases of the Property should be included.
    'Out' aliases are alternate names for a Property for the purpose of export, so generally they are intended to be included.
    
    Specified by:
    
    getOutAliasOption in interface PropertyExport
    
    Returns:
    
    An EXPORT_OUT_ALIASES value. Not null.
  - getExportNames
```
public List<String> getExportNames()
```
    Description copied from interface: PropertyExport
    
    The complete list of export names for this property, which may be null, empty or many.
    This method builds and returns the default export name list based on the PropertyExport.getCanonicalNameOption() & PropertyExport.getOutAliasOption() options, or, if PropertyExport.mapNames(List) was used to construct this instance, the list of names specified.
    See AndHow.export(Class[]) for an example that remaps export names.
    
    Specified by:
    
    getExportNames in interface PropertyExport
    
    Returns:
    
    A list of names which may be empty or null.
  - getValue
```
public Object getValue()
```
    Description copied from interface: PropertyExport
    Fetch the Object value of the Property, e.g., an Integer Property will return an Integer.
    Nominally this is the same as getProperty().getValue(), however, PropertyExport.mapValue(Object) can be used to rewrite the value. Take care to map the method that will be used by the collector you have chosen:
    - 'String' collectors call PropertyExport.getValueAsString(): use PropertyExport.mapValueAsString(String)
    - 'Object' collectors call PropertyExport.getValue(): use PropertyExport.mapValue(Object)
    Specified by:
    
    getValue in interface PropertyExport
    
    Returns:
    
    The value return from the Property getValue() method or a custom value. May be null.
  - getValueAsString
```
public String getValueAsString()
```
    Description copied from interface: PropertyExport
    Fetch the value as a String from the Property.
    Nominally this is the same as getProperty().getValueAsString(), however, PropertyExport.mapValueAsString(String) can be used to rewrite the value. Take care to map the method that will be used by the collector you have chosen:
    - 'String' collectors call PropertyExport.getValueAsString(): use PropertyExport.mapValueAsString(String)
    - 'Object' collectors call PropertyExport.getValue(): use PropertyExport.mapValue(Object)
    Implementation note: The nominal implementation of this method should call getProperty().getValueAsString() and not delegate to PropertyExport.getValue(), since the type returned by getValue may be overridden and not match the Property type.
    Specified by:
    
    getValueAsString in interface PropertyExport
    
    Returns:
    
    The value returned from the Properties getValueAsString method or a custom value. May be null.
  - mapNames
```
public PropertyExport mapNames(List<String> exportNames)
```
    Description copied from interface: PropertyExport
    
    Intended for using with Java stream()s, this method maps this instance to a new one with new export names.
    Calling PropertyExport.getExportNames() on the new instance returns the new exportNames. Specifying an empty or null list of names will remove this Property from export.
    See AndHow.export(Class[]) for an example that remaps export names.
    
    Specified by:
    
    mapNames in interface PropertyExport
    
    Parameters:
    
    exportNames - A new list of export names to be used, rather than the default ones.
    
    Returns:
    
    A new instance identical to the original, except it has new names.
  - mapValue
```
public PropertyExport mapValue(Object value)
```
    Description copied from interface: PropertyExport
    Intended for using with Java stream()s, this method maps this instance to a new one with a new Object value for the Property, i.e., the 'value' part of a key-value pair.
    Calling PropertyExport.getValue() on the new instance returns the new value, which may be null.
    This example uses mapValue() to multiply Property values by 2 if they are integers:
```
 Map<String, Object> export =
  AndHow.instance().export(MyClass.class)
   .map(p -> p.mapValue(
     (p.getValue() != null && p.getValue() instanceof Integer)
       ? (Integer)p.getValue() * 2:p.getValue()) )
   .collect(ExportCollector.objectMap());
 
```
    Take care to map the method that will be used by the collector you have chosen:
    - 'String' collectors call PropertyExport.getValueAsString(): use PropertyExport.mapValueAsString(String)
    - 'Object' collectors call PropertyExport.getValue(): use PropertyExport.mapValue(Object)
    Specified by:
    
    mapValue in interface PropertyExport
    
    Parameters:
    
    value - The new value to return for the value of this Property.
    
    Returns:
    
    A new instance identical to the original, except it has a new object value.
  - mapValueAsString
```
public PropertyExport mapValueAsString(String value)
```
    Description copied from interface: PropertyExport
    Intended for using with Java stream()s, this method maps this instance to a new one with a new String value for the Property, i.e., the 'value' part of a key-value pair.
    Calling PropertyExport.getValueAsString() on the new instance returns the new value, which may be null.
    This example uses mapValueAsString() to convert Property values to uppercase:
```
 Map<String, String> export =
  AndHow.instance().export(MyClass.class)
   .map( p -> p.mapValueAsString( p.getValueAsString() != null
     ? p.getValueAsString().toUpperCase():null) )
       .collect(ExportCollector.stringMap());
 
```
    Take care to map the method that will be used by the collector you have chosen:
    - 'String' collectors call PropertyExport.getValueAsString(): use PropertyExport.mapValueAsString(String)
    - 'Object' collectors call PropertyExport.getValue(): use PropertyExport.mapValue(Object)
    Specified by:
    
    mapValueAsString in interface PropertyExport
    
    Parameters:
    
    value - The new value to return for the String value of this Property.
    
    Returns:
    
    A new instance identical to the original, except it has a new String value.

Class PropertyExportImpl.PropertyExportWrap

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PropertyExportWrap

Method Detail

getProperty

getContainingClass

getCanonicalNameOption

getOutAliasOption

getExportNames

getValue

getValueAsString

mapNames

mapValue

mapValueAsString