com.paypal.butterfly.extensions.api

Class Extension<E>

java.lang.Object

com.paypal.butterfly.extensions.api.Extension<E>

public abstract class Extension<E>
extends java.lang.Object

A Butterfly third-party extension. It provides custom transformation templates and validations

Constructor Summary

Constructors

Constructor and Description
Extension()

Method Summary

Modifier and Type	Method and Description
protected E	add(java.lang.Class<? extends TransformationTemplate> templateClass) Adds a new transformation template class to the set
java.lang.Class<? extends TransformationTemplate>	automaticResolution(java.io.File applicationFolder) Butterfly might be able to automatically identify, based on the application content, the most applicable transformation template to transform it.
abstract java.lang.String	getDescription() Returns the extension description
protected org.apache.maven.model.Model	getRootPomFile(java.io.File folder) This is a convenience method in case the Extension subclass wants to implement its automaticResolution(File) method based on one or more Maven pom files
java.util.List<java.lang.Class<? extends TransformationTemplate>>	getTemplateClasses() Returns a read-only set containing all transformation template classes
abstract java.lang.String	getVersion() Returns the extension version
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Extension

public Extension()

Method Detail

add

protected final E add(java.lang.Class<? extends TransformationTemplate> templateClass)

Adds a new transformation template class to the set

Parameters:

templateClass - the transformation template class to be added to the extension

Returns:

this extension

getDescription

public abstract java.lang.String getDescription()

Returns the extension description

Returns:

the extension description

getVersion

public abstract java.lang.String getVersion()

Returns the extension version

Returns:

the extension version

getTemplateClasses

public final java.util.List<java.lang.Class<? extends TransformationTemplate>> getTemplateClasses()

Returns a read-only set containing all transformation template classes

Returns:

a read-only set containing all transformation template classes

automaticResolution

public java.lang.Class<? extends TransformationTemplate> automaticResolution(java.io.File applicationFolder)
                                                                      throws TemplateResolutionException

Butterfly might be able to automatically identify, based on the application content, the most applicable transformation template to transform it. If no template applies to the application content, a TemplateResolutionException is thrown explaining the reason why no template could be chosen.

Parameters:

applicationFolder - the folder where the code of the application to be transformed is

Returns:

the chosen transformation template

Throws:

TemplateResolutionException - if no template applies

getRootPomFile

protected org.apache.maven.model.Model getRootPomFile(java.io.File folder)
                                               throws java.io.IOException,
                                                      org.codehaus.plexus.util.xml.pull.XmlPullParserException

This is a convenience method in case the Extension subclass wants to implement its automaticResolution(File) method based on one or more Maven pom files

Parameters:

folder - the folder where the pom.xml file would be

Returns:

the Model object related to the pom.xml file under folder

Throws:

java.io.IOException - if pom file does not exist, or any error happens when trying to read it

org.codehaus.plexus.util.xml.pull.XmlPullParserException - if any error happens when trying to parse the pom file

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object