org.nuiton.io.xpp3

Class PropertyMapper

java.lang.Object

org.nuiton.io.xpp3.PropertyMapper

Direct Known Subclasses:

AttributeValueToProperty, TagContentToProperty, TagTextContentToProperty

public abstract class PropertyMapper
extends Object

A abstract object to map an xml value (tag or attribute, or esle?) to a pojo property.

Two implementations are given :

• TagTextContentToProperty to map the text content of a tag to a pojo's property
• AttributeValueToProperty to map the text content of a tag to a pojo's property

Since:

1.0.3

Author:

tchemit

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<?>	containerType the type of the pojo container of the property
protected PropertyDescriptor	descriptor the pojo's property descriptor
protected String	name name of tag.
protected boolean	onlyOne a flag to check to use only once the mapper.
protected String	propertyName the pojo's property to set
static com.google.common.base.Function<String,String>	TAG_NAME_TRANSFORMER
protected DataConverter	type the converter from xml to pojo's property type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PropertyMapper(String tagName, String propertyName, Class<?> containerType, DataConverter type, boolean onlyOne, PropertyDescriptor descriptor)

Method Summary

Methods

Modifier and Type	Method and Description
Class<?>	getContainerType()
protected abstract Object	getDataFromXml(org.codehaus.plexus.util.xml.pull.XmlPullParser parser)
PropertyDescriptor	getDescriptor()
protected static PropertyDescriptor	getDescriptor(Class<?> containerType, String propertyName)
static String	getMapperForAttribute(Class<?> type, String attributeName)
static String	getMapperForTag(Class<?> type)
String	getName()
String	getPropertyName()
String	getTagName()
DataConverter	getType()
protected String	getXmlName()
boolean	isOnlyOne()
protected void	registerMapper(Map<String,PropertyMapper> allMappers, Class<?> containerType, String tagName, String attributeName)
void	setProperty(Object src, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Set<String> parsed, boolean strict)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected final String name

name of tag.

propertyName

protected final String propertyName

the pojo's property to set

type

protected final DataConverter type

the converter from xml to pojo's property type

containerType

protected final Class<?> containerType

the type of the pojo container of the property

descriptor

protected final PropertyDescriptor descriptor

the pojo's property descriptor

onlyOne

protected final boolean onlyOne

a flag to check to use only once the mapper. (should not be used for attributes implementations).

TAG_NAME_TRANSFORMER

public static final com.google.common.base.Function<String,String> TAG_NAME_TRANSFORMER

Constructor Detail

PropertyMapper

protected PropertyMapper(String tagName,
              String propertyName,
              Class<?> containerType,
              DataConverter type,
              boolean onlyOne,
              PropertyDescriptor descriptor)

Method Detail

getXmlName

protected String getXmlName()

getDataFromXml

protected abstract Object getDataFromXml(org.codehaus.plexus.util.xml.pull.XmlPullParser parser)
                                  throws Exception

Throws:

Exception

setProperty

public void setProperty(Object src,
               org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
               Set<String> parsed,
               boolean strict)
                 throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
                        IOException

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

IOException

getDescriptor

public PropertyDescriptor getDescriptor()

isOnlyOne

public boolean isOnlyOne()

getPropertyName

public String getPropertyName()

getTagName

public String getTagName()

getType

public DataConverter getType()

getContainerType

public Class<?> getContainerType()

getName

public String getName()

toString

public String toString()

Overrides:

toString in class Object

getMapperForTag

public static String getMapperForTag(Class<?> type)

getMapperForAttribute

public static String getMapperForAttribute(Class<?> type,
                           String attributeName)

getDescriptor

protected static PropertyDescriptor getDescriptor(Class<?> containerType,
                               String propertyName)
                                           throws IntrospectionException

Throws:

IntrospectionException

registerMapper

protected void registerMapper(Map<String,PropertyMapper> allMappers,
                  Class<?> containerType,
                  String tagName,
                  String attributeName)