public class ContextAttributeRetriever<T> +extends TransformationUtility+
TransformationTemplate.getApplicationName(). The
+ application name mostly will only be known after the transformation
+ has began, but it might be necessary to know it outside of transformation
+ time (after it). For example, the metrics system needs to know it, as
+ seen in TransformationMetrics.getApplicationName().UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
ContextAttributeRetriever() |
+
ContextAttributeRetriever(String attributeName) |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected ExecutionResult |
+execution(File transformedAppFolder,
+ TransformationContext transformationContext)
+The implementation execution of this transformation utility.
+ |
+
T |
+getAttributeValue()
+Returns the value of the transformation context attribute
+ specified earlier.
+ |
+
String |
+getDescription()
+Returns a short one line, but SPECIFIC, description about the transformation
+ utility, including mentioning the files and/or folders
+ to be manipulated.
+ |
+
void |
+setAttributeName(String attributeName) |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic ContextAttributeRetriever()+
public ContextAttributeRetriever(String attributeName)+
public void setAttributeName(String attributeName)+
public String getDescription()+
TransformationUtilitygetDescription in class TransformationUtilityprotected ExecutionResult execution(File transformedAppFolder, + TransformationContext transformationContext)+
TransformationUtilityTransformationUtility.isSaveResult() returns false.
+ ExecutionResult error object.execution in class TransformationUtilitytransformedAppFolder - the folder where the transformed application code istransformationContext - the transformation context objectpublic T getAttributeValue()+
IllegalStateException is thrown.Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/DoubleCondition.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/DoubleCondition.html new file mode 100644 index 00000000..a15fe82f --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/DoubleCondition.html @@ -0,0 +1,467 @@ + + + + + + +public abstract class DoubleCondition<T extends DoubleCondition> +extends UtilityCondition<T>+
DoubleUtilityCondition subclass result type must always
+ be boolean. The criteria to this type of condition
+ is based on two files (when comparing if two XML files are equal
+ for example). For conditions
+ based on evaluating a single file see SingleCondition.
+ For conditions based on multiple files see MultipleConditions
+ SingleCondition,
+MultipleConditionsUTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
DoubleCondition()
+Condition to determine if a transformation utility
+ should be executed or not.
+ |
+
DoubleCondition(String attribute)
+Condition to determine if a transformation utility
+ should be executed or not.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected abstract boolean |
+compare(File baselineFile,
+ File comparisonFile)
+Returns true only if the compared files meet the comparison
+ criteria established and implemented by the subclass
+ |
+
protected TUExecutionResult |
+execution(File transformedAppFolder,
+ TransformationContext transformationContext)
+The implementation execution of this transformation utility.
+ |
+
String |
+getAttribute()
+Return the name of the transformation context attribute
+ that refers to the file to be compared against the
+ baseline file
+ |
+
T |
+setAttribute(String attribute)
+Set the name of the transformation context attribute
+ that refers to the file to be compared against the
+ baseline file, which is set by regular
+TransformationUtility
+ methods, like TransformationUtility.relative(String) or TransformationUtility.absolute(String) |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getDescription, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic DoubleCondition()+
public DoubleCondition(String attribute)+
attribute - the name of the transformation context attribute
+ that refers to the file to be compared against the baseline filepublic String getAttribute()+
public T setAttribute(String attribute)+
TransformationUtility
+ methods, like TransformationUtility.relative(String) or TransformationUtility.absolute(String)attribute - the name of the transformation context attribute
+ that refers to the file to be compared against the baseline fileprotected TUExecutionResult execution(File transformedAppFolder, + TransformationContext transformationContext)+
TransformationUtilityTransformationUtility.isSaveResult() returns false.
+ ExecutionResult error object.execution in class TransformationUtility<T extends DoubleCondition>transformedAppFolder - the folder where the transformed application code istransformationContext - the transformation context objectprotected abstract boolean compare(File baselineFile, + File comparisonFile)+
baselineFile - the baseline file used for comparisoncomparisonFile - the file to be compared against the baseline fileCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/ExecutionResult.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/ExecutionResult.html new file mode 100644 index 00000000..b4bb3ad5 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/ExecutionResult.html @@ -0,0 +1,490 @@ + + + + + + +public abstract class ExecutionResult<S,R,T> +extends Object+
TransformationUtility instance has been executed.
+ This is an abstract type, the concrete classes TUExecutionResult and TOExecutionResult should
+ be used directly instead.TUExecutionResult,
+TOExecutionResult| Modifier and Type | +Method and Description | +
|---|---|
R |
+addWarning(Exception warning)
+Add a new warning associated with this result.
+ |
+
protected abstract void |
+changeTypeOnWarning()
+This method is used to notify subclasses that
+ the result type might have to change due to the
+ addition of a warning.
+ |
+
protected abstract boolean |
+dependencyFailureCheck()
+Returns true if this result type falls to the dependency failure criteria,
+ which is stated in
+TransformationUtility.dependsOn(String...) |
+
String |
+getDetails()
+Return the result details
+ |
+
Exception |
+getException()
+Return the exception object in case of types such as ERROR
+ |
+
S |
+getSource()
+Returns the source of this result, which could be for example
+ a transformation utility instance or a transformation
+ operation instance
+ |
+
T |
+getType()
+Returns the result type
+ |
+
List<Exception> |
+getWarnings()
+Return a list of warnings associated with this result.
+ |
+
protected abstract boolean |
+isExceptionType()
+Returns true if this result type is supposed to contain an exception,
+ such ERROR
+ |
+
R |
+setDetails(String details) |
+
protected R |
+setException(Exception exception)
+Set the exception associated with this result.
+ |
+
protected R |
+setType(T type) |
+
protected R setType(T type)+
public R setDetails(String details)+
protected R setException(Exception exception)+
IllegalArgumentException
+ will be thrownexception - associated with the execution resultpublic R addWarning(Exception warning)+
warning - the warning to be addedprotected abstract void changeTypeOnWarning()+
protected abstract boolean isExceptionType()+
protected abstract boolean dependencyFailureCheck()+
TransformationUtility.dependsOn(String...)public S getSource()+
public T getType()+
public String getDetails()+
public Exception getException()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/Extension.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/Extension.html new file mode 100644 index 00000000..af93bdb8 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/Extension.html @@ -0,0 +1,419 @@ + + + + + + +public abstract class Extension<E> +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
protected E |
+add(Class<? extends TransformationTemplate> templateClass)
+Adds a new transformation template class to the set
+ |
+
Class<? extends TransformationTemplate> |
+automaticResolution(File applicationFolder)
+Butterfly might be able to automatically identify, based on the application
+ content, the most applicable transformation template to transform it.
+ |
+
abstract String |
+getDescription()
+Returns the extension description
+ |
+
protected org.apache.maven.model.Model |
+getRootPomFile(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 |
+
List<Class<? extends TransformationTemplate>> |
+getTemplateClasses()
+Returns a read-only set containing all transformation template classes
+ |
+
abstract String |
+getVersion()
+Returns the extension version
+ |
+
String |
+toString() |
+
protected final E add(Class<? extends TransformationTemplate> templateClass)+
templateClass - the transformation template class to be added to the extensionpublic abstract String getDescription()+
public abstract String getVersion()+
public final List<Class<? extends TransformationTemplate>> getTemplateClasses()+
public Class<? extends TransformationTemplate> automaticResolution(File applicationFolder) + throws TemplateResolutionException+
TemplateResolutionException
+ is thrown explaining the reason why no template could be chosen.applicationFolder - the folder where the code of the application to be transformed isTemplateResolutionException - if no template appliesprotected org.apache.maven.model.Model getRootPomFile(File folder)+
automaticResolution(File) method based on one or more Maven pom filesfolder - the folder where the pom.xml file would befolder, or null, if that file does
+ not exist, or any error happens when trying to read and parse itCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/FilterFiles.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/FilterFiles.html new file mode 100644 index 00000000..9a5a4dd8 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/FilterFiles.html @@ -0,0 +1,542 @@ + + + + + + +public class FilterFiles +extends TransformationUtility<FilterFiles>+
SingleCondition,
+ returning in a sub-list of files.UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
FilterFiles()
+Utility to filter a list of files based on a given
+
+SingleCondition,
+ returning in a sub-list of files |
+
FilterFiles(SingleCondition conditionTemplate)
+Utility to filter a list of files based on a given
+
+SingleCondition,
+ returning in a sub-list of files |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected TUExecutionResult |
+execution(File transformedAppFolder,
+ TransformationContext transformationContext)
+The implementation execution of this transformation utility.
+ |
+
SingleCondition |
+getConditionTemplate()
+Return the single condition template to be evaluated against all files
+ |
+
String |
+getDescription()
+Returns a short one line, but SPECIFIC, description about the transformation
+ utility, including mentioning the files and/or folders
+ to be manipulated.
+ |
+
String[] |
+getFilesAttributes()
+Return an array containing the name of transformation context attributes
+ that hold the list of files to be filtered
+ |
+
SingleCondition |
+newConditionInstance(File transformedAppFolder,
+ File file)
+Creates a new single condition instance copying from this current
+ object, but setting the file it should perform against based
+ on the input parameters
+ |
+
FilterFiles |
+setConditionTemplate(SingleCondition conditionTemplate)
+Set the single condition template to be evaluated against all files
+ |
+
FilterFiles |
+setFiles(String... filesAttributes)
+Sets one or more transformation context attributes that hold list of Files
+ which the single condition should be evaluated against.
+ |
+
protected FilterFiles |
+setName(String name)
+Set this transformation utility instance name.
+ |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic FilterFiles()+
SingleCondition,
+ returning in a sub-list of filespublic FilterFiles(SingleCondition conditionTemplate)+
SingleCondition,
+ returning in a sub-list of filesconditionTemplate - the single condition template to be evaluated against all filespublic FilterFiles setFiles(String... filesAttributes)+
filesAttributes - one or more transformation context attributes that hold list
+ of Files which the condition should be evaluated againstpublic FilterFiles setConditionTemplate(SingleCondition conditionTemplate)+
conditionTemplate - the single condition template to be evaluated against all filesprotected FilterFiles setName(String name)+
TransformationUtilitysetName in class TransformationUtility<FilterFiles>name - transformation utility instance namepublic String getDescription()+
TransformationUtilitygetDescription in class TransformationUtility<FilterFiles>public String[] getFilesAttributes()+
public SingleCondition getConditionTemplate()+
protected TUExecutionResult execution(File transformedAppFolder, + TransformationContext transformationContext)+
TransformationUtilityTransformationUtility.isSaveResult() returns false.
+ ExecutionResult error object.execution in class TransformationUtility<FilterFiles>transformedAppFolder - the folder where the transformed application code istransformationContext - the transformation context objectpublic SingleCondition newConditionInstance(File transformedAppFolder, + File file)+
transformedAppFolder - the transformed application folderfile - the actual file to be performed againstCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/MultipleConditions.Mode.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/MultipleConditions.Mode.html new file mode 100644 index 00000000..b68046fd --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/MultipleConditions.Mode.html @@ -0,0 +1,355 @@ + + + + + + +public static enum MultipleConditions.Mode +extends Enum<MultipleConditions.Mode>+
MultipleConditions.| Enum Constant and Description | +
|---|
ALL
+The
+MultipleConditions execution will returning true only if ALL files meet the specified condition. |
+
AT_LEAST_ONE
+The
+MultipleConditions execution will returning true if AT LEAST ONE file meets the specified condition. |
+
| Modifier and Type | +Method and Description | +
|---|---|
static MultipleConditions.Mode |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static MultipleConditions.Mode[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final MultipleConditions.Mode AT_LEAST_ONE+
MultipleConditions execution will returning true if AT LEAST ONE file meets the specified condition.
+ This is the default execution mode.public static final MultipleConditions.Mode ALL+
MultipleConditions execution will returning true only if ALL files meet the specified condition.public static MultipleConditions.Mode[] values()+
+for (MultipleConditions.Mode c : MultipleConditions.Mode.values()) + System.out.println(c); +
public static MultipleConditions.Mode valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/MultipleConditions.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/MultipleConditions.html new file mode 100644 index 00000000..3ce3f43e --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/MultipleConditions.html @@ -0,0 +1,616 @@ + + + + + + +public class MultipleConditions +extends UtilityCondition<MultipleConditions>+
SingleCondition template against multiple files,
+ returning true if at least one file meets the condition (default mode).
+ There is an alternative mode where all files need to meet the
+ evaluation condition to result in true. For conditions
+ based on comparing two files see DoubleCondition.
+ For conditions based on evaluating a single file see SingleCondition
+ setMode(Mode),
+SingleCondition,
+DoubleCondition| Modifier and Type | +Class and Description | +
|---|---|
static class |
+MultipleConditions.Mode
+Execution mode for
+MultipleConditions. |
+
UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
MultipleConditions(SingleCondition conditionTemplate)
+Perform one transformation utility condition against multiple files,
+ returning true if at least one file meets the condition (default mode).
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected TUExecutionResult |
+execution(File transformedAppFolder,
+ TransformationContext transformationContext)
+The implementation execution of this transformation utility.
+ |
+
SingleCondition |
+getConditionTemplate()
+Return the condition template
+ |
+
String |
+getDescription()
+Returns a short one line, but SPECIFIC, description about the transformation
+ utility, including mentioning the files and/or folders
+ to be manipulated.
+ |
+
String[] |
+getFilesAttributes()
+A copy of the array of transformation context attributes that hold list of Files
+ which the condition should perform against.
+ |
+
MultipleConditions.Mode |
+getMode()
+Return the evaluation mode
+ |
+
UtilityCondition |
+newConditionInstance(File transformedAppFolder,
+ File file)
+Creates a new condition instance copying from this current
+ object, but setting the file it should perform against based
+ on the input parameters
+ |
+
MultipleConditions |
+setConditionTemplate(SingleCondition conditionTemplate)
+Set the utility condition template used to create conditions
+ to be evaluated against the list of files
+ |
+
MultipleConditions |
+setFiles(String... filesAttributes)
+Sets one or more transformation context attributes that hold list of Files
+ which the condition should perform against.
+ |
+
MultipleConditions |
+setMode(MultipleConditions.Mode mode)
+Set the evaluation mode.
+ |
+
MultipleConditions |
+setName(String name)
+Set this transformation utility instance name.
+ |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic MultipleConditions(SingleCondition conditionTemplate)+
DoubleCondition.
+ For conditions based on evaluating a single file see MultipleConditionsconditionTemplate - the utility condition template used to create conditions,
+ used to be evaluated against the list of filespublic MultipleConditions setMode(MultipleConditions.Mode mode)+
mode - the evaluation modepublic MultipleConditions setFiles(String... filesAttributes)+
filesAttributes - one or more transformation context attributes that hold list
+ of Files which the condition should perform
+ againstpublic MultipleConditions setConditionTemplate(SingleCondition conditionTemplate)+
conditionTemplate - the utility condition template used to create conditions
+ to be evaluated against the list of filespublic MultipleConditions setName(String name)+
TransformationUtilitysetName in class TransformationUtility<MultipleConditions>name - transformation utility instance namepublic MultipleConditions.Mode getMode()+
public String[] getFilesAttributes()+
public SingleCondition getConditionTemplate()+
public String getDescription()+
TransformationUtilitygetDescription in class TransformationUtility<MultipleConditions>protected TUExecutionResult execution(File transformedAppFolder, + TransformationContext transformationContext)+
TransformationUtilityTransformationUtility.isSaveResult() returns false.
+ ExecutionResult error object.execution in class TransformationUtility<MultipleConditions>transformedAppFolder - the folder where the transformed application code istransformationContext - the transformation context objectpublic UtilityCondition newConditionInstance(File transformedAppFolder, + File file)+
transformedAppFolder - the transformed application folderfile - the actual file to be performed againstCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/MultipleOperations.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/MultipleOperations.html new file mode 100644 index 00000000..7f9d225f --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/MultipleOperations.html @@ -0,0 +1,639 @@ + + + + + + +public class MultipleOperations +extends TransformationUtility<MultipleOperations> +implements com.paypal.butterfly.extensions.api.TransformationUtilityParent+
setFiles(String...)setProperties(String, String)UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
MultipleOperations()
+Utility to perform multiple transformation operations.
+ |
+
MultipleOperations(TransformationOperation templateOperation)
+Utility to perform multiple transformation operations.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected TUExecutionResult |
+execution(File transformedAppFolder,
+ TransformationContext transformationContext)
+The implementation execution of this transformation utility.
+ |
+
List<TransformationUtility> |
+getChildren()
+Return an immutable list of all children
+ |
+
String |
+getDescription()
+Returns a short one line, but SPECIFIC, description about the transformation
+ utility, including mentioning the files and/or folders
+ to be manipulated.
+ |
+
String[] |
+getFilesAttributes()
+Return an array containing the name of transformation context attributes
+ that hold the list of files the operations should be performed against
+ |
+
TransformationOperation |
+getTemplateOperation() |
+
MultipleOperations |
+setFiles(String... filesAttributes)
+Sets one or more transformation context attributes that hold list of Files
+ which the transformation operations should perform against.
+ |
+
MultipleOperations |
+setName(String name)
+Set this transformation utility instance name.
+ |
+
MultipleOperations |
+setOperationTemplate(TransformationOperation templateOperation)
+Sets the template of transformation operation to be performed against all specified files.
+ |
+
MultipleOperations |
+setProperties(String propertyName,
+ String propertyAttribute)
+This setter is similar to
+TransformationUtility.set(String, String), however it is more powerful, because
+ it allows setting, during transformation time, different properties values for each operation of a
+ MultipleOperations. |
+
void |
+setPropertySetter() |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setParent, setSaveResult, toString, wasFileExplicitlySetfinalize, getClass, notify, notifyAll, wait, wait, waitgetNamepublic MultipleOperations()+
setFiles(String...)setProperties(String, String)public MultipleOperations(TransformationOperation templateOperation)+
setFiles(String...)setProperties(String, String)templateOperation - a template of transformation operation to be performed
+ against all specified filespublic MultipleOperations setFiles(String... filesAttributes)+
filesAttributes - one or more transformation context attributes that hold list
+ of Files which the transformation operation should perform
+ againstpublic final MultipleOperations setProperties(String propertyName, + String propertyAttribute)+
TransformationUtility.set(String, String), however it is more powerful, because
+ it allows setting, during transformation time, different properties values for each operation of a
+ MultipleOperations.
+ TransformationTemplate.addMultiple(TransformationOperation, String...)propertyName - the operation Java bean property name to be set during transformation timepropertyAttribute - the name of the transformation context attribute that holds a Set of
+ values to be each set individually (as the property value) to each operation of
+ a set of multiple operations. These values are set right before execution. If
+ the transformation context attribute value is not a Set, then a
+ TransformationUtilityException
+ will be thrown right before executionpublic MultipleOperations setOperationTemplate(TransformationOperation templateOperation)+
templateOperation - the template of transformation operation to be performed against
+ all specified filespublic MultipleOperations setName(String name)+
TransformationUtilitysetName in class TransformationUtility<MultipleOperations>name - transformation utility instance namepublic String[] getFilesAttributes()+
public TransformationOperation getTemplateOperation()+
public String getDescription()+
TransformationUtilitygetDescription in class TransformationUtility<MultipleOperations>public void setPropertySetter()+
protected TUExecutionResult execution(File transformedAppFolder, + TransformationContext transformationContext)+
TransformationUtilityTransformationUtility.isSaveResult() returns false.
+ ExecutionResult error object.execution in class TransformationUtility<MultipleOperations>transformedAppFolder - the folder where the transformed application code istransformationContext - the transformation context objectpublic List<TransformationUtility> getChildren()+
com.paypal.butterfly.extensions.api.TransformationUtilityParentgetChildren in interface com.paypal.butterfly.extensions.api.TransformationUtilityParentCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/PerformResult.Type.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/PerformResult.Type.html new file mode 100644 index 00000000..64cbfb0a --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/PerformResult.Type.html @@ -0,0 +1,386 @@ + + + + + + +public static enum PerformResult.Type +extends Enum<PerformResult.Type>+
TransformationUtility instance has been performed.| Enum Constant and Description | +
|---|
ERROR
+The TU failed, but not because of its utility execution itself, but because of an internal reason.
+ |
+
EXECUTION_RESULT
+The result type is defined based on the utility execution result type.
+ |
+
SKIPPED_CONDITION
+The TU has a condition associated with it (
+TransformationUtility.executeIf(String)) but that condition resulted in false. |
+
SKIPPED_DEPENDENCY
+The TU depends on one or more TUs, and at least one of them didn't result in SUCCESS.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static PerformResult.Type |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static PerformResult.Type[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final PerformResult.Type EXECUTION_RESULT+
public static final PerformResult.Type SKIPPED_CONDITION+
TransformationUtility.executeIf(String)) but that condition resulted in false.public static final PerformResult.Type SKIPPED_DEPENDENCY+
public static final PerformResult.Type ERROR+
TransformationUtilityException is thrown because the absolute file
+ the TU should execute against could not be resolved during transformation time.public static PerformResult.Type[] values()+
+for (PerformResult.Type c : PerformResult.Type.values()) + System.out.println(c); +
public static PerformResult.Type valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/PerformResult.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/PerformResult.html new file mode 100644 index 00000000..412cd13b --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/PerformResult.html @@ -0,0 +1,661 @@ + + + + + + +public class PerformResult +extends Object+
TransformationUtility instance has been performed.| Modifier and Type | +Class and Description | +
|---|---|
static class |
+PerformResult.Type
+The type of result after the
+TransformationUtility instance has been performed. |
+
| Modifier and Type | +Method and Description | +
|---|---|
R |
+addWarning(Exception warning)
+Add a new warning associated with this result.
+ |
+
protected void |
+changeTypeOnWarning()
+This method is used to notify subclasses that
+ the result type might have to change due to the
+ addition of a warning.
+ |
+
protected boolean |
+dependencyFailureCheck()
+Returns true if this result type falls to the dependency failure criteria,
+ which is stated in
+TransformationUtility.dependsOn(String...) |
+
static PerformResult |
+error(TransformationUtility transformationUtility,
+ Exception exception)
+This means The TU failed, but not because of its utility execution itself, but because of an internal reason.
+ |
+
static PerformResult |
+error(TransformationUtility transformationUtility,
+ Exception exception,
+ String details)
+This means The TU failed, but not because of its utility execution itself, but because of an internal reason.
+ |
+
static PerformResult |
+executionResult(TransformationUtility transformationUtility,
+ ExecutionResult executionResult)
+This means the utility has been executed,
+ and the result type is defined based on the utility execution result type.
+ |
+
String |
+getDetails()
+Return the result details
+ |
+
Exception |
+getException()
+Return the exception object in case of types such as ERROR
+ |
+
ExecutionResult |
+getExecutionResult()
+Return the
+ExecutionResult object associated with this perform result |
+
S |
+getSource()
+Returns the source of this result, which could be for example
+ a transformation utility instance or a transformation
+ operation instance
+ |
+
T |
+getType()
+Returns the result type
+ |
+
List<Exception> |
+getWarnings()
+Return a list of warnings associated with this result.
+ |
+
protected boolean |
+isExceptionType()
+Returns true if this result type is supposed to contain an exception,
+ such ERROR
+ |
+
R |
+setDetails(String details) |
+
protected R |
+setException(Exception exception)
+Set the exception associated with this result.
+ |
+
protected R |
+setType(T type) |
+
static PerformResult |
+skippedCondition(TransformationUtility transformationUtility,
+ String details)
+This means the utility has not been executed
+ because its pre-requisite condition is not true
+ |
+
static PerformResult |
+skippedDependency(TransformationUtility transformationUtility,
+ String details)
+This means the utility has not been executed because one or more
+ of its dependencies "failed".
+ |
+
public static PerformResult executionResult(TransformationUtility transformationUtility, + ExecutionResult executionResult)+
transformationUtility - the TransformationUtility object that produced this resultexecutionResult - the utility execution resultPerformResult object of type PerformResult.Type.EXECUTION_RESULTpublic static PerformResult skippedCondition(TransformationUtility transformationUtility, + String details)+
transformationUtility - the TransformationUtility object that produced this resultdetails - details about the resultPerformResult object of type PerformResult.Type.SKIPPED_DEPENDENCYpublic static PerformResult skippedDependency(TransformationUtility transformationUtility, + String details)+
TransformationUtility.dependsOn(String...)
+ for the dependency failure criteria definitiontransformationUtility - the TransformationUtility object that produced this resultdetails - details about the resultPerformResult object of type PerformResult.Type.SKIPPED_DEPENDENCYpublic static PerformResult error(TransformationUtility transformationUtility, + Exception exception, + String details)+
transformationUtility - the TransformationUtility object that produced this resultexception - the exception to be registered to the result objectdetails - details about the resultPerformResult object of type PerformResult.Type.ERRORpublic static PerformResult error(TransformationUtility transformationUtility, + Exception exception)+
transformationUtility - the TransformationUtility object that produced this resultexception - the exception to be registered to the result objectPerformResult object of type PerformResult.Type.ERRORprotected void changeTypeOnWarning()+
public ExecutionResult getExecutionResult()+
ExecutionResult object associated with this perform resultExecutionResult object associated with this perform resultprotected boolean isExceptionType()+
protected boolean dependencyFailureCheck()+
TransformationUtility.dependsOn(String...)protected R setType(T type)+
public R setDetails(String details)+
protected R setException(Exception exception)+
IllegalArgumentException
+ will be thrownexception - associated with the execution resultpublic R addWarning(Exception warning)+
warning - the warning to be addedpublic S getSource()+
public T getType()+
public String getDetails()+
public Exception getException()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/SingleCondition.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/SingleCondition.html new file mode 100644 index 00000000..27ee934c --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/SingleCondition.html @@ -0,0 +1,290 @@ + + + + + + +public abstract class SingleCondition<T extends SingleCondition> +extends UtilityCondition<T>+
SingleUtilityCondition subclass result type must always
+ be boolean. The criteria to this type of condition
+ is based on evaluating a single file (when checking if a particular
+ file contains a given word for example). For conditions
+ based on comparing two files see DoubleCondition.
+ For conditions based on multiple files see MultipleConditionsDoubleCondition,
+MultipleConditionsUTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
SingleCondition() |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, execution, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getDescription, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TOExecutionResult.Type.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TOExecutionResult.Type.html new file mode 100644 index 00000000..ba4c18e3 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TOExecutionResult.Type.html @@ -0,0 +1,385 @@ + + + + + + +public static enum TOExecutionResult.Type +extends Enum<TOExecutionResult.Type>+
TransformationOperation instance has been executed.| Enum Constant and Description | +
|---|
ERROR
+The TO failed to execute, no change or an incomplete change was made, and the transformed application might be now in a corrupted state.
+ |
+
NO_OP
+No error happened, but for some reason the TO didn't apply any change.
+ |
+
SUCCESS
+The TO executed normally and a change was performed.
+ |
+
WARNING
+The TO executed, a complete and valid change was performed, but a "non-fatal" unexpected situation happened.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static TOExecutionResult.Type |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static TOExecutionResult.Type[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final TOExecutionResult.Type NO_OP+
public static final TOExecutionResult.Type SUCCESS+
public static final TOExecutionResult.Type WARNING+
public static final TOExecutionResult.Type ERROR+
public static TOExecutionResult.Type[] values()+
+for (TOExecutionResult.Type c : TOExecutionResult.Type.values()) + System.out.println(c); +
public static TOExecutionResult.Type valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TOExecutionResult.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TOExecutionResult.html new file mode 100644 index 00000000..631df6fd --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TOExecutionResult.html @@ -0,0 +1,712 @@ + + + + + + +public class TOExecutionResult +extends ExecutionResult<TransformationOperation,TOExecutionResult,TOExecutionResult.Type>+
TransformationOperation instance has been executed.TOExecutionResult| Modifier and Type | +Class and Description | +
|---|---|
static class |
+TOExecutionResult.Type
+The type of result after the
+TransformationOperation instance has been executed. |
+
| Modifier and Type | +Method and Description | +
|---|---|
R |
+addWarning(Exception warning)
+Add a new warning associated with this result.
+ |
+
protected void |
+changeTypeOnWarning()
+This method is used to notify subclasses that
+ the result type might have to change due to the
+ addition of a warning.
+ |
+
protected boolean |
+dependencyFailureCheck()
+Returns true if this result type falls to the dependency failure criteria,
+ which is stated in
+TransformationUtility.dependsOn(String...) |
+
static TOExecutionResult |
+error(TransformationOperation transformationOperation,
+ Exception exception)
+Creates and returns a new
+TOExecutionResult.Type.ERROR result |
+
static TOExecutionResult |
+error(TransformationOperation transformationOperation,
+ Exception exception,
+ String details)
+Creates and returns a new
+TOExecutionResult.Type.ERROR result |
+
String |
+getDetails()
+Return the result details
+ |
+
Exception |
+getException()
+Return the exception object in case of types such as ERROR
+ |
+
S |
+getSource()
+Returns the source of this result, which could be for example
+ a transformation utility instance or a transformation
+ operation instance
+ |
+
T |
+getType()
+Returns the result type
+ |
+
List<Exception> |
+getWarnings()
+Return a list of warnings associated with this result.
+ |
+
protected boolean |
+isExceptionType()
+Returns true if this result type is supposed to contain an exception,
+ such ERROR
+ |
+
static TOExecutionResult |
+noOp(TransformationOperation transformationOperation,
+ String details)
+Creates and returns a new
+TOExecutionResult.Type.NO_OP result |
+
R |
+setDetails(String details) |
+
protected R |
+setException(Exception exception)
+Set the exception associated with this result.
+ |
+
protected R |
+setType(T type) |
+
static TOExecutionResult |
+success(TransformationOperation transformationOperation,
+ String details)
+Creates and returns a new
+TOExecutionResult.Type.SUCCESS result |
+
static TOExecutionResult |
+warning(TransformationOperation transformationOperation)
+Creates and returns a new
+TOExecutionResult.Type.WARNING result |
+
static TOExecutionResult |
+warning(TransformationOperation transformationOperation,
+ Exception exception)
+Creates and returns a new
+TOExecutionResult.Type.WARNING result |
+
static TOExecutionResult |
+warning(TransformationOperation transformationOperation,
+ Exception exception,
+ String details)
+Creates and returns a new
+TOExecutionResult.Type.WARNING result |
+
static TOExecutionResult |
+warning(TransformationOperation transformationOperation,
+ String details)
+Creates and returns a new
+TOExecutionResult.Type.WARNING result |
+
public static TOExecutionResult noOp(TransformationOperation transformationOperation, + String details)+
TOExecutionResult.Type.NO_OP resulttransformationOperation - the TransformationOperation object that produced this resultdetails - details about the resultpublic static TOExecutionResult success(TransformationOperation transformationOperation, + String details)+
TOExecutionResult.Type.SUCCESS resulttransformationOperation - the TransformationOperation object that produced this resultdetails - details about the resultpublic static TOExecutionResult warning(TransformationOperation transformationOperation)+
TOExecutionResult.Type.WARNING resulttransformationOperation - the TransformationOperation object that produced this resultpublic static TOExecutionResult warning(TransformationOperation transformationOperation, + String details)+
TOExecutionResult.Type.WARNING resulttransformationOperation - the TransformationOperation object that produced this resultdetails - details about the resultpublic static TOExecutionResult warning(TransformationOperation transformationOperation, + Exception exception)+
TOExecutionResult.Type.WARNING resulttransformationOperation - the TransformationOperation object that produced this resultexception - the exception to be registered as warning to the result objectpublic static TOExecutionResult warning(TransformationOperation transformationOperation, + Exception exception, + String details)+
TOExecutionResult.Type.WARNING resulttransformationOperation - the TransformationOperation object that produced this resultexception - the exception to be registered to the result objectdetails - details about the resultpublic static TOExecutionResult error(TransformationOperation transformationOperation, + Exception exception)+
TOExecutionResult.Type.ERROR resulttransformationOperation - the TransformationOperation object that produced this resultexception - the exception to be registered to the result objectpublic static TOExecutionResult error(TransformationOperation transformationOperation, + Exception exception, + String details)+
TOExecutionResult.Type.ERROR resulttransformationOperation - the TransformationOperation object that produced this resultexception - the exception to be registered to the result objectdetails - details about the resultprotected void changeTypeOnWarning()+
protected boolean isExceptionType()+
protected boolean dependencyFailureCheck()+
TransformationUtility.dependsOn(String...)protected R setType(T type)+
public R setDetails(String details)+
protected R setException(Exception exception)+
IllegalArgumentException
+ will be thrownexception - associated with the execution resultpublic R addWarning(Exception warning)+
warning - the warning to be addedpublic S getSource()+
public T getType()+
public String getDetails()+
public Exception getException()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TUExecutionResult.Type.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TUExecutionResult.Type.html new file mode 100644 index 00000000..9cae21c6 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TUExecutionResult.Type.html @@ -0,0 +1,372 @@ + + + + + + +public static enum TUExecutionResult.Type +extends Enum<TUExecutionResult.Type>+
TransformationUtility instance has been executed.| Enum Constant and Description | +
|---|
ERROR |
+
NULL |
+
VALUE |
+
WARNING |
+
| Modifier and Type | +Method and Description | +
|---|---|
static TUExecutionResult.Type |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static TUExecutionResult.Type[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final TUExecutionResult.Type NULL+
public static final TUExecutionResult.Type VALUE+
public static final TUExecutionResult.Type WARNING+
public static final TUExecutionResult.Type ERROR+
public static TUExecutionResult.Type[] values()+
+for (TUExecutionResult.Type c : TUExecutionResult.Type.values()) + System.out.println(c); +
public static TUExecutionResult.Type valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TUExecutionResult.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TUExecutionResult.html new file mode 100644 index 00000000..7d1c66eb --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TUExecutionResult.html @@ -0,0 +1,693 @@ + + + + + + +public class TUExecutionResult +extends ExecutionResult<TransformationUtility,TUExecutionResult,TUExecutionResult.Type>+
TransformationUtility instance has been executed.TUExecutionResult| Modifier and Type | +Class and Description | +
|---|---|
static class |
+TUExecutionResult.Type
+The type of result after the
+TransformationUtility instance has been executed. |
+
| Modifier and Type | +Method and Description | +
|---|---|
R |
+addWarning(Exception warning)
+Add a new warning associated with this result.
+ |
+
protected void |
+changeTypeOnWarning()
+This method is used to notify subclasses that
+ the result type might have to change due to the
+ addition of a warning.
+ |
+
protected boolean |
+dependencyFailureCheck()
+Returns true if this result type falls to the dependency failure criteria,
+ which is stated in
+TransformationUtility.dependsOn(String...) |
+
static TUExecutionResult |
+error(TransformationUtility transformationUtility,
+ Exception exception) |
+
static TUExecutionResult |
+error(TransformationUtility transformationUtility,
+ Exception exception,
+ Object value) |
+
static TUExecutionResult |
+error(TransformationUtility transformationUtility,
+ Object value,
+ Exception exception,
+ String details) |
+
String |
+getDetails()
+Return the result details
+ |
+
Exception |
+getException()
+Return the exception object in case of types such as ERROR
+ |
+
S |
+getSource()
+Returns the source of this result, which could be for example
+ a transformation utility instance or a transformation
+ operation instance
+ |
+
T |
+getType()
+Returns the result type
+ |
+
Object |
+getValue()
+Returns the value returned by the transformation utility, which can be null
+ |
+
List<Exception> |
+getWarnings()
+Return a list of warnings associated with this result.
+ |
+
protected boolean |
+isExceptionType()
+Returns true if this result type is supposed to contain an exception,
+ such ERROR
+ |
+
static TUExecutionResult |
+nullResult(TransformationUtility transformationUtility) |
+
static TUExecutionResult |
+nullResult(TransformationUtility transformationUtility,
+ String details) |
+
R |
+setDetails(String details) |
+
protected R |
+setException(Exception exception)
+Set the exception associated with this result.
+ |
+
protected R |
+setType(T type) |
+
static TUExecutionResult |
+value(TransformationUtility transformationUtility,
+ Object value) |
+
static TUExecutionResult |
+value(TransformationUtility transformationUtility,
+ String details,
+ Object value) |
+
static TUExecutionResult |
+warning(TransformationUtility transformationUtility,
+ Exception exception,
+ Object value) |
+
static TUExecutionResult |
+warning(TransformationUtility transformationUtility,
+ Exception exception,
+ String details,
+ Object value) |
+
static TUExecutionResult |
+warning(TransformationUtility transformationUtility,
+ String details,
+ Object value) |
+
public static TUExecutionResult nullResult(TransformationUtility transformationUtility)+
public static TUExecutionResult nullResult(TransformationUtility transformationUtility, + String details)+
public static TUExecutionResult value(TransformationUtility transformationUtility, + Object value)+
public static TUExecutionResult value(TransformationUtility transformationUtility, + String details, + Object value)+
public static TUExecutionResult warning(TransformationUtility transformationUtility, + String details, + Object value)+
public static TUExecutionResult warning(TransformationUtility transformationUtility, + Exception exception, + Object value)+
public static TUExecutionResult warning(TransformationUtility transformationUtility, + Exception exception, + String details, + Object value)+
public static TUExecutionResult error(TransformationUtility transformationUtility, + Exception exception)+
public static TUExecutionResult error(TransformationUtility transformationUtility, + Exception exception, + Object value)+
public static TUExecutionResult error(TransformationUtility transformationUtility, + Object value, + Exception exception, + String details)+
protected void changeTypeOnWarning()+
public Object getValue()+
protected boolean isExceptionType()+
protected boolean dependencyFailureCheck()+
TransformationUtility.dependsOn(String...)protected R setType(T type)+
public R setDetails(String details)+
protected R setException(Exception exception)+
IllegalArgumentException
+ will be thrownexception - associated with the execution resultpublic R addWarning(Exception warning)+
warning - the warning to be addedpublic S getSource()+
public T getType()+
public String getDetails()+
public Exception getException()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationContext.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationContext.html new file mode 100644 index 00000000..26255b85 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationContext.html @@ -0,0 +1,268 @@ + + + + + + +public interface TransformationContext
+| Modifier and Type | +Method and Description | +
|---|---|
Object |
+get(String name)
+Returns the attribute object associated with the key
+ (which is the attribute name), or null, if there is none
+ |
+
PerformResult |
+getResult(String utilityName)
+Returns the performing result of the
+TransformationUtility
+ identified by the specified name. |
+
Object get(String name)+
name - the transformation context attribute namePerformResult getResult(String utilityName)+
TransformationUtility
+ identified by the specified name. Notice that it could be a
+ TransformationOperation too, or any other
+ TransformationUtility subclassutilityName - the name of the utilityCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationOperation.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationOperation.html new file mode 100644 index 00000000..d68720ce --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationOperation.html @@ -0,0 +1,444 @@ + + + + + + +public abstract class TransformationOperation<T extends TransformationOperation> +extends TransformationUtility<T>+
TransformationUtility that applies a modification to the project.
+ TO.
+ TransformationUtility.relative(String) is null, which means
+ it must be set explicitly, unless an absolute path is set via TransformationUtility.absolute(String)
+ or TransformationUtility.absolute(String, String)UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
TransformationOperation() |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected File |
+getOrCreateReadFile(File transformedAppFolder,
+ TransformationContext transformationContext)
+Creates and returns a temporary read-only copy of the file to be modified.
+ |
+
PerformResult |
+perform(File transformedAppFolder,
+ TransformationContext transformationContext)
+Performs the transformation utility against
+ the application to be transformed
+
++ This is the one called by the transformation + engine, and regardless of any customization it + could have, it must always: + + 1- Call TransformationUtility.applyPropertiesFromContext(TransformationContext)
+ 2- Call TransformationUtility.execution(File, TransformationContext)
+
+ + This method is NOT supposed to be overwritten, + unless you really know what you are doing. |
+
protected T |
+setSaveResult(boolean saveResult)
+Sets whether or not the value produced by the transformation utility execution,
+ and also its result object as a whole, should both be saved in the transformation
+ context object.
+ |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, execution, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getDescription, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic TransformationOperation()+
protected final T setSaveResult(boolean saveResult)+
TransformationUtilityTransformationUtility.isSaveResult().setSaveResult in class TransformationUtility<T extends TransformationOperation>saveResult - if the value produced by the transformation utility execution,
+ and also its result object as a whole, should both be saved in the transformation
+ context objectprotected final File getOrCreateReadFile(File transformedAppFolder, + TransformationContext transformationContext) + throws IOException+
TransformationUtility.relative(String), TransformationUtility.absolute(String) or TransformationUtility.absolute(String, String)).
+ Some transformation operations though might need to read the file to be modified
+ as a stream, and modify it by writing to an output stream as that same file
+ is read. Since it is impossible to modify a file at the same time it is being read,
+ this utility method offers an convenient way to create a temporary read-only
+ copy of the file to be modified. This copy should be used to be read, while the original
+ file can be modified.
+ transformedAppFolder - the folder where the transformed application code istransformationContext - the transformation context objectIOException - if the temporary file could not be createdpublic PerformResult perform(File transformedAppFolder, + TransformationContext transformationContext) + throws TransformationUtilityException+
TransformationUtilityTransformationUtility.applyPropertiesFromContext(TransformationContext)TransformationUtility.execution(File, TransformationContext)perform in class TransformationUtility<T extends TransformationOperation>transformedAppFolder - the folder where the transformed application code istransformationContext - the transformation context objectTransformationUtilityExceptionCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationTemplate.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationTemplate.html new file mode 100644 index 00000000..154a3b65 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationTemplate.html @@ -0,0 +1,822 @@ + + + + + + +public abstract class TransformationTemplate +extends Object+
| Constructor and Description | +
|---|
TransformationTemplate() |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+add(TransformationUtility utility)
+Adds a new transformation utility to the end of the list.
+ |
+
String |
+add(TransformationUtility utility,
+ String utilityName)
+Adds a new transformation utility to the end of the list.
+ |
+
String |
+addMultiple(TransformationOperation templateOperation,
+ String... attributes)
+Adds a special transformation utility to perform multiple transformation operations against
+ multiple files specified as a list, held as a transformation context attribute
+
+ |
+
void |
+debug(String debugMessage)
+Adds a new
+Log TU to the list,
+ setting its log level to DEBUG |
+
void |
+debug(String debugMessage,
+ String... attributeNames)
+Adds a new
+Log TU to the list,
+ setting its log level to DEBUG. |
+
String |
+getApplicationName()
+Returns the name of the transformed application,
+ Returns null if the application name is unknown.
+ |
+
String |
+getApplicationType()
+Returns the type of the transformed application,
+ Returns null if the application type is unknown.
+ |
+
List<TransformationUtility> |
+getChildren()
+Return an immutable list of all children
+ |
+
abstract String |
+getDescription()
+Returns the transformation template description
+ |
+
abstract Class<? extends Extension> |
+getExtensionClass()
+Returns the class of the extension this transformation
+ template belongs to
+ |
+
String |
+getName()
+Return the name of this transformation utility parent
+ |
+
List<TransformationUtility> |
+getUtilities()
+Returns a read-only ordered list of transformation utilities to be executed,
+ which defines the actual transformation offered by this template
+ |
+
void |
+info(String infoMessage)
+Adds a new
+Log TU to the list,
+ setting its log level to INFO |
+
void |
+info(String infoMessage,
+ String... attributeNames)
+Adds a new
+Log TU to the list,
+ setting its log level to INFO. |
+
void |
+log(org.slf4j.event.Level logLevel,
+ String logMessage)
+Adds a new
+Log TU to the list |
+
void |
+log(org.slf4j.event.Level logLevel,
+ String logMessage,
+ String... attributeNames)
+Adds a new
+Log TU to the list. |
+
void |
+log(String logMessage)
+Deprecated.
+ |
+
void |
+log(String logMessage,
+ String... attributeNames)
+Deprecated.
+ |
+
String |
+loop(TransformationUtility utility,
+ int iterations)
+Execute an utility in a loop a number times specified in
+iterations |
+
String |
+loop(TransformationUtility utility,
+ String attribute)
+Execute an utility in a loop while the value in
+TransformationContext attribute is true. |
+
String |
+loop(TransformationUtility utility,
+ UtilityCondition condition)
+Execute an utility in a loop while the execution value resulted by
+condition is true. |
+
String |
+toString() |
+
public TransformationTemplate()+
public abstract Class<? extends Extension> getExtensionClass()+
public abstract String getDescription()+
public final String add(TransformationUtility utility)+
utility - the utility to be addedpublic final String add(TransformationUtility utility, + String utilityName)+
utility - the utility to be addedutilityName - the name to be set to the utility before adding itpublic final String addMultiple(TransformationOperation templateOperation, + String... attributes)+
templateOperation - a template of transformation operation to be performed
+ against all specified filesattributes - one or more transformation context attributes that hold list
+ of Files which the transformation operations should perform
+ againstpublic final String loop(TransformationUtility utility, + int iterations)+
iterationsutility - the utility to be executed each iteration of the loop. To execute more than one, use a TransformationUtilityGroupiterations - the number of iterations to be executedpublic final String loop(TransformationUtility utility, + String attribute)+
TransformationContext attribute is true.
+ The defined is specified based on its name, specified in attribute.
+ If the attribute value is not a boolean, or if non-existent, it will be treated as false.utility - the utility to be executed each iteration of the loop. To execute more than one, use a TransformationUtilityGroupattribute - the name of the transformation context attribute to hold the loop conditionpublic final String loop(TransformationUtility utility, + UtilityCondition condition)+
condition is true.
+ The TransformationUtility object referenced by condition won't be saved to the TransformationContext,
+ it will be executed exclusively to the scope of this loop execution.
+ Any result other than a boolean true value, including failures, will be treated as false.utility - the utility to be executed each iteration of the loop. To execute more than one, use a TransformationUtilityGroupcondition - the UtilityCondition object whose execution result will be used as the loop condition@Deprecated +public final void log(String logMessage)+
info(String) instead.
+
+ Adds a new Log TU to the listlogMessage - the message to be loggedpublic final void info(String infoMessage)+
Log TU to the list,
+ setting its log level to INFOinfoMessage - the info message to be loggedpublic final void debug(String debugMessage)+
Log TU to the list,
+ setting its log level to DEBUGdebugMessage - the debug message to be loggedpublic final void log(org.slf4j.event.Level logLevel, + String logMessage)+
Log TU to the listlogLevel - the log levellogMessage - the message to be logged@Deprecated +public final void log(String logMessage, + String... attributeNames)+
info(String, String...) instead.
+
+ Adds a new Log TU to the list.
+ The log messages may contain placeholders to be replaced by transformation context
+ attribute values. Use {} as placeholder marker.logMessage - the message to be logged, containing {} placeholders to be replaced by
+ transformation context attribute valuesattributeNames - an array of names of transformation context attributes, whose values
+ are going to be used in the log messagepublic final void info(String infoMessage, + String... attributeNames)+
Log TU to the list,
+ setting its log level to INFO.
+ The log messages may contain placeholders to be replaced by transformation context
+ attribute values. Use {} as placeholder marker.infoMessage - the info message to be logged, containing {} placeholders to be replaced by
+ transformation context attribute valuesattributeNames - an array of names of transformation context attributes, whose values
+ are going to be used in the log messagepublic final void debug(String debugMessage, + String... attributeNames)+
Log TU to the list,
+ setting its log level to DEBUG.
+ The log messages may contain placeholders to be replaced by transformation context
+ attribute values. Use {} as placeholder marker.debugMessage - the debug message to be logged, containing {} placeholders to be replaced by
+ transformation context attribute valuesattributeNames - an array of names of transformation context attributes, whose values
+ are going to be used in the log messagepublic final void log(org.slf4j.event.Level logLevel, + String logMessage, + String... attributeNames)+
Log TU to the list.
+ The log messages may contain placeholders to be replaced by transformation context
+ attribute values. Use {} as placeholder marker.logLevel - the log levellogMessage - the message to be logged, containing {} placeholders to be replaced by
+ transformation context attribute valuesattributeNames - an array of names of transformation context attributes, whose values
+ are going to be used in the log messagepublic final List<TransformationUtility> getUtilities()+
public List<TransformationUtility> getChildren()+
com.paypal.butterfly.extensions.api.TransformationUtilityParentpublic final String getName()+
com.paypal.butterfly.extensions.api.TransformationUtilityParentpublic String getApplicationType()+
public String getApplicationName()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationUtility.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationUtility.html new file mode 100644 index 00000000..4273bae0 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationUtility.html @@ -0,0 +1,1597 @@ + + + + + + +public abstract class TransformationUtility<T extends TransformationUtility> +extends Object +implements Cloneable+
TransformationContext object, to be used later by other transformation utilities.
+ TU.
+ TransformationOperation for a specialized transformation utility that
+ does modify the project
+
+ IMPORTANT:
+ Every TransformationUtility subclass MUST have a public no arguments default constructor,
+ and also public setters and getters for all properties they want to expose via set(String, String).
+ In addition to that, every setter must return the TransformationUtility instance.| Modifier and Type | +Field and Description | +
|---|---|
protected static String |
+UTILITY_NAME_SYNTAX |
+
| Constructor and Description | +
|---|
TransformationUtility() |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+abortOnFailure()
+Returns whether this operation aborts the transformation or not in
+ case of an operation failure.
+ |
+
T |
+abortOnFailure(boolean abort)
+If set to true, abort the whole transformation if validation or execution fails.
+ |
+
T |
+abortOnFailure(boolean abort,
+ String abortionMessage)
+If set to true, abort the whole transformation if validation or execution fails.
+ |
+
T |
+absolute(String contextAttributeName)
+There are two ways to specify the file, or folder, the transformation
+ utility is suppose to perform against.
+ |
+
T |
+absolute(String contextAttributeName,
+ String additionalRelativePath)
+Same as
+absolute(String, String), however, the absolute
+ file is set with an additional relative path, which is defined via parameter
+ additionalRelativePath. |
+
protected void |
+applyPropertiesFromContext(TransformationContext transformationContext)
+Applies transformation utility properties during transformation time, but
+ prior to execution (right before it).
+ |
+
protected com.paypal.butterfly.extensions.api.Result |
+checkDependencies(TransformationContext transformationContext)
+Check if any of dependency of this TU failed.
+ |
+
protected static void |
+checkForBlankString(String name,
+ String value)
+Check if value is a blank String, if it is, then a
+
+TransformationDefinitionException is thrown. |
+
protected static void |
+checkForEmptyString(String name,
+ String value)
+Check if value is an empty String, if it is, then a
+
+TransformationDefinitionException is thrown. |
+
protected static void |
+checkForNull(String name,
+ Object value)
+Check if value is null, if it is, then a
+
+TransformationDefinitionException is thrown. |
+
T |
+clone()
+Creates and returns a clone object identical to the original object,
+ except for the "has been performed" flag, which is set to
+false
+ in the clone object to be returned. |
+
T |
+copy()
+Creates and returns a copy object similar to the original object.
+ |
+
T |
+dependsOn(String... dependencies)
+Add all transformation utilities this utility depends on.
+ |
+
boolean |
+equals(Object obj)
+Compare this instance against the specified object, and return
+ true only if they are equal.
+ |
+
T |
+executeIf(String conditionAttributeName)
+When set, this TU will only execute if this transformation context
+ attribute is existent and true.
+ |
+
T |
+executeIf(UtilityCondition utilityCondition)
+When set, this TU will only execute if this
+utilityCondition object,
+ executed right before this TU, result in true. |
+
T |
+executeUnless(String conditionAttributeName)
+When set, this TU will execute, unless this transformation context
+ attribute is existent and true.
+ |
+
protected abstract ExecutionResult |
+execution(File transformedAppFolder,
+ TransformationContext transformationContext)
+The implementation execution of this transformation utility.
+ |
+
String |
+getAbortionMessage()
+Returns a message to be logged if a fail happens and transformation has to be aborted
+ |
+
protected File |
+getAbsoluteFile(File transformedAppFolder,
+ TransformationContext transformationContext)
+Returns an absolute path to the file or folder the transformation
+ utility is supposed to perform against
+ |
+
String |
+getContextAttributeName()
+Return the name to be used as key for the result of this utility
+ when saved into the transformation context.
+ |
+
protected List<String> |
+getDependencies()
+Returns an unmodifiable list of names of utilities this utility instance depends on.
+ |
+
abstract String |
+getDescription()
+Returns a short one line, but SPECIFIC, description about the transformation
+ utility, including mentioning the files and/or folders
+ to be manipulated.
+ |
+
String |
+getIfConditionAttributeName()
+Return the "if" condition attribute name associated with this transformation operation,
+ or null, if there is none
+ |
+
String |
+getName() |
+
int |
+getOrder()
+Returns the execution order for this utility on its parent.
+ |
+
com.paypal.butterfly.extensions.api.TransformationUtilityParent |
+getParent()
+Returns the transformation utility parent
+ |
+
protected String |
+getRelativePath()
+Returns relative path (from the application root folder) to the
+ file or folder the transformation utility is suppose to perform against
+ |
+
static String |
+getRelativePath(File baselineFile,
+ File targetFile)
+Returns a relative path from
+baselineFile to targetFile. |
+
TransformationTemplate |
+getTransformationTemplate()
+Returns the transformation template this utility belongs to
+ |
+
String |
+getUnlessConditionAttributeName()
+Return the "unless" condition attribute name associated with this transformation operation,
+ or null, if there is none
+ |
+
boolean |
+hasBeenPerformed()
+Returns true only if this utility has already been performed
+ |
+
int |
+hashCode() |
+
protected int |
+hashCode(int superHashCode,
+ Object... elements)
+Calculates and return a hash code starting from the
+ hash code generated from superclass
+ |
+
boolean |
+isFileSet()
+Return true only if a file has been set.
+ |
+
boolean |
+isSaveResult()
+This flag indicates whether the value produced by the transformation utility execution,
+ and also its result object as a whole, should both be saved in the transformation
+ context object.
+ |
+
protected static String |
+normalizeRelativePathSeparator(String relativePath) |
+
PerformResult |
+perform(File transformedAppFolder,
+ TransformationContext transformationContext)
+Performs the transformation utility against
+ the application to be transformed
+
++ This is the one called by the transformation + engine, and regardless of any customization it + could have, it must always: + + 1- Call applyPropertiesFromContext(TransformationContext)
+ 2- Call execution(File, TransformationContext)
+
+ + This method is NOT supposed to be overwritten, + unless you really know what you are doing. |
+
T |
+relative(String relativePath)
+Sets the relative path from the application root folder
+ to the file or folder the transformation utility should perform against.
+ |
+
T |
+set(String propertyName,
+ String contextAttributeName)
+This method allows setting properties in this transformation
+ utility during transformation time, right before its execution.
+ |
+
T |
+setContextAttributeName(String contextAttributeName)
+Set the name to be used as key for the result of this utility
+ when saved into the transformation context.
+ |
+
protected T |
+setName(String name)
+Set this transformation utility instance name.
+ |
+
T |
+setParent(com.paypal.butterfly.extensions.api.TransformationUtilityParent parent,
+ int order)
+Register this utility to its parent, and also assign it a name
+ based on the parent name and order of execution.
+ |
+
protected T |
+setSaveResult(boolean saveResult)
+Sets whether or not the value produced by the transformation utility execution,
+ and also its result object as a whole, should both be saved in the transformation
+ context object.
+ |
+
String |
+toString() |
+
boolean |
+wasFileExplicitlySet()
+Return true only if a file has been set explicitly either via
+relative(String) or absolute(String). |
+
protected static final String UTILITY_NAME_SYNTAX+
protected T setName(String name)+
name - transformation utility instance namepublic final String getName()+
public T setContextAttributeName(String contextAttributeName)+
contextAttributeName - the name to be used as key for the result of this utility
+ when saved into the transformation context.public String getContextAttributeName()+
public final T setParent(com.paypal.butterfly.extensions.api.TransformationUtilityParent parent, + int order)+
TransformationTemplateparent - the parent to be set to this utilityorder - the order of execution of this utilitypublic com.paypal.butterfly.extensions.api.TransformationUtilityParent getParent()+
public TransformationTemplate getTransformationTemplate()+
public abstract String getDescription()+
public int getOrder()+
public final T relative(String relativePath)+
relativePath - from the application root folder
+ to the file or folder the transformation utility should be performed againstprotected static String normalizeRelativePathSeparator(String relativePath)+
protected final String getRelativePath()+
protected final File getAbsoluteFile(File transformedAppFolder, + TransformationContext transformationContext) + throws TransformationUtilityException+
transformedAppFolder - the folder where the transformed application code istransformationContext - the transformation context objectTransformationUtilityExceptionpublic static String getRelativePath(File baselineFile, + File targetFile)+
baselineFile to targetFile.
+ The file separator used is specific to the current OS. If the baseline file
+ is not entirely within the path to target file, then the target file
+ absolute path is returnedbaselineFile - the file whose returned relative path should start from.
+ It must be aa direct or indirect parent file to targetFiletargetFile - the file whose returned relative path should take tobaselineFile to targetFilepublic final T set(String propertyName, + String contextAttributeName)+
propertyName - the transformation utility Java property namecontextAttributeName - the name of the transformation context attribute whose
+ value will be set as the property value right before
+ executionprotected final void applyPropertiesFromContext(TransformationContext transformationContext) + throws TransformationUtilityException+
transformationContext - the transformation context objectTransformationUtilityExceptionpublic T absolute(String contextAttributeName)+
relative(String)). That should be the chosen option whenever
+ the relative location is known during transformation template definition time.
+ getAbsoluteFile(File, TransformationContext), relative(String)
+ and getRelativePath()contextAttributeName - the name of the transformation context attribute whose
+ value will be set as the absolute file right before
+ executionpublic T absolute(String contextAttributeName, + String additionalRelativePath)+
absolute(String, String), however, the absolute
+ file is set with an additional relative path, which is defined via parameter
+ additionalRelativePath. This method is powerful because it allows setting
+ the absolute file using a portion of the location (absolute) that is only known during
+ transformation time, plus also a second portion of the location (relative) that is
+ already known during definition time
+ getAbsoluteFile(File, TransformationContext), relative(String)
+ and getRelativePath()contextAttributeName - the name of the transformation context attribute whose
+ value will be set as the absolute file right before
+ executionadditionalRelativePath - an additional relative path to be added to the absolute
+ file coming from the transformation context. The path
+ separator will be normalized, similar to what happens
+ in relative(String)public PerformResult perform(File transformedAppFolder, + TransformationContext transformationContext) + throws TransformationUtilityException+
applyPropertiesFromContext(TransformationContext)execution(File, TransformationContext)transformedAppFolder - the folder where the transformed application code istransformationContext - the transformation context objectTransformationUtilityExceptionpublic final T abortOnFailure(boolean abort)+
abort - if set to true, abort the whole transformation if validation or execution fails.
+ If not, just state a warning, aborts the operation execution onlypublic final T abortOnFailure(boolean abort, + String abortionMessage)+
abort - if set to true, abort the whole transformation if validation or execution fails.
+ If not, just state a warning, aborts the operation execution onlyabortionMessage - a message to be logged if a fail happens and transformation
+ has to be abortedpublic String getAbortionMessage()+
public final boolean abortOnFailure()+
public boolean isSaveResult()+
Log,
+ where no value will be produced and nothing should be saved to the
+ transformation context attributeprotected T setSaveResult(boolean saveResult)+
isSaveResult().saveResult - if the value produced by the transformation utility execution,
+ and also its result object as a whole, should both be saved in the transformation
+ context objectpublic final boolean hasBeenPerformed()+
public final T dependsOn(String... dependencies)+
PerformResult.Type.ERRORPerformResult.Type.SKIPPED_CONDITIONPerformResult.Type.SKIPPED_DEPENDENCYPerformResult.Type.EXECUTION_RESULT,
+ and the execution result type is one of the following:
+ TUExecutionResult.Type.NULL (for TUs only)TUExecutionResult.Type.ERROR (for TUs only)TOExecutionResult.Type.ERROR (for TOs only)checkDependencies(TransformationContext)Result.dependencyFailureCheck()TUExecutionResult.dependencyFailureCheck()TOExecutionResult.dependencyFailureCheck()PerformResult.dependencyFailureCheck()dependencies - the names of all transformation utilities this utility depends onprotected final List<String> getDependencies()+
dependsOn(String...).protected com.paypal.butterfly.extensions.api.Result checkDependencies(TransformationContext transformationContext)+
dependsOn(String...)
+ to find out the dependency failure criteriatransformationContext - the transformation context object, in this case used
+ to check all past executed utilitiespublic final T executeIf(String conditionAttributeName)+
conditionAttributeName - the name of the transformation context attribute which
+ holds a boolean value used to evaluate if this
+ utility should be executed or notpublic final T executeIf(UtilityCondition utilityCondition)+
utilityCondition object,
+ executed right before this TU, result in true.
+ executeIf(String):
+ attribute) with the condition result, this method is based on the direct execution of the UtilityCondition objectUtilityCondition object is always executed necessarily against the same file set in the transformation utility it is being used. Because of that, any value set in the condition itself via relative(String) or absolute(String) is ignored.UtilityCondition object does not produce any TCA, neither its result value or result object. Instead, it hands its result directly to the TU, so that the condition can be evaluated just before the TU executes (or not, if it fails).UtilityCondition object does not exist from a transformation template point of view. That means this method is totally different than adding a new UtilityCondition object by calling TransformationTemplate.add(TransformationUtility).UtilityCondition object is not the one used, but a copy of itutilityCondition - the condition to be executed and evaluated right before this TUpublic final T executeUnless(String conditionAttributeName)+
conditionAttributeName - the name of the transformation context attribute which
+ holds a boolean value used to evaluate if this
+ utility should be executed or notpublic String getIfConditionAttributeName()+
public String getUnlessConditionAttributeName()+
protected abstract ExecutionResult execution(File transformedAppFolder, + TransformationContext transformationContext)+
isSaveResult() returns false.
+ ExecutionResult error object.transformedAppFolder - the folder where the transformed application code istransformationContext - the transformation context objectpublic final boolean isFileSet()+
TransformationUtility has its file set automatically by
+ default to "" which means the root of the application. That is NOT the case though for TransformationOperation
+ object, which must set them explicitly via relative(String) or absolute(String).public final boolean wasFileExplicitlySet()+
relative(String) or absolute(String).
+ If set via relative(String) it will only return true if set to anything other than "", which would mean the root of the application.relative(String) or absolute(String)public T clone()+
false
+ in the clone object to be returned. See hasBeenPerformed().public T copy()+
protected static void checkForBlankString(String name, + String value) + throws TransformationDefinitionException+
TransformationDefinitionException is thrown.
+ name - the name of the propertyvalue - the value to be verifiedTransformationDefinitionException - if check failsprotected static void checkForEmptyString(String name, + String value) + throws TransformationDefinitionException+
TransformationDefinitionException is thrown.
+ name - the name of the propertyvalue - the value to be verifiedTransformationDefinitionException - if check failsprotected static void checkForNull(String name, + Object value) + throws TransformationDefinitionException+
TransformationDefinitionException is thrown.
+ name - the name of the propertyvalue - the value to be verifiedTransformationDefinitionException - if check failspublic boolean equals(Object obj)+
protected final int hashCode(int superHashCode, + Object... elements)+
superHashCode - hash code generated from superclasselements - array of Objects to be used to generate hashcode.
+ These elements should be the attributes used in
+ the equals methodCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationUtilityGroup.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationUtilityGroup.html new file mode 100644 index 00000000..6386c382 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationUtilityGroup.html @@ -0,0 +1,730 @@ + + + + + + +public class TransformationUtilityGroup +extends TransformationUtility<TransformationUtilityGroup>+
TransformationUtility.executeIf(String) to the group), or to loop them, etc.UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
TransformationUtilityGroup() |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+add(TransformationUtility utility)
+Adds a new transformation utility to the end of the list.
+ |
+
String |
+add(TransformationUtility utility,
+ String utilityName)
+Adds a new transformation utility to the end of the list.
+ |
+
String |
+addMultiple(TransformationOperation templateOperation,
+ String... attributes)
+Adds a special transformation utility to perform multiple transformation operations against
+ multiple files specified as a list, held as a transformation context attribute
+
+ |
+
TransformationUtilityGroup |
+clone()
+Creates and returns a clone object identical to the original object,
+ except for the "has been performed" flag, which is set to
+false
+ in the clone object to be returned. |
+
void |
+debug(String debugMessage)
+Adds a new
+Log TU to the list,
+ setting its log level to DEBUG |
+
void |
+debug(String debugMessage,
+ String... attributeNames)
+Adds a new
+Log TU to the list,
+ setting its log level to DEBUG. |
+
protected ExecutionResult |
+execution(File transformedAppFolder,
+ TransformationContext transformationContext)
+The implementation execution of this transformation utility.
+ |
+
List<TransformationUtility> |
+getChildren()
+Return an immutable list of all children
+ |
+
String |
+getDescription()
+Returns a short one line, but SPECIFIC, description about the transformation
+ utility, including mentioning the files and/or folders
+ to be manipulated.
+ |
+
List<TransformationUtility> |
+getUtilities()
+Returns an immutable ordered list of transformation utilities in this list
+ |
+
void |
+info(String infoMessage)
+Adds a new
+Log TU to the list,
+ setting its log level to INFO |
+
void |
+info(String infoMessage,
+ String... attributeNames)
+Adds a new
+Log TU to the list,
+ setting its log level to INFO. |
+
void |
+log(org.slf4j.event.Level logLevel,
+ String logMessage)
+Adds a new
+Log TU to the list |
+
void |
+log(org.slf4j.event.Level logLevel,
+ String logMessage,
+ String... attributeNames)
+Adds a new
+Log TU to the list. |
+
void |
+log(String logMessage)
+Deprecated.
+ |
+
void |
+log(String logMessage,
+ String... attributeNames)
+Deprecated.
+ |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetfinalize, getClass, notify, notifyAll, wait, wait, waitgetNamepublic TransformationUtilityGroup()+
public String getDescription()+
TransformationUtilitygetDescription in class TransformationUtility<TransformationUtilityGroup>public String add(TransformationUtility utility)+
utility - the utility to be addedpublic String add(TransformationUtility utility, + String utilityName)+
utility - the utility to be addedutilityName - the name to be set to the utility before adding itpublic String addMultiple(TransformationOperation templateOperation, + String... attributes)+
templateOperation - a template of transformation operation to be performed
+ against all specified filesattributes - one or more transformation context attributes that hold list
+ of Files which the transformation operations should perform
+ against@Deprecated +public final void log(String logMessage)+
info(String) instead.
+
+ Adds a new Log TU to the listlogMessage - the message to be loggedpublic final void info(String infoMessage)+
Log TU to the list,
+ setting its log level to INFOinfoMessage - the info message to be loggedpublic final void debug(String debugMessage)+
Log TU to the list,
+ setting its log level to DEBUGdebugMessage - the debug message to be loggedpublic final void log(org.slf4j.event.Level logLevel, + String logMessage)+
Log TU to the listlogLevel - the log levellogMessage - the message to be logged@Deprecated +public final void log(String logMessage, + String... attributeNames)+
info(String, String...) instead.
+
+ Adds a new Log TU to the list.
+ The log messages may contain placeholders to be replaced by transformation context
+ attribute values. Use {} as placeholder marker.logMessage - the message to be logged, containing {} placeholders to be replaced by
+ transformation context attribute valuesattributeNames - an array of names of transformation context attributes, whose values
+ are going to be used in the log messagepublic final void info(String infoMessage, + String... attributeNames)+
Log TU to the list,
+ setting its log level to INFO.
+ The log messages may contain placeholders to be replaced by transformation context
+ attribute values. Use {} as placeholder marker.infoMessage - the info message to be logged, containing {} placeholders to be replaced by
+ transformation context attribute valuesattributeNames - an array of names of transformation context attributes, whose values
+ are going to be used in the log messagepublic final void debug(String debugMessage, + String... attributeNames)+
Log TU to the list,
+ setting its log level to DEBUG.
+ The log messages may contain placeholders to be replaced by transformation context
+ attribute values. Use {} as placeholder marker.debugMessage - the debug message to be logged, containing {} placeholders to be replaced by
+ transformation context attribute valuesattributeNames - an array of names of transformation context attributes, whose values
+ are going to be used in the log messagepublic final void log(org.slf4j.event.Level logLevel, + String logMessage, + String... attributeNames)+
Log TU to the list.
+ The log messages may contain placeholders to be replaced by transformation context
+ attribute values. Use {} as placeholder marker.logLevel - the log levellogMessage - the message to be logged, containing {} placeholders to be replaced by
+ transformation context attribute valuesattributeNames - an array of names of transformation context attributes, whose values
+ are going to be used in the log messagepublic List<TransformationUtility> getUtilities()+
public List<TransformationUtility> getChildren()+
com.paypal.butterfly.extensions.api.TransformationUtilityParentprotected ExecutionResult execution(File transformedAppFolder, + TransformationContext transformationContext)+
TransformationUtilityTransformationUtility.isSaveResult() returns false.
+ ExecutionResult error object.execution in class TransformationUtility<TransformationUtilityGroup>transformedAppFolder - the folder where the transformed application code istransformationContext - the transformation context objectpublic TransformationUtilityGroup clone()+
TransformationUtilityfalse
+ in the clone object to be returned. See TransformationUtility.hasBeenPerformed().clone in class TransformationUtility<TransformationUtilityGroup>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationUtilityLoop.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationUtilityLoop.html new file mode 100644 index 00000000..89be844c --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationUtilityLoop.html @@ -0,0 +1,675 @@ + + + + + + +public class TransformationUtilityLoop +extends TransformationUtility<TransformationUtilityLoop> +implements com.paypal.butterfly.extensions.api.TransformationUtilityParent+
TransformationUtilityGroup, multiple times in a loop.
+ The number of iterations is defined by one of these options:
+ TransformationContext attribute (by its name) whose value is true or false. If that is not a boolean, or if non-existent, it will be treated as false. If that is false, the loop is interrupted.UtilityCondition object whose result is true or false. The result of this TU condition object won't be saved to the TC, it will be executed exclusively to the scope of this loop execution. Any result other than a boolean true value, including failures, will be treated as false. If that is false, the loop is interrupted.UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
TransformationUtilityLoop()
+Allows the execution of any transformation utility instance,
+ including a
+TransformationUtilityGroup, multiple times in a loop. |
+
TransformationUtilityLoop(TransformationUtility template)
+Allows the execution of any transformation utility instance,
+ including a
+TransformationUtilityGroup, multiple times in a loop. |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected ExecutionResult |
+execution(File transformedAppFolder,
+ TransformationContext transformationContext)
+Returns, as its value, the condition to keep iterating over this loop
+ |
+
String |
+getAttribute() |
+
List<TransformationUtility> |
+getChildren()
+Return an immutable list of all children
+ |
+
TransformationUtility |
+getCondition() |
+
String |
+getDescription()
+Returns a short one line, but SPECIFIC, description about the transformation
+ utility, including mentioning the files and/or folders
+ to be manipulated.
+ |
+
int |
+getIterations() |
+
int |
+getNextIteration() |
+
TransformationUtility |
+getTemplate() |
+
TransformationUtility |
+iterate()
+Returns a clone of this transformation utility loop ready for the next iteration
+ |
+
TransformationUtility |
+run()
+Returns the TU instance to be run in the this iteration.
+ |
+
TransformationUtilityLoop |
+setCondition(int iterations)
+In this case the condition to execute the next iteration is based on
+ a pre-defined number of iterations to be executed.
+ |
+
TransformationUtilityLoop |
+setCondition(String attribute)
+In this case the condition to execute the next iteration is based on
+ a
+TransformationContext attribute (specified by its name) whose
+ value is true or false. |
+
TransformationUtilityLoop |
+setCondition(UtilityCondition condition)
+In this case the condition to execute the next iteration is based on
+ a
+UtilityCondition object whose result is true or false. |
+
protected TransformationUtilityLoop |
+setName(String name)
+Set this transformation utility instance name.
+ |
+
TransformationUtilityLoop |
+setTemplate(TransformationUtility template)
+Sets the transformation utility instance to be used as a template.
+ |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setParent, setSaveResult, toString, wasFileExplicitlySetfinalize, getClass, notify, notifyAll, wait, wait, waitgetNamepublic TransformationUtilityLoop()+
TransformationUtilityGroup, multiple times in a loop.
+ The number of iterations is defined by one of these options:
+ TransformationContext attribute (by its name) whose value is true or false. If that is not a boolean, or if non-existent, it will be treated as false. If that is false, the loop is interrupted.UtilityCondition object whose result is true or false. The result of this TU condition object won't be saved to the TC, it will be executed exclusively to the scope of this loop execution. Any result other than a boolean true value, including failures, will be treated as false. If that is false, the loop is interrupted.public TransformationUtilityLoop(TransformationUtility template)+
TransformationUtilityGroup, multiple times in a loop.
+ The number of iterations is defined by one of these options:
+ TransformationContext attribute (by its name) whose value is true or false. If that is not a boolean, or if non-existent, it will be treated as false. If that is false, the loop is interrupted.UtilityCondition object whose result is true or false. The result of this TU condition object won't be saved to the TC, it will be executed exclusively to the scope of this loop execution. Any result other than a boolean true value, including failures, will be treated as false. If that is false, the loop is interrupted.template - the transformation utility instance to be used a template.
+ A clone utility instance will be created out of the template
+ for each iteration. See TransformationUtility.clone() for further information
+ about the clone object.public TransformationUtilityLoop setTemplate(TransformationUtility template)+
TransformationUtility.clone() for further information
+ about the clone object.template - the transformation utility instance to be used as template.public TransformationUtilityLoop setCondition(int iterations)+
iterations - the total number of iterations to be executedpublic TransformationUtilityLoop setCondition(String attribute)+
TransformationContext attribute (specified by its name) whose
+ value is true or false. If that is not a boolean, or if non-existent,
+ it will be treated as false. If that is false, the loop is interrupted.attribute - the name of the transformation context attribute
+ holding the boolean to be used as the condition
+ to execute the next iteration. If that is false,
+ the loop is interrupted.public TransformationUtilityLoop setCondition(UtilityCondition condition)+
UtilityCondition object whose result is true or false.
+ The result of this TU condition object won't be saved to the TC,
+ it will be executed exclusively to the scope of this loop execution.
+ Any result other than a boolean true value, including failures, will be treated as false.
+ If that is false, the loop is interrupted.condition - the UtilityCondition object whose result
+ will be used as the condition to execute the next iteration.
+ If that is false, the loop is interrupted.protected TransformationUtilityLoop setName(String name)+
TransformationUtilitysetName in class TransformationUtility<TransformationUtilityLoop>name - transformation utility instance namepublic TransformationUtility getTemplate()+
public int getIterations()+
public String getAttribute()+
public TransformationUtility getCondition()+
public int getNextIteration()+
public String getDescription()+
TransformationUtilitygetDescription in class TransformationUtility<TransformationUtilityLoop>public List<TransformationUtility> getChildren()+
com.paypal.butterfly.extensions.api.TransformationUtilityParentgetChildren in interface com.paypal.butterfly.extensions.api.TransformationUtilityParentprotected ExecutionResult execution(File transformedAppFolder, + TransformationContext transformationContext)+
execution in class TransformationUtility<TransformationUtilityLoop>transformedAppFolder - the folder where the transformed application code istransformationContext - the transformation context objectpublic TransformationUtility run()+
public TransformationUtility iterate()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/UtilityCondition.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/UtilityCondition.html new file mode 100644 index 00000000..8efc7c64 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/UtilityCondition.html @@ -0,0 +1,293 @@ + + + + + + +public abstract class UtilityCondition<U extends UtilityCondition> +extends TransformationUtility<U>+
TransformationUtility classes, every
+ UtilityCondition subclass result type must always
+ be boolean. The criteria to the condition can be
+ based on a single file (when checking if a particular
+ file contains a given word for example) or multiple files
+ (when comparing two files for example).
+
+ IMPORTANT:
+ Every UtilityCondition subclass MUST be a Java bean, which means they must have
+ a public no arguments default constructor, and also public setters and getters for all
+ their properties. In addition to that, every setter must return the
+ UtilityCondition instance.UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
UtilityCondition() |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, execution, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getDescription, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/ContextAttributeRetriever.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/ContextAttributeRetriever.html new file mode 100644 index 00000000..606631e3 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/ContextAttributeRetriever.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/DoubleCondition.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/DoubleCondition.html new file mode 100644 index 00000000..7ebbfff5 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/DoubleCondition.html @@ -0,0 +1,172 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+DoubleCondition<T extends DoubleCondition>
+Transformation utility condition to determine if a transformation utility
+ should be executed or not, based on a two files criteria.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/ExecutionResult.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/ExecutionResult.html new file mode 100644 index 00000000..7958bf8a --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/ExecutionResult.html @@ -0,0 +1,268 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| com.paypal.butterfly.extensions.api.utilities | +
+ Basic transformation utilities.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+TOExecutionResult
+The meta-data object resulted after the
+TransformationOperation instance has been executed. |
+
class |
+TUExecutionResult
+The meta-data object resulted after the
+TransformationUtility instance has been executed. |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected ExecutionResult |
+ContextAttributeRetriever.execution(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
protected abstract ExecutionResult |
+TransformationUtility.execution(File transformedAppFolder,
+ TransformationContext transformationContext)
+The implementation execution of this transformation utility.
+ |
+
protected ExecutionResult |
+TransformationUtilityGroup.execution(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
protected ExecutionResult |
+TransformationUtilityLoop.execution(File transformedAppFolder,
+ TransformationContext transformationContext)
+Returns, as its value, the condition to keep iterating over this loop
+ |
+
ExecutionResult |
+PerformResult.getExecutionResult()
+Return the
+ExecutionResult object associated with this perform result |
+
| Modifier and Type | +Method and Description | +
|---|---|
static PerformResult |
+PerformResult.executionResult(TransformationUtility transformationUtility,
+ ExecutionResult executionResult)
+This means the utility has been executed,
+ and the result type is defined based on the utility execution result type.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected ExecutionResult |
+Abort.execution(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
protected ExecutionResult |
+ManualInstruction.execution(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
protected ExecutionResult |
+MapValue.execution(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/Extension.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/Extension.html new file mode 100644 index 00000000..11fb5564 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/Extension.html @@ -0,0 +1,172 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
abstract Class<? extends Extension> |
+TransformationTemplate.getExtensionClass()
+Returns the class of the extension this transformation
+ template belongs to
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/FilterFiles.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/FilterFiles.html new file mode 100644 index 00000000..092bf996 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/FilterFiles.html @@ -0,0 +1,182 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
FilterFiles |
+FilterFiles.setConditionTemplate(SingleCondition conditionTemplate)
+Set the single condition template to be evaluated against all files
+ |
+
FilterFiles |
+FilterFiles.setFiles(String... filesAttributes)
+Sets one or more transformation context attributes that hold list of Files
+ which the single condition should be evaluated against.
+ |
+
protected FilterFiles |
+FilterFiles.setName(String name) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/MultipleConditions.Mode.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/MultipleConditions.Mode.html new file mode 100644 index 00000000..031b6b7d --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/MultipleConditions.Mode.html @@ -0,0 +1,199 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
MultipleConditions.Mode |
+MultipleConditions.getMode()
+Return the evaluation mode
+ |
+
static MultipleConditions.Mode |
+MultipleConditions.Mode.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static MultipleConditions.Mode[] |
+MultipleConditions.Mode.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
MultipleConditions |
+MultipleConditions.setMode(MultipleConditions.Mode mode)
+Set the evaluation mode.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/MultipleConditions.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/MultipleConditions.html new file mode 100644 index 00000000..7a766ebb --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/MultipleConditions.html @@ -0,0 +1,189 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
MultipleConditions |
+MultipleConditions.setConditionTemplate(SingleCondition conditionTemplate)
+Set the utility condition template used to create conditions
+ to be evaluated against the list of files
+ |
+
MultipleConditions |
+MultipleConditions.setFiles(String... filesAttributes)
+Sets one or more transformation context attributes that hold list of Files
+ which the condition should perform against.
+ |
+
MultipleConditions |
+MultipleConditions.setMode(MultipleConditions.Mode mode)
+Set the evaluation mode.
+ |
+
MultipleConditions |
+MultipleConditions.setName(String name) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/MultipleOperations.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/MultipleOperations.html new file mode 100644 index 00000000..9c65493f --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/MultipleOperations.html @@ -0,0 +1,191 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
MultipleOperations |
+MultipleOperations.setFiles(String... filesAttributes)
+Sets one or more transformation context attributes that hold list of Files
+ which the transformation operations should perform against.
+ |
+
MultipleOperations |
+MultipleOperations.setName(String name) |
+
MultipleOperations |
+MultipleOperations.setOperationTemplate(TransformationOperation templateOperation)
+Sets the template of transformation operation to be performed against all specified files.
+ |
+
MultipleOperations |
+MultipleOperations.setProperties(String propertyName,
+ String propertyAttribute)
+This setter is similar to
+TransformationUtility.set(String, String), however it is more powerful, because
+ it allows setting, during transformation time, different properties values for each operation of a
+ MultipleOperations. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/PerformResult.Type.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/PerformResult.Type.html new file mode 100644 index 00000000..bd774232 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/PerformResult.Type.html @@ -0,0 +1,215 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| com.paypal.butterfly.extensions.api.utilities | +
+ Basic transformation utilities.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static PerformResult.Type |
+PerformResult.Type.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static PerformResult.Type[] |
+PerformResult.Type.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
PerformResult.Type[] |
+ResultCondition.getPerformResultTypes() |
+
| Modifier and Type | +Method and Description | +
|---|---|
ResultCondition |
+ResultCondition.setPerformResultTypes(PerformResult.Type... performResultTypes) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/PerformResult.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/PerformResult.html new file mode 100644 index 00000000..d6e9c52e --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/PerformResult.html @@ -0,0 +1,235 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static PerformResult |
+PerformResult.error(TransformationUtility transformationUtility,
+ Exception exception)
+This means The TU failed, but not because of its utility execution itself, but because of an internal reason.
+ |
+
static PerformResult |
+PerformResult.error(TransformationUtility transformationUtility,
+ Exception exception,
+ String details)
+This means The TU failed, but not because of its utility execution itself, but because of an internal reason.
+ |
+
static PerformResult |
+PerformResult.executionResult(TransformationUtility transformationUtility,
+ ExecutionResult executionResult)
+This means the utility has been executed,
+ and the result type is defined based on the utility execution result type.
+ |
+
PerformResult |
+TransformationContext.getResult(String utilityName)
+Returns the performing result of the
+TransformationUtility
+ identified by the specified name. |
+
PerformResult |
+TransformationOperation.perform(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
PerformResult |
+TransformationUtility.perform(File transformedAppFolder,
+ TransformationContext transformationContext)
+Performs the transformation utility against
+ the application to be transformed
+
++ This is the one called by the transformation + engine, and regardless of any customization it + could have, it must always: + + 1- Call TransformationUtility.applyPropertiesFromContext(TransformationContext)
+ 2- Call TransformationUtility.execution(File, TransformationContext)
+
+ + This method is NOT supposed to be overwritten, + unless you really know what you are doing. |
+
static PerformResult |
+PerformResult.skippedCondition(TransformationUtility transformationUtility,
+ String details)
+This means the utility has not been executed
+ because its pre-requisite condition is not true
+ |
+
static PerformResult |
+PerformResult.skippedDependency(TransformationUtility transformationUtility,
+ String details)
+This means the utility has not been executed because one or more
+ of its dependencies "failed".
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/SingleCondition.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/SingleCondition.html new file mode 100644 index 00000000..64c95b78 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/SingleCondition.html @@ -0,0 +1,245 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+SingleCondition<T extends SingleCondition>
+Transformation utility condition to determine if a transformation utility
+ should be executed or not, based on an one file criteria.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
SingleCondition |
+FilterFiles.getConditionTemplate()
+Return the single condition template to be evaluated against all files
+ |
+
SingleCondition |
+MultipleConditions.getConditionTemplate()
+Return the condition template
+ |
+
SingleCondition |
+FilterFiles.newConditionInstance(File transformedAppFolder,
+ File file)
+Creates a new single condition instance copying from this current
+ object, but setting the file it should perform against based
+ on the input parameters
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
FilterFiles |
+FilterFiles.setConditionTemplate(SingleCondition conditionTemplate)
+Set the single condition template to be evaluated against all files
+ |
+
MultipleConditions |
+MultipleConditions.setConditionTemplate(SingleCondition conditionTemplate)
+Set the utility condition template used to create conditions
+ to be evaluated against the list of files
+ |
+
| Constructor and Description | +
|---|
FilterFiles(SingleCondition conditionTemplate)
+Utility to filter a list of files based on a given
+
+SingleCondition,
+ returning in a sub-list of files |
+
MultipleConditions(SingleCondition conditionTemplate)
+Perform one transformation utility condition against multiple files,
+ returning true if at least one file meets the condition (default mode).
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TOExecutionResult.Type.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TOExecutionResult.Type.html new file mode 100644 index 00000000..1c09ab1c --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TOExecutionResult.Type.html @@ -0,0 +1,215 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| com.paypal.butterfly.extensions.api.utilities | +
+ Basic transformation utilities.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static TOExecutionResult.Type |
+TOExecutionResult.Type.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static TOExecutionResult.Type[] |
+TOExecutionResult.Type.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
TOExecutionResult.Type[] |
+ResultCondition.getToExecutionResultTypes() |
+
| Modifier and Type | +Method and Description | +
|---|---|
ResultCondition |
+ResultCondition.setToExecutionResultTypes(TOExecutionResult.Type... toExecutionResultTypes) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TOExecutionResult.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TOExecutionResult.html new file mode 100644 index 00000000..a0cbe90e --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TOExecutionResult.html @@ -0,0 +1,222 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static TOExecutionResult |
+TOExecutionResult.error(TransformationOperation transformationOperation,
+ Exception exception)
+Creates and returns a new
+TOExecutionResult.Type.ERROR result |
+
static TOExecutionResult |
+TOExecutionResult.error(TransformationOperation transformationOperation,
+ Exception exception,
+ String details)
+Creates and returns a new
+TOExecutionResult.Type.ERROR result |
+
static TOExecutionResult |
+TOExecutionResult.noOp(TransformationOperation transformationOperation,
+ String details)
+Creates and returns a new
+TOExecutionResult.Type.NO_OP result |
+
static TOExecutionResult |
+TOExecutionResult.success(TransformationOperation transformationOperation,
+ String details)
+Creates and returns a new
+TOExecutionResult.Type.SUCCESS result |
+
static TOExecutionResult |
+TOExecutionResult.warning(TransformationOperation transformationOperation)
+Creates and returns a new
+TOExecutionResult.Type.WARNING result |
+
static TOExecutionResult |
+TOExecutionResult.warning(TransformationOperation transformationOperation,
+ Exception exception)
+Creates and returns a new
+TOExecutionResult.Type.WARNING result |
+
static TOExecutionResult |
+TOExecutionResult.warning(TransformationOperation transformationOperation,
+ Exception exception,
+ String details)
+Creates and returns a new
+TOExecutionResult.Type.WARNING result |
+
static TOExecutionResult |
+TOExecutionResult.warning(TransformationOperation transformationOperation,
+ String details)
+Creates and returns a new
+TOExecutionResult.Type.WARNING result |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TUExecutionResult.Type.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TUExecutionResult.Type.html new file mode 100644 index 00000000..e20f16dc --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TUExecutionResult.Type.html @@ -0,0 +1,215 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| com.paypal.butterfly.extensions.api.utilities | +
+ Basic transformation utilities.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static TUExecutionResult.Type |
+TUExecutionResult.Type.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static TUExecutionResult.Type[] |
+TUExecutionResult.Type.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
TUExecutionResult.Type[] |
+ResultCondition.getTuExecutionResultTypes() |
+
| Modifier and Type | +Method and Description | +
|---|---|
ResultCondition |
+ResultCondition.setTuExecutionResultTypes(TUExecutionResult.Type... tuExecutionResultTypes) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TUExecutionResult.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TUExecutionResult.html new file mode 100644 index 00000000..3a2e1d8c --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TUExecutionResult.html @@ -0,0 +1,272 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| com.paypal.butterfly.extensions.api.utilities | +
+ Basic transformation utilities.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static TUExecutionResult |
+TUExecutionResult.error(TransformationUtility transformationUtility,
+ Exception exception) |
+
static TUExecutionResult |
+TUExecutionResult.error(TransformationUtility transformationUtility,
+ Exception exception,
+ Object value) |
+
static TUExecutionResult |
+TUExecutionResult.error(TransformationUtility transformationUtility,
+ Object value,
+ Exception exception,
+ String details) |
+
protected TUExecutionResult |
+DoubleCondition.execution(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
protected TUExecutionResult |
+FilterFiles.execution(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
protected TUExecutionResult |
+MultipleConditions.execution(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
protected TUExecutionResult |
+MultipleOperations.execution(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
static TUExecutionResult |
+TUExecutionResult.nullResult(TransformationUtility transformationUtility) |
+
static TUExecutionResult |
+TUExecutionResult.nullResult(TransformationUtility transformationUtility,
+ String details) |
+
static TUExecutionResult |
+TUExecutionResult.value(TransformationUtility transformationUtility,
+ Object value) |
+
static TUExecutionResult |
+TUExecutionResult.value(TransformationUtility transformationUtility,
+ String details,
+ Object value) |
+
static TUExecutionResult |
+TUExecutionResult.warning(TransformationUtility transformationUtility,
+ Exception exception,
+ Object value) |
+
static TUExecutionResult |
+TUExecutionResult.warning(TransformationUtility transformationUtility,
+ Exception exception,
+ String details,
+ Object value) |
+
static TUExecutionResult |
+TUExecutionResult.warning(TransformationUtility transformationUtility,
+ String details,
+ Object value) |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected TUExecutionResult |
+Log.execution(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
protected TUExecutionResult |
+ResultCondition.execution(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TransformationContext.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TransformationContext.html new file mode 100644 index 00000000..fa1111bc --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TransformationContext.html @@ -0,0 +1,306 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| com.paypal.butterfly.extensions.api.utilities | +
+ Basic transformation utilities.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+TransformationUtility.applyPropertiesFromContext(TransformationContext transformationContext)
+Applies transformation utility properties during transformation time, but
+ prior to execution (right before it).
+ |
+
protected com.paypal.butterfly.extensions.api.Result |
+TransformationUtility.checkDependencies(TransformationContext transformationContext)
+Check if any of dependency of this TU failed.
+ |
+
protected ExecutionResult |
+ContextAttributeRetriever.execution(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
protected TUExecutionResult |
+DoubleCondition.execution(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
protected TUExecutionResult |
+FilterFiles.execution(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
protected TUExecutionResult |
+MultipleConditions.execution(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
protected TUExecutionResult |
+MultipleOperations.execution(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
protected abstract ExecutionResult |
+TransformationUtility.execution(File transformedAppFolder,
+ TransformationContext transformationContext)
+The implementation execution of this transformation utility.
+ |
+
protected ExecutionResult |
+TransformationUtilityGroup.execution(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
protected ExecutionResult |
+TransformationUtilityLoop.execution(File transformedAppFolder,
+ TransformationContext transformationContext)
+Returns, as its value, the condition to keep iterating over this loop
+ |
+
protected File |
+TransformationUtility.getAbsoluteFile(File transformedAppFolder,
+ TransformationContext transformationContext)
+Returns an absolute path to the file or folder the transformation
+ utility is supposed to perform against
+ |
+
protected File |
+TransformationOperation.getOrCreateReadFile(File transformedAppFolder,
+ TransformationContext transformationContext)
+Creates and returns a temporary read-only copy of the file to be modified.
+ |
+
PerformResult |
+TransformationOperation.perform(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
PerformResult |
+TransformationUtility.perform(File transformedAppFolder,
+ TransformationContext transformationContext)
+Performs the transformation utility against
+ the application to be transformed
+
++ This is the one called by the transformation + engine, and regardless of any customization it + could have, it must always: + + 1- Call TransformationUtility.applyPropertiesFromContext(TransformationContext)
+ 2- Call TransformationUtility.execution(File, TransformationContext)
+
+ + This method is NOT supposed to be overwritten, + unless you really know what you are doing. |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected ExecutionResult |
+Abort.execution(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
protected TUExecutionResult |
+Log.execution(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
protected ExecutionResult |
+ManualInstruction.execution(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
protected ExecutionResult |
+MapValue.execution(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
protected TUExecutionResult |
+ResultCondition.execution(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TransformationOperation.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TransformationOperation.html new file mode 100644 index 00000000..a8118fbe --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TransformationOperation.html @@ -0,0 +1,340 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| com.paypal.butterfly.extensions.api.operations | +
+ Basic transformation operations.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+TransformationOperation<T extends TransformationOperation>
+Special type of
+TransformationUtility that applies a modification to the project. |
+
| Modifier and Type | +Method and Description | +
|---|---|
TransformationOperation |
+MultipleOperations.getTemplateOperation() |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+TransformationTemplate.addMultiple(TransformationOperation templateOperation,
+ String... attributes)
+Adds a special transformation utility to perform multiple transformation operations against
+ multiple files specified as a list, held as a transformation context attribute
+
+ |
+
String |
+TransformationUtilityGroup.addMultiple(TransformationOperation templateOperation,
+ String... attributes) |
+
static TOExecutionResult |
+TOExecutionResult.error(TransformationOperation transformationOperation,
+ Exception exception)
+Creates and returns a new
+TOExecutionResult.Type.ERROR result |
+
static TOExecutionResult |
+TOExecutionResult.error(TransformationOperation transformationOperation,
+ Exception exception,
+ String details)
+Creates and returns a new
+TOExecutionResult.Type.ERROR result |
+
static TOExecutionResult |
+TOExecutionResult.noOp(TransformationOperation transformationOperation,
+ String details)
+Creates and returns a new
+TOExecutionResult.Type.NO_OP result |
+
MultipleOperations |
+MultipleOperations.setOperationTemplate(TransformationOperation templateOperation)
+Sets the template of transformation operation to be performed against all specified files.
+ |
+
static TOExecutionResult |
+TOExecutionResult.success(TransformationOperation transformationOperation,
+ String details)
+Creates and returns a new
+TOExecutionResult.Type.SUCCESS result |
+
static TOExecutionResult |
+TOExecutionResult.warning(TransformationOperation transformationOperation)
+Creates and returns a new
+TOExecutionResult.Type.WARNING result |
+
static TOExecutionResult |
+TOExecutionResult.warning(TransformationOperation transformationOperation,
+ Exception exception)
+Creates and returns a new
+TOExecutionResult.Type.WARNING result |
+
static TOExecutionResult |
+TOExecutionResult.warning(TransformationOperation transformationOperation,
+ Exception exception,
+ String details)
+Creates and returns a new
+TOExecutionResult.Type.WARNING result |
+
static TOExecutionResult |
+TOExecutionResult.warning(TransformationOperation transformationOperation,
+ String details)
+Creates and returns a new
+TOExecutionResult.Type.WARNING result |
+
| Constructor and Description | +
|---|
MultipleOperations(TransformationOperation templateOperation)
+Utility to perform multiple transformation operations.
+ |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+AddElement<T extends TransformationOperation>
+This interface should be implemented by
+TransformationOperation
+ subclasses that intend to modify a project by adding elements to it,
+ standardizing the behavior and API if the element to be added already exists. |
+
interface |
+ChangeOrRemoveElement<T extends TransformationOperation>
+This interface should be implemented by
+TransformationOperation
+ subclasses that intend to modify a project by changing or modify elements,
+ standardizing the behavior and API in the absence of the element to be manipulated. |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AddElementTO<T extends AddElementTO>
+Convenience class with
+AddElement implementation ready for TransformationOperation subclasses. |
+
class |
+ChangeOrRemoveElementTO<T extends ChangeOrRemoveElementTO>
+Convenience class with
+ChangeOrRemoveElement implementation ready for TransformationOperation subclasses. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TransformationTemplate.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TransformationTemplate.html new file mode 100644 index 00000000..856ea7b3 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TransformationTemplate.html @@ -0,0 +1,235 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| com.paypal.butterfly.extensions.api.upgrade | +
+ API to support defining upgrade transformation templates.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
TransformationTemplate |
+TransformationUtility.getTransformationTemplate()
+Returns the transformation template this utility belongs to
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Class<? extends TransformationTemplate> |
+Extension.automaticResolution(File applicationFolder)
+Butterfly might be able to automatically identify, based on the application
+ content, the most applicable transformation template to transform it.
+ |
+
List<Class<? extends TransformationTemplate>> |
+Extension.getTemplateClasses()
+Returns a read-only set containing all transformation template classes
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected E |
+Extension.add(Class<? extends TransformationTemplate> templateClass)
+Adds a new transformation template class to the set
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+UpgradeStep
+A special type of upgrade template that takes an application
+ from one minor version to the next subsequent available version.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TransformationUtility.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TransformationUtility.html new file mode 100644 index 00000000..389dbd61 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TransformationUtility.html @@ -0,0 +1,566 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| com.paypal.butterfly.extensions.api.operations | +
+ Basic transformation operations.
+ |
+
| com.paypal.butterfly.extensions.api.utilities | +
+ Basic transformation utilities.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+TransformationUtility<T extends TransformationUtility>
+Gathers information about the project to be transformed without applying any modification on it.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+ContextAttributeRetriever<T>
+Transformation utility to fetch transformation context attributes post
+ transformation time, since they are always set
+ during transformation time.
+ |
+
class |
+DoubleCondition<T extends DoubleCondition>
+Transformation utility condition to determine if a transformation utility
+ should be executed or not, based on a two files criteria.
+ |
+
class |
+FilterFiles
+Transformation utility to filter a list of files based on a given
+
+SingleCondition,
+ returning in a sub-list of files. |
+
class |
+MultipleConditions
+Transformation utility condition to determine if a transformation utility should be executed or not,
+ based on a multiple files criteria.
+ |
+
class |
+MultipleOperations
+Transformation utility to perform multiple transformation operations.
+ |
+
class |
+SingleCondition<T extends SingleCondition>
+Transformation utility condition to determine if a transformation utility
+ should be executed or not, based on an one file criteria.
+ |
+
class |
+TransformationOperation<T extends TransformationOperation>
+Special type of
+TransformationUtility that applies a modification to the project. |
+
class |
+TransformationUtilityGroup
+Group of transformation utilities.
+ |
+
class |
+TransformationUtilityLoop
+Allows the execution of any transformation utility instance,
+ including a
+TransformationUtilityGroup, multiple times in a loop. |
+
class |
+UtilityCondition<U extends UtilityCondition>
+Condition to determine if a transformation utility
+ should be executed or not.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
TransformationUtility |
+TransformationUtilityLoop.getCondition() |
+
TransformationUtility |
+TransformationUtilityLoop.getTemplate() |
+
TransformationUtility |
+TransformationUtilityLoop.iterate()
+Returns a clone of this transformation utility loop ready for the next iteration
+ |
+
TransformationUtility |
+TransformationUtilityLoop.run()
+Returns the TU instance to be run in the this iteration.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
List<TransformationUtility> |
+MultipleOperations.getChildren() |
+
List<TransformationUtility> |
+TransformationTemplate.getChildren() |
+
List<TransformationUtility> |
+TransformationUtilityGroup.getChildren() |
+
List<TransformationUtility> |
+TransformationUtilityLoop.getChildren() |
+
List<TransformationUtility> |
+TransformationTemplate.getUtilities()
+Returns a read-only ordered list of transformation utilities to be executed,
+ which defines the actual transformation offered by this template
+ |
+
List<TransformationUtility> |
+TransformationUtilityGroup.getUtilities() |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+TransformationTemplate.add(TransformationUtility utility)
+Adds a new transformation utility to the end of the list.
+ |
+
String |
+TransformationUtilityGroup.add(TransformationUtility utility) |
+
String |
+TransformationTemplate.add(TransformationUtility utility,
+ String utilityName)
+Adds a new transformation utility to the end of the list.
+ |
+
String |
+TransformationUtilityGroup.add(TransformationUtility utility,
+ String utilityName) |
+
static PerformResult |
+PerformResult.error(TransformationUtility transformationUtility,
+ Exception exception)
+This means The TU failed, but not because of its utility execution itself, but because of an internal reason.
+ |
+
static TUExecutionResult |
+TUExecutionResult.error(TransformationUtility transformationUtility,
+ Exception exception) |
+
static TUExecutionResult |
+TUExecutionResult.error(TransformationUtility transformationUtility,
+ Exception exception,
+ Object value) |
+
static PerformResult |
+PerformResult.error(TransformationUtility transformationUtility,
+ Exception exception,
+ String details)
+This means The TU failed, but not because of its utility execution itself, but because of an internal reason.
+ |
+
static TUExecutionResult |
+TUExecutionResult.error(TransformationUtility transformationUtility,
+ Object value,
+ Exception exception,
+ String details) |
+
static PerformResult |
+PerformResult.executionResult(TransformationUtility transformationUtility,
+ ExecutionResult executionResult)
+This means the utility has been executed,
+ and the result type is defined based on the utility execution result type.
+ |
+
String |
+TransformationTemplate.loop(TransformationUtility utility,
+ int iterations)
+Execute an utility in a loop a number times specified in
+iterations |
+
String |
+TransformationTemplate.loop(TransformationUtility utility,
+ String attribute)
+Execute an utility in a loop while the value in
+TransformationContext attribute is true. |
+
String |
+TransformationTemplate.loop(TransformationUtility utility,
+ UtilityCondition condition)
+Execute an utility in a loop while the execution value resulted by
+condition is true. |
+
static TUExecutionResult |
+TUExecutionResult.nullResult(TransformationUtility transformationUtility) |
+
static TUExecutionResult |
+TUExecutionResult.nullResult(TransformationUtility transformationUtility,
+ String details) |
+
TransformationUtilityLoop |
+TransformationUtilityLoop.setTemplate(TransformationUtility template)
+Sets the transformation utility instance to be used as a template.
+ |
+
static PerformResult |
+PerformResult.skippedCondition(TransformationUtility transformationUtility,
+ String details)
+This means the utility has not been executed
+ because its pre-requisite condition is not true
+ |
+
static PerformResult |
+PerformResult.skippedDependency(TransformationUtility transformationUtility,
+ String details)
+This means the utility has not been executed because one or more
+ of its dependencies "failed".
+ |
+
static TUExecutionResult |
+TUExecutionResult.value(TransformationUtility transformationUtility,
+ Object value) |
+
static TUExecutionResult |
+TUExecutionResult.value(TransformationUtility transformationUtility,
+ String details,
+ Object value) |
+
static TUExecutionResult |
+TUExecutionResult.warning(TransformationUtility transformationUtility,
+ Exception exception,
+ Object value) |
+
static TUExecutionResult |
+TUExecutionResult.warning(TransformationUtility transformationUtility,
+ Exception exception,
+ String details,
+ Object value) |
+
static TUExecutionResult |
+TUExecutionResult.warning(TransformationUtility transformationUtility,
+ String details,
+ Object value) |
+
| Constructor and Description | +
|---|
TransformationUtilityLoop(TransformationUtility template)
+Allows the execution of any transformation utility instance,
+ including a
+TransformationUtilityGroup, multiple times in a loop. |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AddElementTO<T extends AddElementTO>
+Convenience class with
+AddElement implementation ready for TransformationOperation subclasses. |
+
class |
+ChangeOrRemoveElementTO<T extends ChangeOrRemoveElementTO>
+Convenience class with
+ChangeOrRemoveElement implementation ready for TransformationOperation subclasses. |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+Abort
+Aborts the transformation immediately.
+ |
+
class |
+Log
+Provides logging statements during transformation time.
+ |
+
class |
+ManualInstruction
+Registers a manual instruction, also known as "post-upgrade instruction", which can be seen as
+ a transformation operation that is too complex to be automated, but that should at least be recognized and reported by Butterfly.
+ |
+
class |
+MapValue
+Obtains a specific entry from a
+Map object stored in the TransformationContext,
+ and store its value as a new attribute in the transformation context. |
+
class |
+ResultCondition
+Checks the perform result, and optionally execution result as well, of a
+TransformationUtility instance. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TransformationUtilityGroup.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TransformationUtilityGroup.html new file mode 100644 index 00000000..f00b1101 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TransformationUtilityGroup.html @@ -0,0 +1,169 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
TransformationUtilityGroup |
+TransformationUtilityGroup.clone() |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TransformationUtilityLoop.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TransformationUtilityLoop.html new file mode 100644 index 00000000..dd2fe2de --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/TransformationUtilityLoop.html @@ -0,0 +1,197 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
TransformationUtilityLoop |
+TransformationUtilityLoop.setCondition(int iterations)
+In this case the condition to execute the next iteration is based on
+ a pre-defined number of iterations to be executed.
+ |
+
TransformationUtilityLoop |
+TransformationUtilityLoop.setCondition(String attribute)
+In this case the condition to execute the next iteration is based on
+ a
+TransformationContext attribute (specified by its name) whose
+ value is true or false. |
+
TransformationUtilityLoop |
+TransformationUtilityLoop.setCondition(UtilityCondition condition)
+In this case the condition to execute the next iteration is based on
+ a
+UtilityCondition object whose result is true or false. |
+
protected TransformationUtilityLoop |
+TransformationUtilityLoop.setName(String name) |
+
TransformationUtilityLoop |
+TransformationUtilityLoop.setTemplate(TransformationUtility template)
+Sets the transformation utility instance to be used as a template.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/UtilityCondition.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/UtilityCondition.html new file mode 100644 index 00000000..b7ccfb40 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/class-use/UtilityCondition.html @@ -0,0 +1,276 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| com.paypal.butterfly.extensions.api.utilities | +
+ Basic transformation utilities.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+UtilityCondition<U extends UtilityCondition>
+Condition to determine if a transformation utility
+ should be executed or not.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+DoubleCondition<T extends DoubleCondition>
+Transformation utility condition to determine if a transformation utility
+ should be executed or not, based on a two files criteria.
+ |
+
class |
+MultipleConditions
+Transformation utility condition to determine if a transformation utility should be executed or not,
+ based on a multiple files criteria.
+ |
+
class |
+SingleCondition<T extends SingleCondition>
+Transformation utility condition to determine if a transformation utility
+ should be executed or not, based on an one file criteria.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
UtilityCondition |
+MultipleConditions.newConditionInstance(File transformedAppFolder,
+ File file)
+Creates a new condition instance copying from this current
+ object, but setting the file it should perform against based
+ on the input parameters
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
T |
+TransformationUtility.executeIf(UtilityCondition utilityCondition)
+When set, this TU will only execute if this
+utilityCondition object,
+ executed right before this TU, result in true. |
+
String |
+TransformationTemplate.loop(TransformationUtility utility,
+ UtilityCondition condition)
+Execute an utility in a loop while the execution value resulted by
+condition is true. |
+
TransformationUtilityLoop |
+TransformationUtilityLoop.setCondition(UtilityCondition condition)
+In this case the condition to execute the next iteration is based on
+ a
+UtilityCondition object whose result is true or false. |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+ResultCondition
+Checks the perform result, and optionally execution result as well, of a
+TransformationUtility instance. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/ApplicationValidationException.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/ApplicationValidationException.html new file mode 100644 index 00000000..3493da5a --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/ApplicationValidationException.html @@ -0,0 +1,291 @@ + + + + + + +public class ApplicationValidationException +extends ButterflyRuntimeException+
| Constructor and Description | +
|---|
ApplicationValidationException(String exceptionMessage) |
+
ApplicationValidationException(String exceptionMessage,
+ Exception exception) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/ButterflyException.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/ButterflyException.html new file mode 100644 index 00000000..87936224 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/ButterflyException.html @@ -0,0 +1,285 @@ + + + + + + +public class ButterflyException +extends Exception+
| Constructor and Description | +
|---|
ButterflyException(String exceptionMessage) |
+
ButterflyException(String exceptionMessage,
+ Throwable throwable) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/ButterflyRuntimeException.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/ButterflyRuntimeException.html new file mode 100644 index 00000000..a46c49b3 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/ButterflyRuntimeException.html @@ -0,0 +1,290 @@ + + + + + + +public class ButterflyRuntimeException +extends RuntimeException+
| Constructor and Description | +
|---|
ButterflyRuntimeException(String exceptionMessage) |
+
ButterflyRuntimeException(String exceptionMessage,
+ Exception exception) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TemplateResolutionException.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TemplateResolutionException.html new file mode 100644 index 00000000..593b5cac --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TemplateResolutionException.html @@ -0,0 +1,306 @@ + + + + + + +public class TemplateResolutionException +extends ButterflyException+
Extension.automaticResolution(File)
+ whenever a transformation template cannot be resolved.| Constructor and Description | +
|---|
TemplateResolutionException(String message)
+This exception is thrown by
+Extension.automaticResolution(File)
+ whenever transformation template cannot be resolved |
+
TemplateResolutionException(String message,
+ Exception exception)
+This exception is thrown by
+Extension.automaticResolution(File)
+ whenever transformation template cannot be resolved |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringpublic TemplateResolutionException(String message)+
Extension.automaticResolution(File)
+ whenever transformation template cannot be resolvedmessage - explains why a transformation template could not be chosenpublic TemplateResolutionException(String message, + Exception exception)+
Extension.automaticResolution(File)
+ whenever transformation template cannot be resolvedmessage - explains why a transformation template could not be chosenexception - reason why a transformation template could not be chosenCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TransformationDefinitionException.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TransformationDefinitionException.html new file mode 100644 index 00000000..01c36a29 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TransformationDefinitionException.html @@ -0,0 +1,291 @@ + + + + + + +public class TransformationDefinitionException +extends ButterflyRuntimeException+
| Constructor and Description | +
|---|
TransformationDefinitionException(String exceptionMessage) |
+
TransformationDefinitionException(String exceptionMessage,
+ Exception exception) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TransformationOperationException.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TransformationOperationException.html new file mode 100644 index 00000000..f640c2bb --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TransformationOperationException.html @@ -0,0 +1,299 @@ + + + + + + +public class TransformationOperationException +extends TransformationUtilityException+
TransformationOperation.
+ This might cause a transformation abortion or not,
+ depending on TransformationUtility.abortOnFailure().| Constructor and Description | +
|---|
TransformationOperationException(String exceptionMessage) |
+
TransformationOperationException(String exceptionMessage,
+ Exception exception) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TransformationUtilityException.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TransformationUtilityException.html new file mode 100644 index 00000000..195c85a5 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TransformationUtilityException.html @@ -0,0 +1,297 @@ + + + + + + +public class TransformationUtilityException +extends ButterflyRuntimeException+
TransformationUtility.
+ Transformation utility exceptions ALWAYS abort the transformation process.| Constructor and Description | +
|---|
TransformationUtilityException(String exceptionMessage) |
+
TransformationUtilityException(String exceptionMessage,
+ Exception exception) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/class-use/ApplicationValidationException.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/class-use/ApplicationValidationException.html new file mode 100644 index 00000000..de1f959e --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/class-use/ApplicationValidationException.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/class-use/ButterflyException.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/class-use/ButterflyException.html new file mode 100644 index 00000000..10600142 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/class-use/ButterflyException.html @@ -0,0 +1,171 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api.exception | +
+ Butterfly exceptions.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+TemplateResolutionException
+Thrown by
+Extension.automaticResolution(File)
+ whenever a transformation template cannot be resolved. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/class-use/ButterflyRuntimeException.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/class-use/ButterflyRuntimeException.html new file mode 100644 index 00000000..3c503c16 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/class-use/ButterflyRuntimeException.html @@ -0,0 +1,190 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api.exception | +
+ Butterfly exceptions.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+ApplicationValidationException
+Thrown whenever the application to be transformed is not in a valid state.
+ |
+
class |
+TransformationDefinitionException
+Thrown whenever a transformation template definition is not well formed.
+ |
+
class |
+TransformationOperationException
+Thrown whenever an unexpected behavior or result
+ during execution of a
+TransformationOperation. |
+
class |
+TransformationUtilityException
+Thrown whenever an unexpected behavior or result
+ during execution of a
+TransformationUtility. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/class-use/TemplateResolutionException.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/class-use/TemplateResolutionException.html new file mode 100644 index 00000000..3e789db6 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/class-use/TemplateResolutionException.html @@ -0,0 +1,172 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Class<? extends TransformationTemplate> |
+Extension.automaticResolution(File applicationFolder)
+Butterfly might be able to automatically identify, based on the application
+ content, the most applicable transformation template to transform it.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/class-use/TransformationDefinitionException.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/class-use/TransformationDefinitionException.html new file mode 100644 index 00000000..c35e9f4b --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/class-use/TransformationDefinitionException.html @@ -0,0 +1,189 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected static void |
+TransformationUtility.checkForBlankString(String name,
+ String value)
+Check if value is a blank String, if it is, then a
+
+TransformationDefinitionException is thrown. |
+
protected static void |
+TransformationUtility.checkForEmptyString(String name,
+ String value)
+Check if value is an empty String, if it is, then a
+
+TransformationDefinitionException is thrown. |
+
protected static void |
+TransformationUtility.checkForNull(String name,
+ Object value)
+Check if value is null, if it is, then a
+
+TransformationDefinitionException is thrown. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/class-use/TransformationOperationException.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/class-use/TransformationOperationException.html new file mode 100644 index 00000000..7f93406b --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/class-use/TransformationOperationException.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/class-use/TransformationUtilityException.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/class-use/TransformationUtilityException.html new file mode 100644 index 00000000..a3adeb00 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/class-use/TransformationUtilityException.html @@ -0,0 +1,231 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| com.paypal.butterfly.extensions.api.exception | +
+ Butterfly exceptions.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+TransformationUtility.applyPropertiesFromContext(TransformationContext transformationContext)
+Applies transformation utility properties during transformation time, but
+ prior to execution (right before it).
+ |
+
protected File |
+TransformationUtility.getAbsoluteFile(File transformedAppFolder,
+ TransformationContext transformationContext)
+Returns an absolute path to the file or folder the transformation
+ utility is supposed to perform against
+ |
+
PerformResult |
+TransformationOperation.perform(File transformedAppFolder,
+ TransformationContext transformationContext) |
+
PerformResult |
+TransformationUtility.perform(File transformedAppFolder,
+ TransformationContext transformationContext)
+Performs the transformation utility against
+ the application to be transformed
+
++ This is the one called by the transformation + engine, and regardless of any customization it + could have, it must always: + + 1- Call TransformationUtility.applyPropertiesFromContext(TransformationContext)
+ 2- Call TransformationUtility.execution(File, TransformationContext)
+
+ + This method is NOT supposed to be overwritten, + unless you really know what you are doing. |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+TransformationOperationException
+Thrown whenever an unexpected behavior or result
+ during execution of a
+TransformationOperation. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/package-frame.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/package-frame.html new file mode 100644 index 00000000..9937412c --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/package-frame.html @@ -0,0 +1,27 @@ + + + + + + +See: Description
+| Exception | +Description | +
|---|---|
| ApplicationValidationException | +
+ Thrown whenever the application to be transformed is not in a valid state.
+ |
+
| ButterflyException | +
+ Butterfly generic checked exception.
+ |
+
| ButterflyRuntimeException | +
+ Butterfly generic runtime exception.
+ |
+
| TemplateResolutionException | +
+ Thrown by
+Extension.automaticResolution(File)
+ whenever a transformation template cannot be resolved. |
+
| TransformationDefinitionException | +
+ Thrown whenever a transformation template definition is not well formed.
+ |
+
| TransformationOperationException | +
+ Thrown whenever an unexpected behavior or result
+ during execution of a
+TransformationOperation. |
+
| TransformationUtilityException | +
+ Thrown whenever an unexpected behavior or result
+ during execution of a
+TransformationUtility. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/package-tree.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/package-tree.html new file mode 100644 index 00000000..1ccecac5 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/package-tree.html @@ -0,0 +1,166 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/package-use.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/package-use.html new file mode 100644 index 00000000..7fdd8030 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/package-use.html @@ -0,0 +1,210 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| com.paypal.butterfly.extensions.api.exception | +
+ Butterfly exceptions.
+ |
+
| Class and Description | +
|---|
| TemplateResolutionException
+ Thrown by
+Extension.automaticResolution(File)
+ whenever a transformation template cannot be resolved. |
+
| TransformationDefinitionException
+ Thrown whenever a transformation template definition is not well formed.
+ |
+
| TransformationUtilityException
+ Thrown whenever an unexpected behavior or result
+ during execution of a
+TransformationUtility. |
+
| Class and Description | +
|---|
| ButterflyException
+ Butterfly generic checked exception.
+ |
+
| ButterflyRuntimeException
+ Butterfly generic runtime exception.
+ |
+
| TransformationUtilityException
+ Thrown whenever an unexpected behavior or result
+ during execution of a
+TransformationUtility. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/AddElement.IfPresent.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/AddElement.IfPresent.html new file mode 100644 index 00000000..24484dd4 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/AddElement.IfPresent.html @@ -0,0 +1,401 @@ + + + + + + +public static enum AddElement.IfPresent +extends Enum<AddElement.IfPresent>+
TOExecutionResult.Type,
+ although they are intentionally not supposed to match necessarily one-to-one.| Enum Constant and Description | +
|---|
Fail
+Fail if the element to be added is already present
+ |
+
NoOp
+Do nothing, not add, not warn neither fail, if the element to be added is already present
+ |
+
Overwrite
+Overwrite and not warn if the element to be added is already present
+ |
+
WarnButAdd
+Warn, but add, if the element to be added is already present
+ |
+
WarnNotAdd
+Warn and do not add if the element to be added is already present
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static AddElement.IfPresent |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static AddElement.IfPresent[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final AddElement.IfPresent Fail+
public static final AddElement.IfPresent WarnNotAdd+
public static final AddElement.IfPresent WarnButAdd+
public static final AddElement.IfPresent NoOp+
public static final AddElement.IfPresent Overwrite+
public static AddElement.IfPresent[] values()+
+for (AddElement.IfPresent c : AddElement.IfPresent.values()) + System.out.println(c); +
public static AddElement.IfPresent valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/AddElement.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/AddElement.html new file mode 100644 index 00000000..fc73809c --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/AddElement.html @@ -0,0 +1,365 @@ + + + + + + +public interface AddElement<T extends TransformationOperation>
+TransformationOperation
+ subclasses that intend to modify a project by adding elements to it,
+ standardizing the behavior and API if the element to be added already exists.
+ | Modifier and Type | +Interface and Description | +
|---|---|
static class |
+AddElement.IfPresent
+Possible behaviors in case the element to be added already exists.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
T |
+failIfPresent()
+Fail (
+TOExecutionResult.Type.ERROR)
+ if the element to be added is already present |
+
T |
+noOpIfPresent()
+Do nothing, not add, not warn neither fail, (
+TOExecutionResult.Type.NO_OP)
+ if the element to be added is already present |
+
T |
+overwriteIfPresent()
+Overwrite and not warn (
+TOExecutionResult.Type.SUCCESS)
+ if the element to be added is already present |
+
T |
+warnButAddIfPresent()
+Warn, but add, (
+TOExecutionResult.Type.WARNING)
+ if the element to be added is already present |
+
T |
+warnNotAddIfPresent()
+Warn and do not add (
+TOExecutionResult.Type.WARNING)
+ if the element to be added is already present |
+
T failIfPresent()+
TOExecutionResult.Type.ERROR)
+ if the element to be added is already presentT warnNotAddIfPresent()+
TOExecutionResult.Type.WARNING)
+ if the element to be added is already presentT warnButAddIfPresent()+
TOExecutionResult.Type.WARNING)
+ if the element to be added is already presentT noOpIfPresent()+
TOExecutionResult.Type.NO_OP)
+ if the element to be added is already presentT overwriteIfPresent()+
TOExecutionResult.Type.SUCCESS)
+ if the element to be added is already presentCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/AddElementTO.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/AddElementTO.html new file mode 100644 index 00000000..8a448bba --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/AddElementTO.html @@ -0,0 +1,479 @@ + + + + + + +public abstract class AddElementTO<T extends AddElementTO> +extends TransformationOperation<T> +implements AddElement<T>+
AddElement implementation ready for TransformationOperation subclasses.
+ Protected instance variable ifPresent can be used when deciding the result type,
+ in case the element to be added is already present.AddElement.IfPresent| Modifier and Type | +Field and Description | +
|---|---|
protected AddElement.IfPresent |
+ifPresent |
+
UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
AddElementTO() |
+
| Modifier and Type | +Method and Description | +
|---|---|
T |
+failIfPresent()
+Fail (
+TOExecutionResult.Type.ERROR)
+ if the element to be added is already present |
+
T |
+noOpIfPresent()
+Do nothing, not add, not warn neither fail, (
+TOExecutionResult.Type.NO_OP)
+ if the element to be added is already present |
+
T |
+overwriteIfPresent()
+Overwrite and not warn (
+TOExecutionResult.Type.SUCCESS)
+ if the element to be added is already present |
+
T |
+warnButAddIfPresent()
+Warn, but add, (
+TOExecutionResult.Type.WARNING)
+ if the element to be added is already present |
+
T |
+warnNotAddIfPresent()
+Warn and do not add (
+TOExecutionResult.Type.WARNING)
+ if the element to be added is already present |
+
getOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, execution, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getDescription, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetprotected AddElement.IfPresent ifPresent+
public T failIfPresent()+
AddElementTOExecutionResult.Type.ERROR)
+ if the element to be added is already presentfailIfPresent in interface AddElement<T extends AddElementTO>public T warnNotAddIfPresent()+
AddElementTOExecutionResult.Type.WARNING)
+ if the element to be added is already presentwarnNotAddIfPresent in interface AddElement<T extends AddElementTO>public T warnButAddIfPresent()+
AddElementTOExecutionResult.Type.WARNING)
+ if the element to be added is already presentwarnButAddIfPresent in interface AddElement<T extends AddElementTO>public T noOpIfPresent()+
AddElementTOExecutionResult.Type.NO_OP)
+ if the element to be added is already presentnoOpIfPresent in interface AddElement<T extends AddElementTO>public T overwriteIfPresent()+
AddElementTOExecutionResult.Type.SUCCESS)
+ if the element to be added is already presentoverwriteIfPresent in interface AddElement<T extends AddElementTO>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/ChangeOrRemoveElement.IfNotPresent.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/ChangeOrRemoveElement.IfNotPresent.html new file mode 100644 index 00000000..968096db --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/ChangeOrRemoveElement.IfNotPresent.html @@ -0,0 +1,371 @@ + + + + + + +public static enum ChangeOrRemoveElement.IfNotPresent +extends Enum<ChangeOrRemoveElement.IfNotPresent>+
TOExecutionResult.Type,
+ although they are intentionally not supposed to match necessarily one-to-one.| Enum Constant and Description | +
|---|
Fail
+Fail if the element to be changed or removed is not present
+ |
+
NoOp
+Warn if the element to be changed or removed is not present
+ |
+
Warn
+Do nothing, not warn neither fail, if the element to be changed or removed is not present
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static ChangeOrRemoveElement.IfNotPresent |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static ChangeOrRemoveElement.IfNotPresent[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final ChangeOrRemoveElement.IfNotPresent Fail+
public static final ChangeOrRemoveElement.IfNotPresent NoOp+
public static final ChangeOrRemoveElement.IfNotPresent Warn+
public static ChangeOrRemoveElement.IfNotPresent[] values()+
+for (ChangeOrRemoveElement.IfNotPresent c : ChangeOrRemoveElement.IfNotPresent.values()) + System.out.println(c); +
public static ChangeOrRemoveElement.IfNotPresent valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/ChangeOrRemoveElement.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/ChangeOrRemoveElement.html new file mode 100644 index 00000000..61a78bb8 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/ChangeOrRemoveElement.html @@ -0,0 +1,321 @@ + + + + + + +public interface ChangeOrRemoveElement<T extends TransformationOperation>
+TransformationOperation
+ subclasses that intend to modify a project by changing or modify elements,
+ standardizing the behavior and API in the absence of the element to be manipulated.
+ | Modifier and Type | +Interface and Description | +
|---|---|
static class |
+ChangeOrRemoveElement.IfNotPresent
+Possible behaviors in case the element to be changed or removed is not present.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
T |
+failIfNotPresent()
+Fail (
+TOExecutionResult.Type.ERROR)
+ if the element to be changed or removed is not present |
+
T |
+noOpIfNotPresent()
+Do nothing, not warn neither fail, (
+TOExecutionResult.Type.NO_OP)
+ if the element to be changed or removed is not present |
+
T |
+warnIfNotPresent()
+Warn (
+TOExecutionResult.Type.WARNING)
+ if the element to be changed or removed is not present |
+
T failIfNotPresent()+
TOExecutionResult.Type.ERROR)
+ if the element to be changed or removed is not presentT warnIfNotPresent()+
TOExecutionResult.Type.WARNING)
+ if the element to be changed or removed is not presentT noOpIfNotPresent()+
TOExecutionResult.Type.NO_OP)
+ if the element to be changed or removed is not presentCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/ChangeOrRemoveElementTO.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/ChangeOrRemoveElementTO.html new file mode 100644 index 00000000..f2da6736 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/ChangeOrRemoveElementTO.html @@ -0,0 +1,429 @@ + + + + + + +public abstract class ChangeOrRemoveElementTO<T extends ChangeOrRemoveElementTO> +extends TransformationOperation<T> +implements ChangeOrRemoveElement<T>+
ChangeOrRemoveElement implementation ready for TransformationOperation subclasses.
+ Protected instance variable ifNotPresent can be used when deciding the result type,
+ in case the element to be changed or removed is not present.ChangeOrRemoveElement.IfNotPresent| Modifier and Type | +Field and Description | +
|---|---|
protected ChangeOrRemoveElement.IfNotPresent |
+ifNotPresent |
+
UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
ChangeOrRemoveElementTO() |
+
| Modifier and Type | +Method and Description | +
|---|---|
T |
+failIfNotPresent()
+Fail (
+TOExecutionResult.Type.ERROR)
+ if the element to be changed or removed is not present |
+
T |
+noOpIfNotPresent()
+Do nothing, not warn neither fail, (
+TOExecutionResult.Type.NO_OP)
+ if the element to be changed or removed is not present |
+
T |
+warnIfNotPresent()
+Warn (
+TOExecutionResult.Type.WARNING)
+ if the element to be changed or removed is not present |
+
getOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, execution, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getDescription, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetprotected ChangeOrRemoveElement.IfNotPresent ifNotPresent+
public ChangeOrRemoveElementTO()+
public T failIfNotPresent()+
ChangeOrRemoveElementTOExecutionResult.Type.ERROR)
+ if the element to be changed or removed is not presentfailIfNotPresent in interface ChangeOrRemoveElement<T extends ChangeOrRemoveElementTO>public T warnIfNotPresent()+
ChangeOrRemoveElementTOExecutionResult.Type.WARNING)
+ if the element to be changed or removed is not presentwarnIfNotPresent in interface ChangeOrRemoveElement<T extends ChangeOrRemoveElementTO>public T noOpIfNotPresent()+
ChangeOrRemoveElementTOExecutionResult.Type.NO_OP)
+ if the element to be changed or removed is not presentnoOpIfNotPresent in interface ChangeOrRemoveElement<T extends ChangeOrRemoveElementTO>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/class-use/AddElement.IfPresent.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/class-use/AddElement.IfPresent.html new file mode 100644 index 00000000..d03d06ab --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/class-use/AddElement.IfPresent.html @@ -0,0 +1,190 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api.operations | +
+ Basic transformation operations.
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected AddElement.IfPresent |
+AddElementTO.ifPresent |
+
| Modifier and Type | +Method and Description | +
|---|---|
static AddElement.IfPresent |
+AddElement.IfPresent.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static AddElement.IfPresent[] |
+AddElement.IfPresent.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/class-use/AddElement.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/class-use/AddElement.html new file mode 100644 index 00000000..9b169bdf --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/class-use/AddElement.html @@ -0,0 +1,170 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api.operations | +
+ Basic transformation operations.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AddElementTO<T extends AddElementTO>
+Convenience class with
+AddElement implementation ready for TransformationOperation subclasses. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/class-use/AddElementTO.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/class-use/AddElementTO.html new file mode 100644 index 00000000..40a3fcfa --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/class-use/AddElementTO.html @@ -0,0 +1,170 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api.operations | +
+ Basic transformation operations.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AddElementTO<T extends AddElementTO>
+Convenience class with
+AddElement implementation ready for TransformationOperation subclasses. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/class-use/ChangeOrRemoveElement.IfNotPresent.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/class-use/ChangeOrRemoveElement.IfNotPresent.html new file mode 100644 index 00000000..ba1c58c2 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/class-use/ChangeOrRemoveElement.IfNotPresent.html @@ -0,0 +1,190 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api.operations | +
+ Basic transformation operations.
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected ChangeOrRemoveElement.IfNotPresent |
+ChangeOrRemoveElementTO.ifNotPresent |
+
| Modifier and Type | +Method and Description | +
|---|---|
static ChangeOrRemoveElement.IfNotPresent |
+ChangeOrRemoveElement.IfNotPresent.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static ChangeOrRemoveElement.IfNotPresent[] |
+ChangeOrRemoveElement.IfNotPresent.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/class-use/ChangeOrRemoveElement.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/class-use/ChangeOrRemoveElement.html new file mode 100644 index 00000000..d58c81d3 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/class-use/ChangeOrRemoveElement.html @@ -0,0 +1,170 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api.operations | +
+ Basic transformation operations.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+ChangeOrRemoveElementTO<T extends ChangeOrRemoveElementTO>
+Convenience class with
+ChangeOrRemoveElement implementation ready for TransformationOperation subclasses. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/class-use/ChangeOrRemoveElementTO.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/class-use/ChangeOrRemoveElementTO.html new file mode 100644 index 00000000..d1e7a43b --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/class-use/ChangeOrRemoveElementTO.html @@ -0,0 +1,170 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api.operations | +
+ Basic transformation operations.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+ChangeOrRemoveElementTO<T extends ChangeOrRemoveElementTO>
+Convenience class with
+ChangeOrRemoveElement implementation ready for TransformationOperation subclasses. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/package-frame.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/package-frame.html new file mode 100644 index 00000000..a89a2c05 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +See: Description
+| Interface | +Description | +
|---|---|
| AddElement<T extends TransformationOperation> | +
+ This interface should be implemented by
+TransformationOperation
+ subclasses that intend to modify a project by adding elements to it,
+ standardizing the behavior and API if the element to be added already exists. |
+
| ChangeOrRemoveElement<T extends TransformationOperation> | +
+ This interface should be implemented by
+TransformationOperation
+ subclasses that intend to modify a project by changing or modify elements,
+ standardizing the behavior and API in the absence of the element to be manipulated. |
+
| Class | +Description | +
|---|---|
| AddElementTO<T extends AddElementTO> | +
+ Convenience class with
+AddElement implementation ready for TransformationOperation subclasses. |
+
| ChangeOrRemoveElementTO<T extends ChangeOrRemoveElementTO> | +
+ Convenience class with
+ChangeOrRemoveElement implementation ready for TransformationOperation subclasses. |
+
| Enum | +Description | +
|---|---|
| AddElement.IfPresent | +
+ Possible behaviors in case the element to be added already exists.
+ |
+
| ChangeOrRemoveElement.IfNotPresent | +
+ Possible behaviors in case the element to be changed or removed is not present.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/package-tree.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/package-tree.html new file mode 100644 index 00000000..45f5d5e7 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/package-tree.html @@ -0,0 +1,166 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/package-use.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/package-use.html new file mode 100644 index 00000000..8e7de0db --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/package-use.html @@ -0,0 +1,192 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api.operations | +
+ Basic transformation operations.
+ |
+
| Class and Description | +
|---|
| AddElement
+ This interface should be implemented by
+TransformationOperation
+ subclasses that intend to modify a project by adding elements to it,
+ standardizing the behavior and API if the element to be added already exists. |
+
| AddElement.IfPresent
+ Possible behaviors in case the element to be added already exists.
+ |
+
| AddElementTO
+ Convenience class with
+AddElement implementation ready for TransformationOperation subclasses. |
+
| ChangeOrRemoveElement
+ This interface should be implemented by
+TransformationOperation
+ subclasses that intend to modify a project by changing or modify elements,
+ standardizing the behavior and API in the absence of the element to be manipulated. |
+
| ChangeOrRemoveElement.IfNotPresent
+ Possible behaviors in case the element to be changed or removed is not present.
+ |
+
| ChangeOrRemoveElementTO
+ Convenience class with
+ChangeOrRemoveElement implementation ready for TransformationOperation subclasses. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/package-frame.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/package-frame.html new file mode 100644 index 00000000..222d90b0 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/package-frame.html @@ -0,0 +1,48 @@ + + + + + + +See: Description
+| Interface | +Description | +
|---|---|
| TransformationContext | +
+ Holds meta-data information
+ to be shared among transformation utility objects,
+ allowing communication among them, and helping the
+ transformation process.
+ |
+
| Class | +Description | +
|---|---|
| ContextAttributeRetriever<T> | +
+ Transformation utility to fetch transformation context attributes post
+ transformation time, since they are always set
+ during transformation time.
+ |
+
| DoubleCondition<T extends DoubleCondition> | +
+ Transformation utility condition to determine if a transformation utility
+ should be executed or not, based on a two files criteria.
+ |
+
| ExecutionResult<S,R,T> | +
+ The meta-data object resulted after the
+TransformationUtility instance has been executed. |
+
| Extension<E> | +
+ A Butterfly third-party extension.
+ |
+
| FilterFiles | +
+ Transformation utility to filter a list of files based on a given
+
+SingleCondition,
+ returning in a sub-list of files. |
+
| MultipleConditions | +
+ Transformation utility condition to determine if a transformation utility should be executed or not,
+ based on a multiple files criteria.
+ |
+
| MultipleOperations | +
+ Transformation utility to perform multiple transformation operations.
+ |
+
| PerformResult | +
+ The meta-data object resulted after the
+TransformationUtility instance has been performed. |
+
| SingleCondition<T extends SingleCondition> | +
+ Transformation utility condition to determine if a transformation utility
+ should be executed or not, based on an one file criteria.
+ |
+
| TOExecutionResult | +
+ The meta-data object resulted after the
+TransformationOperation instance has been executed. |
+
| TransformationOperation<T extends TransformationOperation> | +
+ Special type of
+TransformationUtility that applies a modification to the project. |
+
| TransformationTemplate | +
+ A template made of a set of transformation utilities to be applied against an application to be transformed.
+ |
+
| TransformationUtility<T extends TransformationUtility> | +
+ Gathers information about the project to be transformed without applying any modification on it.
+ |
+
| TransformationUtilityGroup | +
+ Group of transformation utilities.
+ |
+
| TransformationUtilityLoop | +
+ Allows the execution of any transformation utility instance,
+ including a
+TransformationUtilityGroup, multiple times in a loop. |
+
| TUExecutionResult | +
+ The meta-data object resulted after the
+TransformationUtility instance has been executed. |
+
| UtilityCondition<U extends UtilityCondition> | +
+ Condition to determine if a transformation utility
+ should be executed or not.
+ |
+
| Enum | +Description | +
|---|---|
| MultipleConditions.Mode | +
+ Execution mode for
+MultipleConditions. |
+
| PerformResult.Type | +
+ The type of result after the
+TransformationUtility instance has been performed. |
+
| TOExecutionResult.Type | +
+ The type of result after the
+TransformationOperation instance has been executed. |
+
| TUExecutionResult.Type | +
+ The type of result after the
+TransformationUtility instance has been executed. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/package-tree.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/package-tree.html new file mode 100644 index 00000000..e04dd847 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/package-tree.html @@ -0,0 +1,183 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/package-use.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/package-use.html new file mode 100644 index 00000000..6319a461 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/package-use.html @@ -0,0 +1,393 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| com.paypal.butterfly.extensions.api.operations | +
+ Basic transformation operations.
+ |
+
| com.paypal.butterfly.extensions.api.upgrade | +
+ API to support defining upgrade transformation templates.
+ |
+
| com.paypal.butterfly.extensions.api.utilities | +
+ Basic transformation utilities.
+ |
+
| Class and Description | +
|---|
| DoubleCondition
+ Transformation utility condition to determine if a transformation utility
+ should be executed or not, based on a two files criteria.
+ |
+
| ExecutionResult
+ The meta-data object resulted after the
+TransformationUtility instance has been executed. |
+
| Extension
+ A Butterfly third-party extension.
+ |
+
| FilterFiles
+ Transformation utility to filter a list of files based on a given
+
+SingleCondition,
+ returning in a sub-list of files. |
+
| MultipleConditions
+ Transformation utility condition to determine if a transformation utility should be executed or not,
+ based on a multiple files criteria.
+ |
+
| MultipleConditions.Mode
+ Execution mode for
+MultipleConditions. |
+
| MultipleOperations
+ Transformation utility to perform multiple transformation operations.
+ |
+
| PerformResult
+ The meta-data object resulted after the
+TransformationUtility instance has been performed. |
+
| PerformResult.Type
+ The type of result after the
+TransformationUtility instance has been performed. |
+
| SingleCondition
+ Transformation utility condition to determine if a transformation utility
+ should be executed or not, based on an one file criteria.
+ |
+
| TOExecutionResult
+ The meta-data object resulted after the
+TransformationOperation instance has been executed. |
+
| TOExecutionResult.Type
+ The type of result after the
+TransformationOperation instance has been executed. |
+
| TransformationContext
+ Holds meta-data information
+ to be shared among transformation utility objects,
+ allowing communication among them, and helping the
+ transformation process.
+ |
+
| TransformationOperation
+ Special type of
+TransformationUtility that applies a modification to the project. |
+
| TransformationTemplate
+ A template made of a set of transformation utilities to be applied against an application to be transformed.
+ |
+
| TransformationUtility
+ Gathers information about the project to be transformed without applying any modification on it.
+ |
+
| TransformationUtilityGroup
+ Group of transformation utilities.
+ |
+
| TransformationUtilityLoop
+ Allows the execution of any transformation utility instance,
+ including a
+TransformationUtilityGroup, multiple times in a loop. |
+
| TransformationUtilityParent
+ Marker interface for every type that can be assigned as
+ the parent of a
+TransformationUtility |
+
| TUExecutionResult
+ The meta-data object resulted after the
+TransformationUtility instance has been executed. |
+
| TUExecutionResult.Type
+ The type of result after the
+TransformationUtility instance has been executed. |
+
| UtilityCondition
+ Condition to determine if a transformation utility
+ should be executed or not.
+ |
+
| Class and Description | +
|---|
| TransformationOperation
+ Special type of
+TransformationUtility that applies a modification to the project. |
+
| TransformationUtility
+ Gathers information about the project to be transformed without applying any modification on it.
+ |
+
| Class and Description | +
|---|
| TransformationTemplate
+ A template made of a set of transformation utilities to be applied against an application to be transformed.
+ |
+
| Class and Description | +
|---|
| ExecutionResult
+ The meta-data object resulted after the
+TransformationUtility instance has been executed. |
+
| PerformResult.Type
+ The type of result after the
+TransformationUtility instance has been performed. |
+
| TOExecutionResult.Type
+ The type of result after the
+TransformationOperation instance has been executed. |
+
| TransformationContext
+ Holds meta-data information
+ to be shared among transformation utility objects,
+ allowing communication among them, and helping the
+ transformation process.
+ |
+
| TransformationUtility
+ Gathers information about the project to be transformed without applying any modification on it.
+ |
+
| TUExecutionResult
+ The meta-data object resulted after the
+TransformationUtility instance has been executed. |
+
| TUExecutionResult.Type
+ The type of result after the
+TransformationUtility instance has been executed. |
+
| UtilityCondition
+ Condition to determine if a transformation utility
+ should be executed or not.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/UpgradeStep.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/UpgradeStep.html new file mode 100644 index 00000000..f90c4abe --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/UpgradeStep.html @@ -0,0 +1,344 @@ + + + + + + +public abstract class UpgradeStep +extends TransformationTemplate+
| Constructor and Description | +
|---|
UpgradeStep() |
+
| Modifier and Type | +Method and Description | +
|---|---|
abstract String |
+getCurrentVersion()
+Returns the current version of the application, in other words, the
+ version the application would be upgraded from when this upgrade
+ template is executed
+ |
+
abstract UpgradeStep |
+getNextStep()
+Returns the next
+UpgradeStep. |
+
abstract String |
+getNextVersion()
+Returns the version the application would be upgraded to
+ |
+
add, add, addMultiple, debug, debug, getApplicationName, getApplicationType, getChildren, getDescription, getExtensionClass, getName, getUtilities, info, info, log, log, log, log, loop, loop, loop, toStringpublic abstract String getNextVersion()+
public abstract UpgradeStep getNextStep()+
UpgradeStep.
+ Returns null if there is no UpgradeStep
+ associated with the next versionUpgradeSteppublic abstract String getCurrentVersion()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/class-use/UpgradeStep.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/class-use/UpgradeStep.html new file mode 100644 index 00000000..6a770c3e --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/class-use/UpgradeStep.html @@ -0,0 +1,170 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api.upgrade | +
+ API to support defining upgrade transformation templates.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
abstract UpgradeStep |
+UpgradeStep.getNextStep()
+Returns the next
+UpgradeStep. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/package-frame.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/package-frame.html new file mode 100644 index 00000000..54179774 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +See: Description
+| Class | +Description | +
|---|---|
| UpgradeStep | +
+ A special type of upgrade template that takes an application
+ from one minor version to the next subsequent available version.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/package-tree.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/package-tree.html new file mode 100644 index 00000000..a4f7a86d --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/package-tree.html @@ -0,0 +1,143 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/package-use.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/package-use.html new file mode 100644 index 00000000..2a0b2a52 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/package-use.html @@ -0,0 +1,164 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api.upgrade | +
+ API to support defining upgrade transformation templates.
+ |
+
| Class and Description | +
|---|
| UpgradeStep
+ A special type of upgrade template that takes an application
+ from one minor version to the next subsequent available version.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/Abort.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/Abort.html new file mode 100644 index 00000000..54396955 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/Abort.html @@ -0,0 +1,415 @@ + + + + + + +public class Abort +extends TransformationUtility<Abort>+
TransformationUtility.executeIf(String)
+ or TransformationUtility.executeUnless(String)UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
Abort()
+This transformation utility abort the transformation.
+ |
+
Abort(String abortionMessage)
+This transformation utility abort the transformation.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected ExecutionResult |
+execution(File transformedAppFolder,
+ TransformationContext transformationContext)
+The implementation execution of this transformation utility.
+ |
+
String |
+getDescription()
+Returns a short one line, but SPECIFIC, description about the transformation
+ utility, including mentioning the files and/or folders
+ to be manipulated.
+ |
+
Abort |
+setAbortionMessage(String abortionMessage)
+Set the reason to abort the transformation
+ |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic Abort()+
TransformationUtility.executeIf(String)
+ or TransformationUtility.executeUnless(String)public Abort(String abortionMessage)+
TransformationUtility.executeIf(String)
+ or TransformationUtility.executeUnless(String)abortionMessage - the reason to abort the transformation;public Abort setAbortionMessage(String abortionMessage)+
abortionMessage - the reason to abort the transformationpublic String getDescription()+
TransformationUtilitygetDescription in class TransformationUtility<Abort>protected ExecutionResult execution(File transformedAppFolder, + TransformationContext transformationContext)+
TransformationUtilityTransformationUtility.isSaveResult() returns false.
+ ExecutionResult error object.execution in class TransformationUtility<Abort>transformedAppFolder - the folder where the transformed application code istransformationContext - the transformation context objectCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/Log.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/Log.html new file mode 100644 index 00000000..a4a695da --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/Log.html @@ -0,0 +1,442 @@ + + + + + + +public class Log +extends TransformationUtility<Log>+
TUExecutionResult.Type.NULL as result of
+ execution.
+ UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
Log()
+Utility to provide logging statements during transformation time.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected TUExecutionResult |
+execution(File transformedAppFolder,
+ TransformationContext transformationContext)
+The implementation execution of this transformation utility.
+ |
+
String |
+getDescription()
+Returns a short one line, but SPECIFIC, description about the transformation
+ utility, including mentioning the files and/or folders
+ to be manipulated.
+ |
+
Log |
+setAttributeNames(String... attributeNames)
+Sets names of transformation context attributes to be used
+ as arguments for this log statement
+ |
+
Log |
+setLogLevel(org.slf4j.event.Level logLevel)
+Sets the log level
+ |
+
Log |
+setLogMessage(String logMessage)
+Sets the log message
+ |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic Log()+
public Log setLogLevel(org.slf4j.event.Level logLevel)+
logLevel - log levelpublic Log setLogMessage(String logMessage)+
logMessage - log messagepublic Log setAttributeNames(String... attributeNames)+
attributeNames - names of transformation context attributes to be
+ used as arguments for this log statementpublic String getDescription()+
TransformationUtilitygetDescription in class TransformationUtility<Log>protected TUExecutionResult execution(File transformedAppFolder, + TransformationContext transformationContext)+
TransformationUtilityTransformationUtility.isSaveResult() returns false.
+ ExecutionResult error object.execution in class TransformationUtility<Log>transformedAppFolder - the folder where the transformed application code istransformationContext - the transformation context objectCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/ManualInstruction.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/ManualInstruction.html new file mode 100644 index 00000000..f8b83b7f --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/ManualInstruction.html @@ -0,0 +1,413 @@ + + + + + + +public class ManualInstruction +extends TransformationUtility<ManualInstruction>+
.md) files.UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
ManualInstruction(String description,
+ String resourceName) |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected ExecutionResult |
+execution(File transformedAppFolder,
+ TransformationContext transformationContext)
+The implementation execution of this transformation utility.
+ |
+
String |
+getDescription()
+Returns a short one line, but SPECIFIC, description about the transformation
+ utility, including mentioning the files and/or folders
+ to be manipulated.
+ |
+
String |
+getResourceName()
+Returns the instruction resource name
+ |
+
ManualInstruction |
+setDescription(String description) |
+
ManualInstruction |
+setResourceName(String resourceName) |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic ManualInstruction setDescription(String description)+
public ManualInstruction setResourceName(String resourceName)+
public String getDescription()+
TransformationUtilitygetDescription in class TransformationUtility<ManualInstruction>public String getResourceName()+
protected ExecutionResult execution(File transformedAppFolder, + TransformationContext transformationContext)+
TransformationUtilityTransformationUtility.isSaveResult() returns false.
+ ExecutionResult error object.execution in class TransformationUtility<ManualInstruction>transformedAppFolder - the folder where the transformed application code istransformationContext - the transformation context objectCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/MapValue.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/MapValue.html new file mode 100644 index 00000000..3349c2d9 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/MapValue.html @@ -0,0 +1,488 @@ + + + + + + +public class MapValue +extends TransformationUtility<MapValue>+
Map object stored in the TransformationContext,
+ and store its value as a new attribute in the transformation context. The name of the transformation
+ context attribute that holds the map object, and the key used to get the map entry, have to be specified.
+ TransformationUtility.setContextAttributeName(String) is called, as usual, nothing new here.UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
MapValue()
+This utility obtains a specific entry from a
+Map object stored in the transformation context,
+ and store its value as a new attribute in the transformation context. |
+
MapValue(String mapName,
+ Object key)
+This utility obtains a specific entry from a
+Map object stored in the transformation context,
+ and store its value as a new attribute in the transformation context. |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected ExecutionResult |
+execution(File transformedAppFolder,
+ TransformationContext transformationContext)
+The implementation execution of this transformation utility.
+ |
+
String |
+getDescription()
+Returns a short one line, but SPECIFIC, description about the transformation
+ utility, including mentioning the files and/or folders
+ to be manipulated.
+ |
+
Object |
+getKey()
+Returns he key used to get the map entry
+ |
+
String |
+getMapName()
+Return the name of the transformation context attribute that holds the map object
+ |
+
MapValue |
+setKey(Object key)
+Set the key used to get the map entry
+ |
+
MapValue |
+setMapName(String mapName)
+Set the name of the transformation context attribute that holds the map object
+ |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic MapValue()+
Map object stored in the transformation context,
+ and store its value as a new attribute in the transformation context. The name of the transformation
+ context attribute that holds the map object, and the key used to get the map entry, have to be specified.
+ TransformationUtility.setContextAttributeName(String) is called, as usual, nothing new here.public MapValue(String mapName, + Object key)+
Map object stored in the transformation context,
+ and store its value as a new attribute in the transformation context. The name of the transformation
+ context attribute that holds the map object, and the key used to get the map entry, have to be specified.
+ TransformationUtility.setContextAttributeName(String) is called, as usual, nothing new here.mapName - the name of the transformation context attribute that holds the map objectkey - the key used to get the map entrypublic MapValue setMapName(String mapName)+
mapName - the name of the transformation context attribute that holds the map objectpublic MapValue setKey(Object key)+
key - the key used to get the map entrypublic String getMapName()+
public Object getKey()+
public String getDescription()+
TransformationUtilitygetDescription in class TransformationUtility<MapValue>protected ExecutionResult execution(File transformedAppFolder, + TransformationContext transformationContext)+
TransformationUtilityTransformationUtility.isSaveResult() returns false.
+ ExecutionResult error object.execution in class TransformationUtility<MapValue>transformedAppFolder - the folder where the transformed application code istransformationContext - the transformation context objectCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/ResultCondition.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/ResultCondition.html new file mode 100644 index 00000000..8c84a752 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/ResultCondition.html @@ -0,0 +1,484 @@ + + + + + + +public class ResultCondition +extends UtilityCondition<ResultCondition>+
TransformationUtility instance.
+ If a result for the specified utility name is not found, this condition returns false, but with a warning.UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
ResultCondition() |
+
ResultCondition(String utilityName) |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected TUExecutionResult |
+execution(File transformedAppFolder,
+ TransformationContext transformationContext)
+The implementation execution of this transformation utility.
+ |
+
String |
+getDescription()
+Returns a short one line, but SPECIFIC, description about the transformation
+ utility, including mentioning the files and/or folders
+ to be manipulated.
+ |
+
PerformResult.Type[] |
+getPerformResultTypes() |
+
TOExecutionResult.Type[] |
+getToExecutionResultTypes() |
+
TUExecutionResult.Type[] |
+getTuExecutionResultTypes() |
+
String |
+getUtilityName() |
+
ResultCondition |
+setPerformResultTypes(PerformResult.Type... performResultTypes) |
+
ResultCondition |
+setToExecutionResultTypes(TOExecutionResult.Type... toExecutionResultTypes) |
+
ResultCondition |
+setTuExecutionResultTypes(TUExecutionResult.Type... tuExecutionResultTypes) |
+
ResultCondition |
+setUtilityName(String utilityName) |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic ResultCondition()+
public ResultCondition(String utilityName)+
public ResultCondition setUtilityName(String utilityName)+
public ResultCondition setPerformResultTypes(PerformResult.Type... performResultTypes)+
public ResultCondition setTuExecutionResultTypes(TUExecutionResult.Type... tuExecutionResultTypes)+
public ResultCondition setToExecutionResultTypes(TOExecutionResult.Type... toExecutionResultTypes)+
public String getUtilityName()+
public PerformResult.Type[] getPerformResultTypes()+
public TUExecutionResult.Type[] getTuExecutionResultTypes()+
public TOExecutionResult.Type[] getToExecutionResultTypes()+
public String getDescription()+
TransformationUtilitygetDescription in class TransformationUtility<ResultCondition>protected TUExecutionResult execution(File transformedAppFolder, + TransformationContext transformationContext)+
TransformationUtilityTransformationUtility.isSaveResult() returns false.
+ ExecutionResult error object.execution in class TransformationUtility<ResultCondition>transformedAppFolder - the folder where the transformed application code istransformationContext - the transformation context objectCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/class-use/Abort.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/class-use/Abort.html new file mode 100644 index 00000000..719474c6 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/class-use/Abort.html @@ -0,0 +1,170 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api.utilities | +
+ Basic transformation utilities.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Abort |
+Abort.setAbortionMessage(String abortionMessage)
+Set the reason to abort the transformation
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/class-use/Log.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/class-use/Log.html new file mode 100644 index 00000000..249a5804 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/class-use/Log.html @@ -0,0 +1,183 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api.utilities | +
+ Basic transformation utilities.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Log |
+Log.setAttributeNames(String... attributeNames)
+Sets names of transformation context attributes to be used
+ as arguments for this log statement
+ |
+
Log |
+Log.setLogLevel(org.slf4j.event.Level logLevel)
+Sets the log level
+ |
+
Log |
+Log.setLogMessage(String logMessage)
+Sets the log message
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/class-use/ManualInstruction.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/class-use/ManualInstruction.html new file mode 100644 index 00000000..1cc41cd8 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/class-use/ManualInstruction.html @@ -0,0 +1,172 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api.utilities | +
+ Basic transformation utilities.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ManualInstruction |
+ManualInstruction.setDescription(String description) |
+
ManualInstruction |
+ManualInstruction.setResourceName(String resourceName) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/class-use/MapValue.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/class-use/MapValue.html new file mode 100644 index 00000000..1e7bfb28 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/class-use/MapValue.html @@ -0,0 +1,176 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api.utilities | +
+ Basic transformation utilities.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
MapValue |
+MapValue.setKey(Object key)
+Set the key used to get the map entry
+ |
+
MapValue |
+MapValue.setMapName(String mapName)
+Set the name of the transformation context attribute that holds the map object
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/class-use/ResultCondition.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/class-use/ResultCondition.html new file mode 100644 index 00000000..96f64085 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/class-use/ResultCondition.html @@ -0,0 +1,180 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api.utilities | +
+ Basic transformation utilities.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ResultCondition |
+ResultCondition.setPerformResultTypes(PerformResult.Type... performResultTypes) |
+
ResultCondition |
+ResultCondition.setToExecutionResultTypes(TOExecutionResult.Type... toExecutionResultTypes) |
+
ResultCondition |
+ResultCondition.setTuExecutionResultTypes(TUExecutionResult.Type... tuExecutionResultTypes) |
+
ResultCondition |
+ResultCondition.setUtilityName(String utilityName) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/package-frame.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/package-frame.html new file mode 100644 index 00000000..416dcee5 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/package-frame.html @@ -0,0 +1,25 @@ + + + + + + +See: Description
+| Class | +Description | +
|---|---|
| Abort | +
+ Aborts the transformation immediately.
+ |
+
| Log | +
+ Provides logging statements during transformation time.
+ |
+
| ManualInstruction | +
+ Registers a manual instruction, also known as "post-upgrade instruction", which can be seen as
+ a transformation operation that is too complex to be automated, but that should at least be recognized and reported by Butterfly.
+ |
+
| MapValue | +
+ Obtains a specific entry from a
+Map object stored in the TransformationContext,
+ and store its value as a new attribute in the transformation context. |
+
| ResultCondition | +
+ Checks the perform result, and optionally execution result as well, of a
+TransformationUtility instance. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/package-tree.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/package-tree.html new file mode 100644 index 00000000..bc053504 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/package-tree.html @@ -0,0 +1,151 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/package-use.html b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/package-use.html new file mode 100644 index 00000000..c742eae0 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/package-use.html @@ -0,0 +1,185 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api.utilities | +
+ Basic transformation utilities.
+ |
+
| Class and Description | +
|---|
| Abort
+ Aborts the transformation immediately.
+ |
+
| Log
+ Provides logging statements during transformation time.
+ |
+
| ManualInstruction
+ Registers a manual instruction, also known as "post-upgrade instruction", which can be seen as
+ a transformation operation that is too complex to be automated, but that should at least be recognized and reported by Butterfly.
+ |
+
| MapValue
+ Obtains a specific entry from a
+Map object stored in the TransformationContext,
+ and store its value as a new attribute in the transformation context. |
+
| ResultCondition
+ Checks the perform result, and optionally execution result as well, of a
+TransformationUtility instance. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/constant-values.html b/docs/javadocs/2.3.0/butterfly-extensions-api/constant-values.html new file mode 100644 index 00000000..939c4c1e --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/constant-values.html @@ -0,0 +1,155 @@ + + + + + + +| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+protected static final String |
+UTILITY_NAME_SYNTAX |
+"%s-%d-%s" |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/deprecated-list.html b/docs/javadocs/2.3.0/butterfly-extensions-api/deprecated-list.html new file mode 100644 index 00000000..f673cc37 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/deprecated-list.html @@ -0,0 +1,157 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/help-doc.html b/docs/javadocs/2.3.0/butterfly-extensions-api/help-doc.html new file mode 100644 index 00000000..c8cd593f --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/help-doc.html @@ -0,0 +1,231 @@ + + + + + + +The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/index-all.html b/docs/javadocs/2.3.0/butterfly-extensions-api/index-all.html new file mode 100644 index 00000000..98f18bf7 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/index-all.html @@ -0,0 +1,1572 @@ + + + + + + +TransformationUtility.absolute(String, String), however, the absolute
+ file is set with an additional relative path, which is defined via parameter
+ additionalRelativePath.TransformationOperation
+ subclasses that intend to modify a project by adding elements to it,
+ standardizing the behavior and API if the element to be added already exists.AddElement implementation ready for TransformationOperation subclasses.TransformationOperation
+ subclasses that intend to modify a project by changing or modify elements,
+ standardizing the behavior and API in the absence of the element to be manipulated.ChangeOrRemoveElement implementation ready for TransformationOperation subclasses.TransformationDefinitionException is thrown.TransformationDefinitionException is thrown.TransformationDefinitionException is thrown.false
+ in the clone object to be returned.TOExecutionResult.Type.ERROR resultTOExecutionResult.Type.ERROR resultutilityCondition object,
+ executed right before this TU, result in true.TransformationUtility instance has been executed.TOExecutionResult.Type.ERROR)
+ if the element to be changed or removed is not presentTOExecutionResult.Type.ERROR)
+ if the element to be added is already presentSingleCondition,
+ returning in a sub-list of files.SingleCondition,
+ returning in a sub-list of filesSingleCondition,
+ returning in a sub-list of filesExecutionResult object associated with this perform resultUpgradeStep.baselineFile to targetFile.TransformationUtility
+ identified by the specified name.Extension.automaticResolution(File) method based on one or more Maven pom filesiterationsTransformationContext attribute is true.condition is true.Map object stored in the TransformationContext,
+ and store its value as a new attribute in the transformation context.Map object stored in the transformation context,
+ and store its value as a new attribute in the transformation context.Map object stored in the transformation context,
+ and store its value as a new attribute in the transformation context.MultipleConditions.TOExecutionResult.Type.NO_OP resultTOExecutionResult.Type.NO_OP)
+ if the element to be changed or removed is not presentTOExecutionResult.Type.NO_OP)
+ if the element to be added is already presentTOExecutionResult.Type.SUCCESS)
+ if the element to be added is already presentTransformationUtility.applyPropertiesFromContext(TransformationContext)
+ 2- Call TransformationUtility.execution(File, TransformationContext)
+
+ TransformationUtility instance has been performed.TransformationUtility instance has been performed.TransformationUtility instance.TransformationUtility
+ methods, like TransformationUtility.relative(String) or TransformationUtility.absolute(String)TransformationContext attribute (specified by its name) whose
+ value is true or false.UtilityCondition object whose result is true or false.TransformationUtility.set(String, String), however it is more powerful, because
+ it allows setting, during transformation time, different properties values for each operation of a
+ MultipleOperations.TOExecutionResult.Type.SUCCESS resultExtension.automaticResolution(File)
+ whenever a transformation template cannot be resolved.Extension.automaticResolution(File)
+ whenever transformation template cannot be resolvedExtension.automaticResolution(File)
+ whenever transformation template cannot be resolvedTransformationOperation instance has been executed.TransformationOperation instance has been executed.TransformationUtility that applies a modification to the project.TransformationOperation.TransformationUtility.TransformationUtilityGroup, multiple times in a loop.TransformationUtilityGroup, multiple times in a loop.TransformationUtilityGroup, multiple times in a loop.TransformationUtility instance has been executed.TransformationUtility instance has been executed.TOExecutionResult.Type.WARNING)
+ if the element to be added is already presentTOExecutionResult.Type.WARNING)
+ if the element to be changed or removed is not presentTOExecutionResult.Type.WARNING resultTOExecutionResult.Type.WARNING resultTOExecutionResult.Type.WARNING resultTOExecutionResult.Type.WARNING resultTOExecutionResult.Type.WARNING)
+ if the element to be added is already presentTransformationUtility.relative(String) or TransformationUtility.absolute(String).Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/index.html b/docs/javadocs/2.3.0/butterfly-extensions-api/index.html new file mode 100644 index 00000000..7ab584c8 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/index.html @@ -0,0 +1,76 @@ + + + + + + ++ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/overview-summary.html b/docs/javadocs/2.3.0/butterfly-extensions-api/overview-summary.html new file mode 100644 index 00000000..da6066f9 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/overview-summary.html @@ -0,0 +1,171 @@ + + + + + + +
| Package | +Description | +
|---|---|
| com.paypal.butterfly.extensions.api | +
+ API component to be used by Butterfly extensions when providing their
+ transformation and upgrade templates.
+ |
+
| com.paypal.butterfly.extensions.api.exception | +
+ Butterfly exceptions.
+ |
+
| com.paypal.butterfly.extensions.api.metrics | ++ |
| com.paypal.butterfly.extensions.api.operations | +
+ Basic transformation operations.
+ |
+
| com.paypal.butterfly.extensions.api.upgrade | +
+ API to support defining upgrade transformation templates.
+ |
+
| com.paypal.butterfly.extensions.api.utilities | +
+ Basic transformation utilities.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/overview-tree.html b/docs/javadocs/2.3.0/butterfly-extensions-api/overview-tree.html new file mode 100644 index 00000000..5f65dc1e --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/overview-tree.html @@ -0,0 +1,238 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/package-list b/docs/javadocs/2.3.0/butterfly-extensions-api/package-list new file mode 100644 index 00000000..aafa7034 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/package-list @@ -0,0 +1,6 @@ +com.paypal.butterfly.extensions.api +com.paypal.butterfly.extensions.api.exception +com.paypal.butterfly.extensions.api.metrics +com.paypal.butterfly.extensions.api.operations +com.paypal.butterfly.extensions.api.upgrade +com.paypal.butterfly.extensions.api.utilities diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/script.js b/docs/javadocs/2.3.0/butterfly-extensions-api/script.js new file mode 100644 index 00000000..b3463569 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/serialized-form.html b/docs/javadocs/2.3.0/butterfly-extensions-api/serialized-form.html new file mode 100644 index 00000000..fde8e945 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/serialized-form.html @@ -0,0 +1,169 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-extensions-api/stylesheet.css b/docs/javadocs/2.3.0/butterfly-extensions-api/stylesheet.css new file mode 100644 index 00000000..c4f6312c --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-extensions-api/stylesheet.css @@ -0,0 +1,571 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#0085DC; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#0085DC; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#0085DC; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding:5px 12px 7px 12px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#0085DC; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#0085DC; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/docs/javadocs/2.3.0/butterfly-utilities/allclasses-frame.html b/docs/javadocs/2.3.0/butterfly-utilities/allclasses-frame.html new file mode 100644 index 00000000..d061aa22 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/allclasses-frame.html @@ -0,0 +1,80 @@ + + + + + + +public class CompareFiles +extends com.paypal.butterfly.extensions.api.DoubleCondition<CompareFiles>+
DoubleCondition to find out how to set the baseline and the comparison filesUTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
CompareFiles()
+Compares two files and returns true if the content of the files are equal,
+ or if they both don't exist.
+ |
+
CompareFiles(String attribute)
+Compares two files and returns true if the content of the files are equal,
+ or if they both don't exist.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected boolean |
+compare(File baselineFile,
+ File comparisonFile) |
+
protected com.paypal.butterfly.extensions.api.TUExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
getAttribute, setAttributeabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic CompareFiles()+
DoubleCondition to find out how to set the baseline and the comparison filespublic CompareFiles(String attribute)+
DoubleCondition to find out how to set the baseline and the comparison filesattribute - the name of the transformation context attribute
+ that refers to the file to be compared against the baseline fileprotected boolean compare(File baselineFile, + File comparisonFile)+
compare in class com.paypal.butterfly.extensions.api.DoubleCondition<CompareFiles>public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<CompareFiles>protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.DoubleCondition<CompareFiles>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/CompareXMLFiles.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/CompareXMLFiles.html new file mode 100644 index 00000000..ec39c607 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/CompareXMLFiles.html @@ -0,0 +1,411 @@ + + + + + + +public class CompareXMLFiles +extends com.paypal.butterfly.extensions.api.DoubleCondition<CompareXMLFiles>+
DoubleCondition
+ to find out how to set the baseline and the comparison filesUTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
CompareXMLFiles()
+Compares two XML files and returns true if their contents are equal,
+ or if both files don't exist.
+ |
+
CompareXMLFiles(String attribute)
+Compares two XML files and returns true if their contents are equal,
+ or if both files don't exist.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected boolean |
+compare(File baselineFile,
+ File comparisonFile) |
+
protected com.paypal.butterfly.extensions.api.TUExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
getAttribute, setAttributeabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic CompareXMLFiles()+
DoubleCondition
+ to find out how to set the baseline and the comparison filespublic CompareXMLFiles(String attribute)+
DoubleCondition
+ to find out how to set the baseline and the comparison filesattribute - the name of the transformation context attribute
+ that refers to the file to be compared against the baseline fileprotected boolean compare(File baselineFile, + File comparisonFile)+
compare in class com.paypal.butterfly.extensions.api.DoubleCondition<CompareXMLFiles>protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.DoubleCondition<CompareXMLFiles>public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<CompareXMLFiles>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/FileExists.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/FileExists.html new file mode 100644 index 00000000..09f5dd37 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/FileExists.html @@ -0,0 +1,342 @@ + + + + + + +public class FileExists +extends com.paypal.butterfly.extensions.api.SingleCondition<FileExists>+
UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
FileExists() |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TUExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<FileExists>protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<FileExists>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/PropertyExists.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/PropertyExists.html new file mode 100644 index 00000000..c8380c2b --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/PropertyExists.html @@ -0,0 +1,408 @@ + + + + + + +public class PropertyExists +extends com.paypal.butterfly.extensions.api.SingleCondition<PropertyExists>+
setPropertyName(String),
+ or as a regular expression, via setPropertyNameRegex(String).UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
PropertyExists() |
+
PropertyExists(String propertyName) |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TUExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
String |
+getPropertyName() |
+
String |
+getPropertyNameRegex() |
+
PropertyExists |
+setPropertyName(String propertyName) |
+
PropertyExists |
+setPropertyNameRegex(String propertyNameRegex) |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic PropertyExists()+
public PropertyExists(String propertyName)+
public PropertyExists setPropertyName(String propertyName)+
public PropertyExists setPropertyNameRegex(String propertyNameRegex)+
public String getPropertyName()+
public String getPropertyNameRegex()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PropertyExists>protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<PropertyExists>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/RegexMatch.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/RegexMatch.html new file mode 100644 index 00000000..01af0cb6 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/RegexMatch.html @@ -0,0 +1,408 @@ + + + + + + +public class RegexMatch +extends com.paypal.butterfly.extensions.api.SingleCondition<RegexMatch>+
UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
RegexMatch()
+Checks if a regular expression matches any line in the specified text file.
+ |
+
RegexMatch(String regex)
+Checks if a regular expression matches any line in the specified text file.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TUExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
String |
+getRegex()
+Returns the regular expression to be evaluated against the specified text file
+ |
+
RegexMatch |
+setRegex(String regex)
+Sets the regular expression to be evaluated against the specified text file
+ |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic RegexMatch()+
public RegexMatch(String regex)+
regex - the regular expression to be evaluated against the specified text filepublic RegexMatch setRegex(String regex)+
regex - the regular expression to be evaluated against the specified text filepublic String getRegex()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<RegexMatch>protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<RegexMatch>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/class-use/CompareFiles.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/class-use/CompareFiles.html new file mode 100644 index 00000000..fc32ee07 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/class-use/CompareFiles.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/class-use/CompareXMLFiles.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/class-use/CompareXMLFiles.html new file mode 100644 index 00000000..43ffb72f --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/class-use/CompareXMLFiles.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/class-use/FileExists.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/class-use/FileExists.html new file mode 100644 index 00000000..01684d02 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/class-use/FileExists.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/class-use/PropertyExists.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/class-use/PropertyExists.html new file mode 100644 index 00000000..c1f07e40 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/class-use/PropertyExists.html @@ -0,0 +1,172 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.conditions | +
+ Multiple transformation utility conditions, organized by type, each one having its own subpackage.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
PropertyExists |
+PropertyExists.setPropertyName(String propertyName) |
+
PropertyExists |
+PropertyExists.setPropertyNameRegex(String propertyNameRegex) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/class-use/RegexMatch.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/class-use/RegexMatch.html new file mode 100644 index 00000000..48ca8bff --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/class-use/RegexMatch.html @@ -0,0 +1,170 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.conditions | +
+ Multiple transformation utility conditions, organized by type, each one having its own subpackage.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
RegexMatch |
+RegexMatch.setRegex(String regex)
+Sets the regular expression to be evaluated against the specified text file
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/AbstractTypeCheck.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/AbstractTypeCheck.html new file mode 100644 index 00000000..a2308a63 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/AbstractTypeCheck.html @@ -0,0 +1,353 @@ + + + + + + +public abstract class AbstractTypeCheck<T extends AbstractTypeCheck> +extends JavaCondition<T>+
| Constructor and Description | +
|---|
AbstractTypeCheck(Class specifiedType) |
+
AbstractTypeCheck(String specifiedTypeName) |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+eval(com.github.javaparser.ast.CompilationUnit compilationUnit)
+Evaluates this condition against the specified compilation
+ unit and returns the evaluation result.
+ |
+
protected abstract int |
+getNumberOfTypes(com.github.javaparser.ast.CompilationUnit compilationUnit) |
+
protected abstract String |
+getTypeName(com.github.javaparser.ast.CompilationUnit compilationUnit,
+ int index) |
+
isNegate, setNegatepublic AbstractTypeCheck(Class specifiedType)+
public AbstractTypeCheck(String specifiedTypeName)+
public boolean eval(com.github.javaparser.ast.CompilationUnit compilationUnit)+
JavaConditionJavaCondition.evaluate(CompilationUnit)eval in class JavaCondition<T extends AbstractTypeCheck>compilationUnit - the CompilationUnit that represents
+ the Java class to be evaluatedprotected abstract String getTypeName(com.github.javaparser.ast.CompilationUnit compilationUnit, + int index)+
protected abstract int getNumberOfTypes(com.github.javaparser.ast.CompilationUnit compilationUnit)+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/AnnotatedWith.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/AnnotatedWith.html new file mode 100644 index 00000000..569ffeaf --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/AnnotatedWith.html @@ -0,0 +1,339 @@ + + + + + + +public class AnnotatedWith +extends AbstractTypeCheck<AnnotatedWith>+
| Constructor and Description | +
|---|
AnnotatedWith(Class specifiedType) |
+
AnnotatedWith(String specifiedTypeName) |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected int |
+getNumberOfTypes(com.github.javaparser.ast.CompilationUnit compilationUnit) |
+
protected String |
+getTypeName(com.github.javaparser.ast.CompilationUnit compilationUnit,
+ int index) |
+
evalisNegate, setNegatepublic AnnotatedWith(Class specifiedType)+
public AnnotatedWith(String specifiedTypeName)+
protected String getTypeName(com.github.javaparser.ast.CompilationUnit compilationUnit, + int index)+
getTypeName in class AbstractTypeCheck<AnnotatedWith>protected int getNumberOfTypes(com.github.javaparser.ast.CompilationUnit compilationUnit)+
getNumberOfTypes in class AbstractTypeCheck<AnnotatedWith>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/Extends.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/Extends.html new file mode 100644 index 00000000..effda67b --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/Extends.html @@ -0,0 +1,339 @@ + + + + + + +public class Extends +extends AbstractTypeCheck<Extends>+
| Constructor and Description | +
|---|
Extends(Class specifiedType) |
+
Extends(String specifiedTypeName) |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected int |
+getNumberOfTypes(com.github.javaparser.ast.CompilationUnit compilationUnit) |
+
protected String |
+getTypeName(com.github.javaparser.ast.CompilationUnit compilationUnit,
+ int index) |
+
evalisNegate, setNegatepublic Extends(Class specifiedType)+
public Extends(String specifiedTypeName)+
protected String getTypeName(com.github.javaparser.ast.CompilationUnit compilationUnit, + int index)+
getTypeName in class AbstractTypeCheck<Extends>protected int getNumberOfTypes(com.github.javaparser.ast.CompilationUnit compilationUnit)+
getNumberOfTypes in class AbstractTypeCheck<Extends>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/JavaCondition.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/JavaCondition.html new file mode 100644 index 00000000..559f31f3 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/JavaCondition.html @@ -0,0 +1,350 @@ + + + + + + +public abstract class JavaCondition<T extends JavaCondition> +extends Object+
CompilationUnit.| Constructor and Description | +
|---|
JavaCondition() |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected abstract boolean |
+eval(com.github.javaparser.ast.CompilationUnit compilationUnit)
+Evaluates this condition against the specified compilation
+ unit and returns the evaluation result.
+ |
+
boolean |
+isNegate()
+Returns whether the evaluation result will be negated
+ or not.
+ |
+
T |
+setNegate(boolean negate)
+Sets whether the result should be negated, meaning,
+ resulting true whenever its evaluation result would
+ normally results false, and vice-versa.
+ |
+
protected abstract boolean eval(com.github.javaparser.ast.CompilationUnit compilationUnit)+
evaluate(CompilationUnit)compilationUnit - the CompilationUnit that represents
+ the Java class to be evaluatedpublic T setNegate(boolean negate)+
negate - the result should be negated or notpublic boolean isNegate()+
setNegate(boolean)Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/JavaMatch.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/JavaMatch.html new file mode 100644 index 00000000..977af065 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/JavaMatch.html @@ -0,0 +1,452 @@ + + + + + + +public class JavaMatch +extends com.paypal.butterfly.extensions.api.SingleCondition<JavaMatch>+
JavaCondition. It returns true only
+ if they all are true. If the specified Java class file contains
+ more than one type, only the outer one will be considered
+ during evaluation. If it has none, the evaluation will result
+ in false and a warning be returned.UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
JavaMatch()
+This utility parses and evaluates the specified Java class file
+ based on a set of
+JavaCondition. |
+
JavaMatch(JavaCondition condition)
+This utility parses and evaluates the specified Java class file
+ based on a set of
+JavaCondition. |
+
| Modifier and Type | +Method and Description | +
|---|---|
JavaMatch |
+addCondition(JavaCondition condition)
+Add a new Java condition to be evaluated against the Java class.
+ |
+
protected com.paypal.butterfly.extensions.api.TUExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
Set<JavaCondition> |
+getConditions()
+Returns the set of Java conditions to be used to
+ evaluate the specified class.
+ |
+
String |
+getDescription() |
+
JavaMatch |
+setConditions(Set<JavaCondition> conditions)
+Sets the set of Java conditions to be used to
+ evaluate the specified class.
+ |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic JavaMatch()+
JavaCondition. It returns true only
+ if they all are true. If the specified Java class file contains
+ more than one type, only the outer one will be considered
+ during evaluation. If it has none, the evaluation will result
+ in false and a warning be returned.public JavaMatch(JavaCondition condition)+
JavaCondition. It returns true only
+ if they all are true. If the specified Java class file contains
+ more than one type, only the outer one will be considered
+ during evaluation. If it has none, the evaluation will result
+ in false and a warning be returned.condition - one condition to be evaluated. More can be added with
+ addCondition(JavaCondition)public Set<JavaCondition> getConditions()+
public JavaMatch setConditions(Set<JavaCondition> conditions)+
conditions - the set of Java conditions to be used to evaluate the specified classpublic JavaMatch addCondition(JavaCondition condition)+
condition - a Java condition to be used to evaluate the specified classpublic String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<JavaMatch>protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<JavaMatch>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/class-use/AbstractTypeCheck.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/class-use/AbstractTypeCheck.html new file mode 100644 index 00000000..95fc568f --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/class-use/AbstractTypeCheck.html @@ -0,0 +1,197 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.conditions.java | +
+ Transformation utility conditions to analyze and evaluate Java class files.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AbstractTypeCheck<T extends AbstractTypeCheck>
+Evaluates the specified
+ compilation unit based on an abstract check
+ against a specified type.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AnnotatedWith
+Evaluates if the specified
+ Java class or interface is annotated with the
+ specified annotation.
+ |
+
class |
+Extends
+Evaluates if the specified
+ compilation unit directly extends the
+ specified class.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/class-use/AnnotatedWith.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/class-use/AnnotatedWith.html new file mode 100644 index 00000000..b9532fc7 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/class-use/AnnotatedWith.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/class-use/Extends.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/class-use/Extends.html new file mode 100644 index 00000000..f2b6c846 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/class-use/Extends.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/class-use/JavaCondition.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/class-use/JavaCondition.html new file mode 100644 index 00000000..a1b23e0a --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/class-use/JavaCondition.html @@ -0,0 +1,266 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.conditions.java | +
+ Transformation utility conditions to analyze and evaluate Java class files.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+JavaCondition<T extends JavaCondition>
+Abstract class to specify a condition to be
+ evaluated against a Java class, which is
+ represented as a
+CompilationUnit. |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AbstractTypeCheck<T extends AbstractTypeCheck>
+Evaluates the specified
+ compilation unit based on an abstract check
+ against a specified type.
+ |
+
class |
+AnnotatedWith
+Evaluates if the specified
+ Java class or interface is annotated with the
+ specified annotation.
+ |
+
class |
+Extends
+Evaluates if the specified
+ compilation unit directly extends the
+ specified class.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Set<JavaCondition> |
+JavaMatch.getConditions()
+Returns the set of Java conditions to be used to
+ evaluate the specified class.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
JavaMatch |
+JavaMatch.addCondition(JavaCondition condition)
+Add a new Java condition to be evaluated against the Java class.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
JavaMatch |
+JavaMatch.setConditions(Set<JavaCondition> conditions)
+Sets the set of Java conditions to be used to
+ evaluate the specified class.
+ |
+
| Constructor and Description | +
|---|
JavaMatch(JavaCondition condition)
+This utility parses and evaluates the specified Java class file
+ based on a set of
+JavaCondition. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/class-use/JavaMatch.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/class-use/JavaMatch.html new file mode 100644 index 00000000..9d9c05ca --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/class-use/JavaMatch.html @@ -0,0 +1,177 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.conditions.java | +
+ Transformation utility conditions to analyze and evaluate Java class files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
JavaMatch |
+JavaMatch.addCondition(JavaCondition condition)
+Add a new Java condition to be evaluated against the Java class.
+ |
+
JavaMatch |
+JavaMatch.setConditions(Set<JavaCondition> conditions)
+Sets the set of Java conditions to be used to
+ evaluate the specified class.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/package-frame.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/package-frame.html new file mode 100644 index 00000000..ff29b5f5 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/package-frame.html @@ -0,0 +1,25 @@ + + + + + + +See: Description
+| Class | +Description | +
|---|---|
| AbstractTypeCheck<T extends AbstractTypeCheck> | +
+ Evaluates the specified
+ compilation unit based on an abstract check
+ against a specified type.
+ |
+
| AnnotatedWith | +
+ Evaluates if the specified
+ Java class or interface is annotated with the
+ specified annotation.
+ |
+
| Extends | +
+ Evaluates if the specified
+ compilation unit directly extends the
+ specified class.
+ |
+
| JavaCondition<T extends JavaCondition> | +
+ Abstract class to specify a condition to be
+ evaluated against a Java class, which is
+ represented as a
+CompilationUnit. |
+
| JavaMatch | +
+ Parses and evaluates the specified Java class file
+ based on a set of
+JavaCondition. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/package-tree.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/package-tree.html new file mode 100644 index 00000000..d3608f0b --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/package-tree.html @@ -0,0 +1,161 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/package-use.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/package-use.html new file mode 100644 index 00000000..f8124b9b --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/package-use.html @@ -0,0 +1,178 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.conditions.java | +
+ Transformation utility conditions to analyze and evaluate Java class files.
+ |
+
| Class and Description | +
|---|
| AbstractTypeCheck
+ Evaluates the specified
+ compilation unit based on an abstract check
+ against a specified type.
+ |
+
| JavaCondition
+ Abstract class to specify a condition to be
+ evaluated against a Java class, which is
+ represented as a
+CompilationUnit. |
+
| JavaMatch
+ Parses and evaluates the specified Java class file
+ based on a set of
+JavaCondition. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/package-frame.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/package-frame.html new file mode 100644 index 00000000..01b8d680 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/package-frame.html @@ -0,0 +1,25 @@ + + + + + + +See: Description
+| Class | +Description | +
|---|---|
| CompareFiles | +
+ Compares two files and returns true if the content of the files are equal,
+ or if they both don't exist.
+ |
+
| CompareXMLFiles | +
+ Compares two XML files and returns true if their contents are equal,
+ or if both files don't exist.
+ |
+
| FileExists | +
+ Checks if a particular file or folder exists.
+ |
+
| PropertyExists | +
+ Checks if a particular property exists in a property file.
+ |
+
| RegexMatch | +
+ Checks if a regular expression matches any line in the specified text file.
+ |
+
SingleCondition,
+DoubleConditionCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/package-tree.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/package-tree.html new file mode 100644 index 00000000..f46b5bdb --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/package-tree.html @@ -0,0 +1,159 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/package-use.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/package-use.html new file mode 100644 index 00000000..96a38f96 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/package-use.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.conditions | +
+ Multiple transformation utility conditions, organized by type, each one having its own subpackage.
+ |
+
| Class and Description | +
|---|
| PropertyExists
+ Checks if a particular property exists in a property file.
+ |
+
| RegexMatch
+ Checks if a regular expression matches any line in the specified text file.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/PomDependencyExists.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/PomDependencyExists.html new file mode 100644 index 00000000..0cc6e7f8 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/PomDependencyExists.html @@ -0,0 +1,467 @@ + + + + + + +public class PomDependencyExists +extends com.paypal.butterfly.extensions.api.SingleCondition<PomDependencyExists>+
UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
PomDependencyExists() |
+
PomDependencyExists(String groupId,
+ String artifactId)
+Condition to check if a particular Maven dependency exists in a Maven pom files
+ |
+
PomDependencyExists(String groupId,
+ String artifactId,
+ String version)
+Condition to check if a particular Maven dependency exists in a Maven pom files
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TUExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getArtifactId() |
+
String |
+getDescription() |
+
String |
+getGroupId() |
+
String |
+getVersion() |
+
PomDependencyExists |
+setArtifactId(String artifactId) |
+
PomDependencyExists |
+setGroupId(String groupId) |
+
PomDependencyExists |
+setVersion(String version) |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic PomDependencyExists()+
public PomDependencyExists(String groupId, + String artifactId)+
groupId - managed dependency group idartifactId - managed dependency artifact idpublic PomDependencyExists(String groupId, + String artifactId, + String version)+
groupId - managed dependency group idartifactId - managed dependency artifact idversion - managed dependency versionpublic PomDependencyExists setGroupId(String groupId)+
public PomDependencyExists setArtifactId(String artifactId)+
public PomDependencyExists setVersion(String version)+
public String getGroupId()+
public String getArtifactId()+
public String getVersion()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomDependencyExists>protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<PomDependencyExists>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/class-use/PomDependencyExists.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/class-use/PomDependencyExists.html new file mode 100644 index 00000000..075145b8 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/class-use/PomDependencyExists.html @@ -0,0 +1,176 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.conditions.pom | +
+ Transformation utility conditions to analyze and evaluate Maven POM files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
PomDependencyExists |
+PomDependencyExists.setArtifactId(String artifactId) |
+
PomDependencyExists |
+PomDependencyExists.setGroupId(String groupId) |
+
PomDependencyExists |
+PomDependencyExists.setVersion(String version) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/package-frame.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/package-frame.html new file mode 100644 index 00000000..bc60f02d --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +See: Description
+| Class | +Description | +
|---|---|
| PomDependencyExists | +
+ Checks if a particular Maven dependency exists in a Maven pom file.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/package-tree.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/package-tree.html new file mode 100644 index 00000000..b0db9ded --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/package-tree.html @@ -0,0 +1,151 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/package-use.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/package-use.html new file mode 100644 index 00000000..25ca2aae --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/package-use.html @@ -0,0 +1,163 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.conditions.pom | +
+ Transformation utility conditions to analyze and evaluate Maven POM files.
+ |
+
| Class and Description | +
|---|
| PomDependencyExists
+ Checks if a particular Maven dependency exists in a Maven pom file.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/FindFile.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/FindFile.html new file mode 100644 index 00000000..112d1e98 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/FindFile.html @@ -0,0 +1,418 @@ + + + + + + +public class FindFile +extends com.paypal.butterfly.extensions.api.TransformationUtility<FindFile>+
failIfNotFound(boolean) is set to true.
+ If multiple files are found, an error is returned.
+ TransformationUtility.relative(String),
+ TransformationUtility.absolute(String) or TransformationUtility.absolute(String, String).
+ If not set explicitly, then the search will happen from the root
+ of the transformed application, which is equivalent to setting
+ TransformationUtility.relative(String) to "."
+ TUExecutionResult.Type.NULL
+ is returned, unless failIfNotFound(boolean) is set to true
+ FindFiles for a better refined search and to find multiple files.UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
FindFile() |
+
FindFile(String fileName)
+Utility to find a file based on its name
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TUExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
FindFile |
+failIfNotFound(boolean failIfNotFound) |
+
String |
+getDescription() |
+
String |
+getFileName() |
+
boolean |
+isFailIfNotFound() |
+
FindFile |
+setFileName(String fileName) |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic FindFile()+
public FindFile(String fileName)+
fileName - name of the file to be foundpublic FindFile failIfNotFound(boolean failIfNotFound)+
public boolean isFailIfNotFound()+
public String getFileName()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<FindFile>protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<FindFile>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/FindFiles.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/FindFiles.html new file mode 100644 index 00000000..098df0eb --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/FindFiles.html @@ -0,0 +1,717 @@ + + + + + + +public class FindFiles +extends com.paypal.butterfly.extensions.api.TransformationUtility<FindFiles>+
includeFiles and includeFolders can be used
+ to specialize the search criteria in that regard. If none of them
+ are explicitly set, only files will be searched.
+ TransformationUtility.relative(String),
+ TransformationUtility.absolute(String) or TransformationUtility.absolute(String, String).
+ If not set explicitly, then the search will happen from the root
+ of the transformed application, which is equivalent to setting
+ TransformationUtility.relative(String) to "."
+ UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
FindFiles() |
+
FindFiles(String nameRegex,
+ boolean recursive)
+Utility to find files based on a regular expression
+ against the file name.
+ |
+
FindFiles(String nameRegex,
+ boolean recursive,
+ boolean includeFiles,
+ boolean includeFolders)
+Utility to find files based on a regular expression
+ against the file name.
+ |
+
FindFiles(String nameRegex,
+ String pathRegex)
+Utility to find files based on a regular expression
+ against the file name and the file path.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TUExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
String |
+getNameRegex()
+Returns the file name regular expression
+ |
+
String |
+getPathRegex()
+Returns the file path regular expression
+ |
+
boolean |
+isIncludeFiles()
+Returns whether files should be included in the search or not
+ |
+
boolean |
+isIncludeFolders()
+Returns whether folders should be included in the search or not
+ |
+
boolean |
+isRecursive()
+Returns whether the file search is recursive or not
+ |
+
FindFiles |
+setIncludeFiles(boolean includeFiles)
+Set whether files should be included in the search or not.
+ |
+
FindFiles |
+setIncludeFolders(boolean includeFolders)
+Set whether folders should be included in the search or not.
+ |
+
FindFiles |
+setNameRegex(String nameRegex)
+Set regular expression to be used to match the file name
+ during the search
+ |
+
FindFiles |
+setPathRegex(String pathRegex)
+Set regular expression to be used to match the file path
+ during the search
++ Important notes: + + Use forward slash as file separator. |
+
FindFiles |
+setRecursive(boolean recursive)
+Set whether the search should be recursive or not.
+ |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic FindFiles()+
public FindFiles(String nameRegex, + boolean recursive)+
setIncludeFolders(boolean) is set to true.
+ TransformationUtility.relative(String),
+ TransformationUtility.absolute(String) or TransformationUtility.absolute(String, String).
+ If not set explicitly, then the search will happen from the root
+ of the transformed application, which is equivalent to setting
+ TransformationUtility.relative(String) to "."nameRegex - regular expression to be applied against file name during searchrecursive - if true, sub-folders will also be searchedpublic FindFiles(String nameRegex, + boolean recursive, + boolean includeFiles, + boolean includeFolders)+
includeFiles and includeFolders
+ are configured.
+ TransformationUtility.relative(String),
+ TransformationUtility.absolute(String) or TransformationUtility.absolute(String, String).
+ If not set explicitly, then the search will happen from the root
+ of the transformed application, which is equivalent to setting
+ TransformationUtility.relative(String) to "."nameRegex - regular expression to be applied against file name during searchrecursive - if true, sub-folders will also be searchedincludeFiles - whether files should be included in the search or notincludeFolders - whether folders should be included in the search or notpublic FindFiles(String nameRegex, + String pathRegex)+
TransformationUtility.relative(String),
+ TransformationUtility.absolute(String) or TransformationUtility.absolute(String, String).
+ If not set explicitly, then the search will happen from the root
+ of the transformed application, which is equivalent to setting
+ TransformationUtility.relative(String) to "."nameRegex - regular expression to be applied against file name during searchpathRegex - regular expression to be applied against file path during searchpublic FindFiles setNameRegex(String nameRegex)+
nameRegex - regular expression to be used to match the file name
+ during the searchpublic FindFiles setPathRegex(String pathRegex)+
pathRegex - regular expression to be used to match the file path
+ during the searchpublic FindFiles setRecursive(boolean recursive)+
recursive - whether the search should be recursivepublic FindFiles setIncludeFolders(boolean includeFolders)+
false.includeFolders - whether folders should be included in the search or notpublic FindFiles setIncludeFiles(boolean includeFiles)+
true.includeFiles - whether files should be included in the search or notpublic String getNameRegex()+
public String getPathRegex()+
public boolean isRecursive()+
public boolean isIncludeFolders()+
public boolean isIncludeFiles()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<FindFiles>protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<FindFiles>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/LoadFile.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/LoadFile.html new file mode 100644 index 00000000..a8a3003d --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/LoadFile.html @@ -0,0 +1,410 @@ + + + + + + +public class LoadFile +extends com.paypal.butterfly.extensions.api.TransformationUtility<LoadFile>+
File reference to it, which is saved in the transformation
+ context. The file is written to a temporary folder to be defined by the OS.
+ If no resource file is found, an error is returned.UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
LoadFile()
+Loads a resource from the classpath, writes it to a temporary file,
+ and then returns a
+File reference to it, which is saved in the transformation
+ context. |
+
LoadFile(String resource)
+Loads a resource from the classpath, writes it to a temporary file,
+ and then returns a
+File reference to it, which is saved in the transformation
+ context. |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TUExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
String |
+getResource()
+Returns the name of the resource in the classpath
+ |
+
LoadFile |
+setResource(String resource)
+Sets the name of the resource in the classpath.
+ |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic LoadFile()+
File reference to it, which is saved in the transformation
+ context. The file is written to a temporary folder to be defined by the OS.
+ If no resource file is found, an error is returned.public LoadFile(String resource)+
File reference to it, which is saved in the transformation
+ context. The file is written to a temporary folder to be defined by the OS.
+ If no resource file is found, an error is returned.resource - the name of the resource in the classpathpublic LoadFile setResource(String resource)+
ClassLoader.getResource(String)resource - the name of the resource in the classpathpublic String getResource()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<LoadFile>protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<LoadFile>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/LocateFile.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/LocateFile.html new file mode 100644 index 00000000..a1a57c1b --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/LocateFile.html @@ -0,0 +1,418 @@ + + + + + + +public class LocateFile +extends com.paypal.butterfly.extensions.api.TransformationUtility<LocateFile>+
File object based on the input information.
+ This utility also allows to locate a file going up in parent
+ levels from the specified file. If the specified file does
+ not exist, or if the coordinates don't make sense, an error
+ is returned.
+ UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
LocateFile()
+Locates a file based on the relative or absolute
+ location specified.
+ |
+
LocateFile(int parentLevel)
+Locates a file based on the relative or absolute
+ location specified.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TUExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
int |
+getParentLevel() |
+
LocateFile |
+setParentLevel(int parentLevel)
+Set how many parent levels up the location process should
+ go through.
+ |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic LocateFile()+
File object based on the input information.
+ This utility also allows to locate a file going up in parent
+ levels from the specified file. If the specified file does
+ not exist, or if the coordinates don't make sense, an error
+ is returned
+ public LocateFile(int parentLevel)+
File object based on the input information.
+ This utility also allows to locate a file going up in parent
+ levels from the specified file. If the specified file does
+ not exist, or if the coordinates don't make sense, an error
+ is returned
+ parentLevel - how many parent levels to be locatedpublic LocateFile setParentLevel(int parentLevel)+
parentLevel - how many parent levels to be locatedpublic int getParentLevel()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<LocateFile>protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<LocateFile>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/class-use/FindFile.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/class-use/FindFile.html new file mode 100644 index 00000000..e0d0e7b5 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/class-use/FindFile.html @@ -0,0 +1,172 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.file | +
+ Transformation utilities to gather meta-data, find and locate files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
FindFile |
+FindFile.failIfNotFound(boolean failIfNotFound) |
+
FindFile |
+FindFile.setFileName(String fileName) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/class-use/FindFiles.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/class-use/FindFiles.html new file mode 100644 index 00000000..39ee53e9 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/class-use/FindFiles.html @@ -0,0 +1,199 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.file | +
+ Transformation utilities to gather meta-data, find and locate files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
FindFiles |
+FindFiles.setIncludeFiles(boolean includeFiles)
+Set whether files should be included in the search or not.
+ |
+
FindFiles |
+FindFiles.setIncludeFolders(boolean includeFolders)
+Set whether folders should be included in the search or not.
+ |
+
FindFiles |
+FindFiles.setNameRegex(String nameRegex)
+Set regular expression to be used to match the file name
+ during the search
+ |
+
FindFiles |
+FindFiles.setPathRegex(String pathRegex)
+Set regular expression to be used to match the file path
+ during the search
++ Important notes: + + Use forward slash as file separator. |
+
FindFiles |
+FindFiles.setRecursive(boolean recursive)
+Set whether the search should be recursive or not.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/class-use/LoadFile.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/class-use/LoadFile.html new file mode 100644 index 00000000..93bb2e47 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/class-use/LoadFile.html @@ -0,0 +1,170 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.file | +
+ Transformation utilities to gather meta-data, find and locate files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
LoadFile |
+LoadFile.setResource(String resource)
+Sets the name of the resource in the classpath.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/class-use/LocateFile.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/class-use/LocateFile.html new file mode 100644 index 00000000..95905e32 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/class-use/LocateFile.html @@ -0,0 +1,171 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.file | +
+ Transformation utilities to gather meta-data, find and locate files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
LocateFile |
+LocateFile.setParentLevel(int parentLevel)
+Set how many parent levels up the location process should
+ go through.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/package-frame.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/package-frame.html new file mode 100644 index 00000000..16a1e87a --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/package-frame.html @@ -0,0 +1,24 @@ + + + + + + +See: Description
+| Class | +Description | +
|---|---|
| FindFile | +
+ Finds a file based on its name.
+ |
+
| FindFiles | +
+ Finds files based on a regular expression
+ against the file name and/or the file path.
+ |
+
| LoadFile | +
+ Loads a resource from the classpath, writes it to a temporary file,
+ and then returns a
+File reference to it, which is saved in the transformation
+ context. |
+
| LocateFile | +
+ Locates a file based on the relative or absolute
+ location specified.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/package-tree.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/package-tree.html new file mode 100644 index 00000000..63820c28 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/package-tree.html @@ -0,0 +1,146 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/package-use.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/package-use.html new file mode 100644 index 00000000..3fca7306 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/file/package-use.html @@ -0,0 +1,182 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.file | +
+ Transformation utilities to gather meta-data, find and locate files.
+ |
+
| Class and Description | +
|---|
| FindFile
+ Finds a file based on its name.
+ |
+
| FindFiles
+ Finds files based on a regular expression
+ against the file name and/or the file path.
+ |
+
| LoadFile
+ Loads a resource from the classpath, writes it to a temporary file,
+ and then returns a
+File reference to it, which is saved in the transformation
+ context. |
+
| LocateFile
+ Locates a file based on the relative or absolute
+ location specified.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/java/JavaPackage.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/java/JavaPackage.html new file mode 100644 index 00000000..1b60e272 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/java/JavaPackage.html @@ -0,0 +1,333 @@ + + + + + + +public class JavaPackage +extends com.paypal.butterfly.extensions.api.TransformationUtility<JavaPackage>+
UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
JavaPackage() |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TUExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<JavaPackage>protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<JavaPackage>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/java/class-use/JavaPackage.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/java/class-use/JavaPackage.html new file mode 100644 index 00000000..35acc23b --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/java/class-use/JavaPackage.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/java/package-frame.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/java/package-frame.html new file mode 100644 index 00000000..aabd12ac --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/java/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +See: Description
+| Class | +Description | +
|---|---|
| JavaPackage | +
+ Retrieves the package
+ of a given Java class.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/java/package-tree.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/java/package-tree.html new file mode 100644 index 00000000..bd7050e6 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/java/package-tree.html @@ -0,0 +1,143 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/java/package-use.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/java/package-use.html new file mode 100644 index 00000000..bb1dcd8c --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/java/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/EnforcerErrorsOutputHandler.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/EnforcerErrorsOutputHandler.html new file mode 100644 index 00000000..dac15afc --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/EnforcerErrorsOutputHandler.html @@ -0,0 +1,335 @@ + + + + + + +public class EnforcerErrorsOutputHandler +extends Object +implements MavenInvocationOutputHandler<EnforcerErrorsOutputHandler,Set<String>>+
| Constructor and Description | +
|---|
EnforcerErrorsOutputHandler() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+consumeLine(String line) |
+
EnforcerErrorsOutputHandler |
+copy()
+Returns a copy of this object, but with its internal state reset,
+ so it can be run in a brand new Maven invocation
+ |
+
Set<String> |
+getResult()
+Returns the desired result from parsing the console output
+ |
+
public EnforcerErrorsOutputHandler()+
public void consumeLine(String line)+
consumeLine in interface org.codehaus.plexus.util.cli.StreamConsumerpublic Set<String> getResult()+
MavenInvocationOutputHandlergetResult in interface MavenInvocationOutputHandler<EnforcerErrorsOutputHandler,Set<String>>public EnforcerErrorsOutputHandler copy()+
MavenInvocationOutputHandlercopy in interface MavenInvocationOutputHandler<EnforcerErrorsOutputHandler,Set<String>>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/GenericErrorsOutputHandler.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/GenericErrorsOutputHandler.html new file mode 100644 index 00000000..8b131e8d --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/GenericErrorsOutputHandler.html @@ -0,0 +1,335 @@ + + + + + + +public class GenericErrorsOutputHandler +extends Object +implements MavenInvocationOutputHandler<GenericErrorsOutputHandler,String>+
| Constructor and Description | +
|---|
GenericErrorsOutputHandler() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+consumeLine(String line) |
+
GenericErrorsOutputHandler |
+copy()
+Returns a copy of this object, but with its internal state reset,
+ so it can be run in a brand new Maven invocation
+ |
+
String |
+getResult()
+Returns the desired result from parsing the console output
+ |
+
public GenericErrorsOutputHandler()+
public void consumeLine(String line)+
consumeLine in interface org.codehaus.plexus.util.cli.StreamConsumerpublic String getResult()+
MavenInvocationOutputHandlergetResult in interface MavenInvocationOutputHandler<GenericErrorsOutputHandler,String>public GenericErrorsOutputHandler copy()+
MavenInvocationOutputHandlercopy in interface MavenInvocationOutputHandler<GenericErrorsOutputHandler,String>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/MavenGoal.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/MavenGoal.html new file mode 100644 index 00000000..f3cddbd1 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/MavenGoal.html @@ -0,0 +1,567 @@ + + + + + + +UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
MavenGoal()
+Utility to run one or more Maven goals against a specific Maven POM file
+ |
+
MavenGoal(String... goals)
+Utility to run one or more Maven goals against a specific Maven POM file
+ |
+
MavenGoal(String[] goals,
+ MavenInvocationOutputHandler[] outputHandlers)
+Utility to run one or more Maven goals against a specific Maven POM file
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
MavenGoal |
+clone() |
+
protected com.paypal.butterfly.extensions.api.TUExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
String[] |
+getGoals()
+Return the Maven goals to be executed
+ |
+
MavenInvocationOutputHandler[] |
+getOutputHandlers()
+Return the output handlers to be executed against the Maven goals execution result
+ |
+
Properties |
+getProperties()
+Return the Maven properties for the goal
+ |
+
MavenGoal |
+setFailAtEnd()
+Set the maven failure behavior to only fail at the end.
+ |
+
MavenGoal |
+setGoals(String... goals)
+Set the Maven goals to be executed
+ |
+
MavenGoal |
+setOutputHandlers(MavenInvocationOutputHandler... outputHandlers)
+Set the output handlers to be executed against the Maven goals execution result
+ |
+
MavenGoal |
+setProperties(Properties properties)
+Set the Maven properties for the goal
+ |
+
MavenGoal |
+setWarnOnError(boolean warnOnError)
+If this is set to true, then in case the maven goal command
+ does not succeed, then a warn result type will be returned,
+ instead of error.
+ |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic MavenGoal()+
public MavenGoal(String... goals)+
goals - Maven goals to be executedpublic MavenGoal(String[] goals, + MavenInvocationOutputHandler[] outputHandlers)+
goals - Maven goals to be executedoutputHandlers - output handlers to be executed against the Maven goals execution resultpublic MavenGoal setGoals(String... goals)+
goals - Maven goals to be executedpublic MavenGoal setOutputHandlers(MavenInvocationOutputHandler... outputHandlers)+
outputHandlers - output handlers to be executed against the Maven goals execution resultpublic MavenGoal setProperties(Properties properties)+
properties - equivalent to '-D' optionspublic MavenGoal setFailAtEnd()+
public MavenGoal setWarnOnError(boolean warnOnError)+
warnOnError - whether, in case the maven goal command
+ does not succeed, a warn result type should be returned,
+ instead of errorpublic String[] getGoals()+
public Properties getProperties()+
public MavenInvocationOutputHandler[] getOutputHandlers()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<MavenGoal>protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<MavenGoal>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/MavenInvocationOutputHandler.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/MavenInvocationOutputHandler.html new file mode 100644 index 00000000..19514d05 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/MavenInvocationOutputHandler.html @@ -0,0 +1,273 @@ + + + + + + +public interface MavenInvocationOutputHandler<T,R>
+extends org.apache.maven.shared.invoker.InvocationOutputHandler
+| Modifier and Type | +Method and Description | +
|---|---|
T |
+copy()
+Returns a copy of this object, but with its internal state reset,
+ so it can be run in a brand new Maven invocation
+ |
+
R |
+getResult()
+Returns the desired result from parsing the console output
+ |
+
consumeLineR getResult()+
T copy()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/RelatedArtifacts.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/RelatedArtifacts.html new file mode 100644 index 00000000..0602d598 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/RelatedArtifacts.html @@ -0,0 +1,471 @@ + + + + + + +public class RelatedArtifacts +extends com.paypal.butterfly.extensions.api.TransformationUtility<RelatedArtifacts>+
File objects and
+ a parent artifact, this transformation utility results in a sub-list of those pom.xml files containing only the ones
+ that are, directly or indirectly, a child of the specified parent artifact.UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
RelatedArtifacts() |
+
RelatedArtifacts(String parentGroupId,
+ String parentArtifactId,
+ String parentVersion,
+ String pomFilesAttribute)
+This transformation utility, given a list of pom.xml
+File objects and
+ a parent artifact, results in a sub-list of those pom.xml files containing only the ones
+ that are, directly or indirectly, a child of the specified parent artifact. |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TUExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
String |
+getParentArtifactId() |
+
String |
+getParentGroupId() |
+
String |
+getParentVersion() |
+
String |
+getPomFilesAttribute() |
+
RelatedArtifacts |
+setParentArtifactId(String parentArtifactId) |
+
RelatedArtifacts |
+setParentGroupId(String parentGroupId) |
+
RelatedArtifacts |
+setParentVersion(String parentVersion) |
+
RelatedArtifacts |
+setPomFilesAttribute(String pomFilesAttribute) |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic RelatedArtifacts()+
public RelatedArtifacts(String parentGroupId, + String parentArtifactId, + String parentVersion, + String pomFilesAttribute)+
File objects and
+ a parent artifact, results in a sub-list of those pom.xml files containing only the ones
+ that are, directly or indirectly, a child of the specified parent artifact.parentGroupId - parent group idparentArtifactId - parent artifact idparentVersion - parent versionpomFilesAttribute - the name of the transformation context attribute that contains
+ a list of pom.xml files to be analyzedpublic RelatedArtifacts setParentGroupId(String parentGroupId)+
public RelatedArtifacts setParentArtifactId(String parentArtifactId)+
public RelatedArtifacts setParentVersion(String parentVersion)+
public RelatedArtifacts setPomFilesAttribute(String pomFilesAttribute)+
public String getParentGroupId()+
public String getParentArtifactId()+
public String getParentVersion()+
public String getPomFilesAttribute()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<RelatedArtifacts>protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<RelatedArtifacts>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/class-use/EnforcerErrorsOutputHandler.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/class-use/EnforcerErrorsOutputHandler.html new file mode 100644 index 00000000..d910ea89 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/class-use/EnforcerErrorsOutputHandler.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.maven | +
+ Transformation utilities to gather meta-data about Maven POM files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
EnforcerErrorsOutputHandler |
+EnforcerErrorsOutputHandler.copy() |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/class-use/GenericErrorsOutputHandler.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/class-use/GenericErrorsOutputHandler.html new file mode 100644 index 00000000..9ace9c38 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/class-use/GenericErrorsOutputHandler.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.maven | +
+ Transformation utilities to gather meta-data about Maven POM files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
GenericErrorsOutputHandler |
+GenericErrorsOutputHandler.copy() |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/class-use/MavenGoal.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/class-use/MavenGoal.html new file mode 100644 index 00000000..2d8bf87a --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/class-use/MavenGoal.html @@ -0,0 +1,200 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.maven | +
+ Transformation utilities to gather meta-data about Maven POM files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
MavenGoal |
+MavenGoal.clone() |
+
MavenGoal |
+MavenGoal.setFailAtEnd()
+Set the maven failure behavior to only fail at the end.
+ |
+
MavenGoal |
+MavenGoal.setGoals(String... goals)
+Set the Maven goals to be executed
+ |
+
MavenGoal |
+MavenGoal.setOutputHandlers(MavenInvocationOutputHandler... outputHandlers)
+Set the output handlers to be executed against the Maven goals execution result
+ |
+
MavenGoal |
+MavenGoal.setProperties(Properties properties)
+Set the Maven properties for the goal
+ |
+
MavenGoal |
+MavenGoal.setWarnOnError(boolean warnOnError)
+If this is set to true, then in case the maven goal command
+ does not succeed, then a warn result type will be returned,
+ instead of error.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/class-use/MavenInvocationOutputHandler.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/class-use/MavenInvocationOutputHandler.html new file mode 100644 index 00000000..7fb73022 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/class-use/MavenInvocationOutputHandler.html @@ -0,0 +1,220 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.maven | +
+ Transformation utilities to gather meta-data about Maven POM files.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+EnforcerErrorsOutputHandler
+Reads lines from the Maven enforcer plugin output and produces as result a set of Strings stating the validation failures, if any.
+ |
+
class |
+GenericErrorsOutputHandler
+Reads lines from the Maven execution output and produces as result a String stating the errors, if any.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
MavenInvocationOutputHandler[] |
+MavenGoal.getOutputHandlers()
+Return the output handlers to be executed against the Maven goals execution result
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
MavenGoal |
+MavenGoal.setOutputHandlers(MavenInvocationOutputHandler... outputHandlers)
+Set the output handlers to be executed against the Maven goals execution result
+ |
+
| Constructor and Description | +
|---|
MavenGoal(String[] goals,
+ MavenInvocationOutputHandler[] outputHandlers)
+Utility to run one or more Maven goals against a specific Maven POM file
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/class-use/RelatedArtifacts.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/class-use/RelatedArtifacts.html new file mode 100644 index 00000000..1030f946 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/class-use/RelatedArtifacts.html @@ -0,0 +1,180 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.maven | +
+ Transformation utilities to gather meta-data about Maven POM files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
RelatedArtifacts |
+RelatedArtifacts.setParentArtifactId(String parentArtifactId) |
+
RelatedArtifacts |
+RelatedArtifacts.setParentGroupId(String parentGroupId) |
+
RelatedArtifacts |
+RelatedArtifacts.setParentVersion(String parentVersion) |
+
RelatedArtifacts |
+RelatedArtifacts.setPomFilesAttribute(String pomFilesAttribute) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/package-frame.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/package-frame.html new file mode 100644 index 00000000..ae9fbbcf --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/package-frame.html @@ -0,0 +1,28 @@ + + + + + + +See: Description
+| Interface | +Description | +
|---|---|
| MavenInvocationOutputHandler<T,R> | +
+ Reads lines from the Maven execution console output and return data after evaluating it.
+ |
+
| Class | +Description | +
|---|---|
| EnforcerErrorsOutputHandler | +
+ Reads lines from the Maven enforcer plugin output and produces as result a set of Strings stating the validation failures, if any.
+ |
+
| GenericErrorsOutputHandler | +
+ Reads lines from the Maven execution output and produces as result a String stating the errors, if any.
+ |
+
| MavenGoal | +
+ Runs one or more Maven goals against a specific Maven POM file.
+ |
+
| RelatedArtifacts | +
+ Given a list of pom.xml
+File objects and
+ a parent artifact, this transformation utility results in a sub-list of those pom.xml files containing only the ones
+ that are, directly or indirectly, a child of the specified parent artifact. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/package-tree.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/package-tree.html new file mode 100644 index 00000000..face1166 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/package-tree.html @@ -0,0 +1,158 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/package-use.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/package-use.html new file mode 100644 index 00000000..b269bbbb --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/maven/package-use.html @@ -0,0 +1,185 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.maven | +
+ Transformation utilities to gather meta-data about Maven POM files.
+ |
+
| Class and Description | +
|---|
| EnforcerErrorsOutputHandler
+ Reads lines from the Maven enforcer plugin output and produces as result a set of Strings stating the validation failures, if any.
+ |
+
| GenericErrorsOutputHandler
+ Reads lines from the Maven execution output and produces as result a String stating the errors, if any.
+ |
+
| MavenGoal
+ Runs one or more Maven goals against a specific Maven POM file.
+ |
+
| MavenInvocationOutputHandler
+ Reads lines from the Maven execution console output and return data after evaluating it.
+ |
+
| RelatedArtifacts
+ Given a list of pom.xml
+File objects and
+ a parent artifact, this transformation utility results in a sub-list of those pom.xml files containing only the ones
+ that are, directly or indirectly, a child of the specified parent artifact. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/misc/RunScript.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/misc/RunScript.html new file mode 100644 index 00000000..bc00398f --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/misc/RunScript.html @@ -0,0 +1,480 @@ + + + + + + +public class RunScript +extends com.paypal.butterfly.extensions.api.TransformationUtility<RunScript>+
UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
RunScript()
+Executes a script and saves the result after evaluating it.
+ |
+
RunScript(String script)
+Executes a script and saves the result after evaluating it.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
RunScript |
+addAttribute(String key,
+ String attributeName) |
+
RunScript |
+addObject(String key,
+ Object object) |
+
protected com.paypal.butterfly.extensions.api.TUExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
Map<String,String> |
+getAttributes() |
+
String |
+getDescription() |
+
String |
+getLanguage() |
+
Map<String,Object> |
+getObjects() |
+
String |
+getScript() |
+
RunScript |
+setLanguage(String language) |
+
RunScript |
+setScript(String script)
+Sets the script to be executed and evaluated
+ |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic RunScript()+
public RunScript(String script)+
script - the script to be executed and evaluatedpublic RunScript setScript(String script)+
script - the script to be executed and evaluatedpublic String getScript()+
public String getLanguage()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<RunScript>protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<RunScript>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/misc/WebXmlContextParams.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/misc/WebXmlContextParams.html new file mode 100644 index 00000000..5d47e0ed --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/misc/WebXmlContextParams.html @@ -0,0 +1,338 @@ + + + + + + +public class WebXmlContextParams +extends com.paypal.butterfly.extensions.api.TransformationUtility<WebXmlContextParams>+
UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
WebXmlContextParams() |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TUExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<WebXmlContextParams>protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<WebXmlContextParams>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/misc/class-use/RunScript.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/misc/class-use/RunScript.html new file mode 100644 index 00000000..501c7ddf --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/misc/class-use/RunScript.html @@ -0,0 +1,184 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.misc | +
+ Miscellaneous collection of transformation utilities.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
RunScript |
+RunScript.addAttribute(String key,
+ String attributeName) |
+
RunScript |
+RunScript.addObject(String key,
+ Object object) |
+
RunScript |
+RunScript.setLanguage(String language) |
+
RunScript |
+RunScript.setScript(String script)
+Sets the script to be executed and evaluated
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/misc/class-use/WebXmlContextParams.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/misc/class-use/WebXmlContextParams.html new file mode 100644 index 00000000..529bec14 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/misc/class-use/WebXmlContextParams.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/misc/package-frame.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/misc/package-frame.html new file mode 100644 index 00000000..1f71c261 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/misc/package-frame.html @@ -0,0 +1,22 @@ + + + + + + +See: Description
+| Class | +Description | +
|---|---|
| RunScript | +
+ Executes a script and saves the result after evaluating it.
+ |
+
| WebXmlContextParams | +
+ Parses a Java web deployment descriptor file (web.xml),
+ identifies all context parameters, and save them into a map, the key
+ being param-name and the value being param-value.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/misc/package-tree.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/misc/package-tree.html new file mode 100644 index 00000000..261ad594 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/misc/package-tree.html @@ -0,0 +1,144 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/misc/package-use.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/misc/package-use.html new file mode 100644 index 00000000..9551048d --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/misc/package-use.html @@ -0,0 +1,163 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.misc | +
+ Miscellaneous collection of transformation utilities.
+ |
+
| Class and Description | +
|---|
| RunScript
+ Executes a script and saves the result after evaluating it.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/ApplyFile.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/ApplyFile.html new file mode 100644 index 00000000..59e07e5f --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/ApplyFile.html @@ -0,0 +1,413 @@ + + + + + + +UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
ApplyFile() |
+
ApplyFile(String fileUrl)
+Applies a file, whose location is set as a URL,
+ into the transformed application
+ |
+
ApplyFile(URL fileUrl)
+Applies a file, whose location is set as a URL,
+ into the transformed application
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
URL |
+getFileUrl() |
+
ApplyFile |
+setFileUrl(URL fileUrl) |
+
getOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic ApplyFile()+
public ApplyFile(String fileUrl)+
fileUrl - URL string to locate the file to be appliedpublic ApplyFile(URL fileUrl)+
fileUrl - URL to locate the file to be appliedpublic URL getFileUrl()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<ApplyFile>protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<ApplyFile>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/ApplyZip.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/ApplyZip.html new file mode 100644 index 00000000..9548a592 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/ApplyZip.html @@ -0,0 +1,418 @@ + + + + + + +public class ApplyZip +extends com.paypal.butterfly.extensions.api.TransformationOperation<ApplyZip>+
UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
ApplyZip() |
+
ApplyZip(String zipFileUrl)
+Applies the contents of a zip file, whose location is set as a URL,
+ into the transformed application, preserving the relative folders
+ structure inside the zip file.
+ |
+
ApplyZip(URL zipFileUrl)
+Applies the contents of a zip file, whose location is set as a URL,
+ into the transformed application, preserving the relative folders
+ structure inside the zip file.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
URL |
+getZipFileUrl() |
+
ApplyZip |
+setZipFileUrl(URL zipFileUrl) |
+
getOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic ApplyZip()+
public ApplyZip(String zipFileUrl)+
zipFileUrl - URL string to locate the zip file to be appliedpublic ApplyZip(URL zipFileUrl)+
zipFileUrl - URL to locate the zip file to be appliedpublic URL getZipFileUrl()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<ApplyZip>protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<ApplyZip>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/CopyDirectory.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/CopyDirectory.html new file mode 100644 index 00000000..2ce46571 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/CopyDirectory.html @@ -0,0 +1,582 @@ + + + + + + +public class CopyDirectory
+extends com.paypal.butterfly.extensions.api.TransformationOperation<A>
+TransformationTemplate.addMultiple()) with CopyFileCopyFile,
+MoveFile,
+MoveDirectory| Modifier and Type | +Field and Description | +
|---|---|
protected String |
+additionalRelativePath |
+
protected String |
+description |
+
protected String |
+toAbsoluteAttribute |
+
protected String |
+toRelative |
+
UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
CopyDirectory()
+Operation to copy a directory and its content from one location to another.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
protected File |
+getFileTo(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getToAbsoluteAttribute() |
+
String |
+getToRelative() |
+
A |
+setDescription(String description) |
+
A |
+setToAbsolute(String attributeName)
+The name of the transformation context attribute that holds
+ the absolute destination location.
+ |
+
A |
+setToAbsolute(String attributeName,
+ String additionalRelativePath)
+The name of the transformation context attribute that holds
+ the absolute destination location.
+ |
+
A |
+setToRelative(String toRelative)
+Set relative destination location.
+ |
+
getOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetprotected String description+
protected String toRelative+
protected String toAbsoluteAttribute+
protected String additionalRelativePath+
public CopyDirectory()+
protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<CopyDirectory>public A setDescription(String description)+
public A setToRelative(String toRelative)+
null) and use setToAbsolute(String)
+ based on a transformation context attribute set by a
+ LocateFile
+ transformation utility.
+ nulltoRelative - relative destination locationpublic A setToAbsolute(String attributeName)+
setToRelative(String) instead.
+ nullattributeName - name of the transformation context attribute that holds
+ the absolute destination locationpublic A setToAbsolute(String attributeName, + String additionalRelativePath)+
setToRelative(String) instead.
+ nullattributeName - name of the transformation context attribute that holds
+ the absolute destination locationadditionalRelativePath - an additional relative path to be added to the absolute
+ file coming from the transformation context. The path
+ separator will be normalized, similar to what happens
+ in TransformationUtility.relative(String)public String getToRelative()+
public String getToAbsoluteAttribute()+
protected File getFileTo(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<A extends com.paypal.butterfly.utilities.operations.file.AbstractToOperation>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/CopyFile.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/CopyFile.html new file mode 100644 index 00000000..db2079ad --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/CopyFile.html @@ -0,0 +1,578 @@ + + + + + + +public class CopyFile
+extends com.paypal.butterfly.extensions.api.TransformationOperation<A>
+setToRelative(String)
+ or setToAbsolute(String)
+ TransformationTemplate.addMultiple()) with CopyFile. Now, if
+ you want to copy a directory and its content from one location to another, then
+ use CopyDirectory instead.MoveFile,
+CopyDirectory,
+MoveDirectory| Modifier and Type | +Field and Description | +
|---|---|
protected String |
+additionalRelativePath |
+
protected String |
+description |
+
protected String |
+toAbsoluteAttribute |
+
protected String |
+toRelative |
+
UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
CopyFile()
+Copies a file.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
protected File |
+getFileTo(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getToAbsoluteAttribute() |
+
String |
+getToRelative() |
+
A |
+setDescription(String description) |
+
A |
+setToAbsolute(String attributeName)
+The name of the transformation context attribute that holds
+ the absolute destination location.
+ |
+
A |
+setToAbsolute(String attributeName,
+ String additionalRelativePath)
+The name of the transformation context attribute that holds
+ the absolute destination location.
+ |
+
A |
+setToRelative(String toRelative)
+Set relative destination location.
+ |
+
getOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetprotected String description+
protected String toRelative+
protected String toAbsoluteAttribute+
protected String additionalRelativePath+
public CopyFile()+
setToRelative(String)
+ or setToAbsolute(String)protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<CopyFile>public A setDescription(String description)+
public A setToRelative(String toRelative)+
null) and use setToAbsolute(String)
+ based on a transformation context attribute set by a
+ LocateFile
+ transformation utility.
+ nulltoRelative - relative destination locationpublic A setToAbsolute(String attributeName)+
setToRelative(String) instead.
+ nullattributeName - name of the transformation context attribute that holds
+ the absolute destination locationpublic A setToAbsolute(String attributeName, + String additionalRelativePath)+
setToRelative(String) instead.
+ nullattributeName - name of the transformation context attribute that holds
+ the absolute destination locationadditionalRelativePath - an additional relative path to be added to the absolute
+ file coming from the transformation context. The path
+ separator will be normalized, similar to what happens
+ in TransformationUtility.relative(String)public String getToRelative()+
public String getToAbsoluteAttribute()+
protected File getFileTo(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<A extends com.paypal.butterfly.utilities.operations.file.AbstractToOperation>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/DeleteFile.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/DeleteFile.html new file mode 100644 index 00000000..ee3eb371 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/DeleteFile.html @@ -0,0 +1,345 @@ + + + + + + +public class DeleteFile +extends com.paypal.butterfly.extensions.api.TransformationOperation<DeleteFile>+
TOExecutionResult.Type#NO_OP.UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
DeleteFile() |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
getOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<DeleteFile>protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<DeleteFile>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/MoveDirectory.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/MoveDirectory.html new file mode 100644 index 00000000..3a873c3f --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/MoveDirectory.html @@ -0,0 +1,574 @@ + + + + + + +public class MoveDirectory
+extends com.paypal.butterfly.extensions.api.TransformationOperation<A>
+CopyFile,
+CopyDirectory,
+MoveFile| Modifier and Type | +Field and Description | +
|---|---|
protected String |
+additionalRelativePath |
+
protected String |
+description |
+
protected String |
+toAbsoluteAttribute |
+
protected String |
+toRelative |
+
UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
MoveDirectory()
+Moves a directory and its content from one location to another.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
protected File |
+getFileTo(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getToAbsoluteAttribute() |
+
String |
+getToRelative() |
+
A |
+setDescription(String description) |
+
A |
+setToAbsolute(String attributeName)
+The name of the transformation context attribute that holds
+ the absolute destination location.
+ |
+
A |
+setToAbsolute(String attributeName,
+ String additionalRelativePath)
+The name of the transformation context attribute that holds
+ the absolute destination location.
+ |
+
A |
+setToRelative(String toRelative)
+Set relative destination location.
+ |
+
getOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetprotected String description+
protected String toRelative+
protected String toAbsoluteAttribute+
protected String additionalRelativePath+
public MoveDirectory()+
protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<MoveDirectory>public A setDescription(String description)+
public A setToRelative(String toRelative)+
null) and use setToAbsolute(String)
+ based on a transformation context attribute set by a
+ LocateFile
+ transformation utility.
+ nulltoRelative - relative destination locationpublic A setToAbsolute(String attributeName)+
setToRelative(String) instead.
+ nullattributeName - name of the transformation context attribute that holds
+ the absolute destination locationpublic A setToAbsolute(String attributeName, + String additionalRelativePath)+
setToRelative(String) instead.
+ nullattributeName - name of the transformation context attribute that holds
+ the absolute destination locationadditionalRelativePath - an additional relative path to be added to the absolute
+ file coming from the transformation context. The path
+ separator will be normalized, similar to what happens
+ in TransformationUtility.relative(String)public String getToRelative()+
public String getToAbsoluteAttribute()+
protected File getFileTo(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<A extends com.paypal.butterfly.utilities.operations.file.AbstractToOperation>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/MoveFile.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/MoveFile.html new file mode 100644 index 00000000..bf469bea --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/MoveFile.html @@ -0,0 +1,578 @@ + + + + + + +public class MoveFile
+extends com.paypal.butterfly.extensions.api.TransformationOperation<A>
+setToRelative(String)
+ or setToAbsolute(String)
+ TransformationTemplate.addMultiple()) with MoveFile. Now, if
+ you want to move a directory and its content from one location to another, then
+ use MoveDirectory instead.CopyFile,
+CopyDirectory,
+MoveDirectory| Modifier and Type | +Field and Description | +
|---|---|
protected String |
+additionalRelativePath |
+
protected String |
+description |
+
protected String |
+toAbsoluteAttribute |
+
protected String |
+toRelative |
+
UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
MoveFile()
+Moves a file.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
protected File |
+getFileTo(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getToAbsoluteAttribute() |
+
String |
+getToRelative() |
+
A |
+setDescription(String description) |
+
A |
+setToAbsolute(String attributeName)
+The name of the transformation context attribute that holds
+ the absolute destination location.
+ |
+
A |
+setToAbsolute(String attributeName,
+ String additionalRelativePath)
+The name of the transformation context attribute that holds
+ the absolute destination location.
+ |
+
A |
+setToRelative(String toRelative)
+Set relative destination location.
+ |
+
getOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetprotected String description+
protected String toRelative+
protected String toAbsoluteAttribute+
protected String additionalRelativePath+
public MoveFile()+
setToRelative(String)
+ or setToAbsolute(String)protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<MoveFile>public A setDescription(String description)+
public A setToRelative(String toRelative)+
null) and use setToAbsolute(String)
+ based on a transformation context attribute set by a
+ LocateFile
+ transformation utility.
+ nulltoRelative - relative destination locationpublic A setToAbsolute(String attributeName)+
setToRelative(String) instead.
+ nullattributeName - name of the transformation context attribute that holds
+ the absolute destination locationpublic A setToAbsolute(String attributeName, + String additionalRelativePath)+
setToRelative(String) instead.
+ nullattributeName - name of the transformation context attribute that holds
+ the absolute destination locationadditionalRelativePath - an additional relative path to be added to the absolute
+ file coming from the transformation context. The path
+ separator will be normalized, similar to what happens
+ in TransformationUtility.relative(String)public String getToRelative()+
public String getToAbsoluteAttribute()+
protected File getFileTo(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<A extends com.paypal.butterfly.utilities.operations.file.AbstractToOperation>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/RenameFile.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/RenameFile.html new file mode 100644 index 00000000..bed33ef4 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/RenameFile.html @@ -0,0 +1,389 @@ + + + + + + +public class RenameFile +extends com.paypal.butterfly.extensions.api.TransformationOperation<RenameFile>+
UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
RenameFile() |
+
RenameFile(String newName)
+Renames a single file.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
String |
+getNewName() |
+
RenameFile |
+setNewName(String newName) |
+
getOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic RenameFile()+
public RenameFile(String newName)+
newName - new name for the filepublic RenameFile setNewName(String newName)+
public String getNewName()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<RenameFile>protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<RenameFile>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/ApplyFile.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/ApplyFile.html new file mode 100644 index 00000000..65cfe09e --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/ApplyFile.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.file | +
+ Transformation operations to manipulate files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ApplyFile |
+ApplyFile.setFileUrl(URL fileUrl) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/ApplyZip.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/ApplyZip.html new file mode 100644 index 00000000..e568a59c --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/ApplyZip.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.file | +
+ Transformation operations to manipulate files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ApplyZip |
+ApplyZip.setZipFileUrl(URL zipFileUrl) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/CopyDirectory.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/CopyDirectory.html new file mode 100644 index 00000000..50e16d00 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/CopyDirectory.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/CopyFile.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/CopyFile.html new file mode 100644 index 00000000..7d960ad7 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/CopyFile.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/DeleteFile.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/DeleteFile.html new file mode 100644 index 00000000..3d94a895 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/DeleteFile.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/MoveDirectory.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/MoveDirectory.html new file mode 100644 index 00000000..a9e93d2f --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/MoveDirectory.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/MoveFile.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/MoveFile.html new file mode 100644 index 00000000..45513b78 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/MoveFile.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/RenameFile.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/RenameFile.html new file mode 100644 index 00000000..4f6bc3e2 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/class-use/RenameFile.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.file | +
+ Transformation operations to manipulate files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
RenameFile |
+RenameFile.setNewName(String newName) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/package-frame.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/package-frame.html new file mode 100644 index 00000000..877d6ab9 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/package-frame.html @@ -0,0 +1,28 @@ + + + + + + +See: Description
+| Class | +Description | +
|---|---|
| ApplyFile | +
+ Applies a file, whose location is set as a URL,
+ into the transformed application
+ |
+
| ApplyZip | +
+ Applies the contents of a zip file, whose location is set as a URL,
+ into the transformed application, preserving the relative folders
+ structure inside the zip file.
+ |
+
| CopyDirectory | +
+ Copies a directory and its content from one location to another.
+ |
+
| CopyFile | +
+ Copies a file.
+ |
+
| DeleteFile | +
+ Deletes a single file or folder (empty or not).
+ |
+
| MoveDirectory | +
+ Moves a directory and its content from one location to another.
+ |
+
| MoveFile | +
+ Moves a file.
+ |
+
| RenameFile | +
+ Renames a single file.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/package-tree.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/package-tree.html new file mode 100644 index 00000000..cd089584 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/package-tree.html @@ -0,0 +1,154 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/package-use.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/package-use.html new file mode 100644 index 00000000..d113f221 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/package-use.html @@ -0,0 +1,176 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.file | +
+ Transformation operations to manipulate files.
+ |
+
| Class and Description | +
|---|
| ApplyFile
+ Applies a file, whose location is set as a URL,
+ into the transformed application
+ |
+
| ApplyZip
+ Applies the contents of a zip file, whose location is set as a URL,
+ into the transformed application, preserving the relative folders
+ structure inside the zip file.
+ |
+
| RenameFile
+ Renames a single file.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/AbstractStaxArtifactPomOperation.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/AbstractStaxArtifactPomOperation.html new file mode 100644 index 00000000..cbe86ffb --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/AbstractStaxArtifactPomOperation.html @@ -0,0 +1,573 @@ + + + + + + +public abstract class AbstractStaxArtifactPomOperation<T extends AbstractStaxArtifactPomOperation> +extends AbstractStaxOperation<T>+
| Modifier and Type | +Field and Description | +
|---|---|
protected String |
+artifactId |
+
protected String |
+groupId |
+
eventFactory, LINE_FEEDUTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
AbstractStaxArtifactPomOperation() |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(Object obj) |
+
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getArtifactId() |
+
String |
+getGroupId() |
+
protected org.apache.maven.model.Model |
+getModel(File pomFile) |
+
int |
+hashCode() |
+
protected abstract com.paypal.butterfly.extensions.api.TOExecutionResult |
+pomExecution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
T |
+setArtifact(String artifact)
+Set dependency group id and artifact id based on a String
+ whose format is "groupId:artifactId".
+ |
+
T |
+setArtifactId(String artifactId) |
+
T |
+setGroupId(String groupId) |
+
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+xmlExecution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
clone, copyUntil, getIndentation, getReader, getWriter, skipUntil, writeMultiplegetOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, copy, dependsOn, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getDescription, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetprotected String groupId+
protected String artifactId+
public AbstractStaxArtifactPomOperation()+
public T setArtifact(String artifact)+
TransformationDefinitionException if the specified
+ artifact String is invalidartifact - the artifact formatted Stringpublic String getGroupId()+
public String getArtifactId()+
public boolean equals(Object obj)+
equals in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends AbstractStaxArtifactPomOperation>public int hashCode()+
hashCode in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends AbstractStaxArtifactPomOperation>protected org.apache.maven.model.Model getModel(File pomFile) + throws IOException, + org.codehaus.plexus.util.xml.pull.XmlPullParserException+
IOExceptionorg.codehaus.plexus.util.xml.pull.XmlPullParserExceptionprotected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class AbstractStaxOperation<T extends com.paypal.butterfly.utilities.operations.pom.AbstractStaxPomOperation>protected com.paypal.butterfly.extensions.api.TOExecutionResult xmlExecution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) + throws org.codehaus.plexus.util.xml.pull.XmlPullParserException, + XMLStreamException, + IOException+
xmlExecution in class AbstractStaxOperation<T extends com.paypal.butterfly.utilities.operations.pom.AbstractStaxPomOperation>org.codehaus.plexus.util.xml.pull.XmlPullParserExceptionXMLStreamExceptionIOExceptionprotected abstract com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) + throws org.codehaus.plexus.util.xml.pull.XmlPullParserException, + XMLStreamException, + IOException+
org.codehaus.plexus.util.xml.pull.XmlPullParserExceptionXMLStreamExceptionIOExceptionCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddDependency.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddDependency.html new file mode 100644 index 00000000..9e8924d2 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddDependency.html @@ -0,0 +1,609 @@ + + + + + + +public class PomAddDependency +extends com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomAddDependency> +implements com.paypal.butterfly.extensions.api.operations.AddElement<PomAddDependency>+
com.paypal.butterfly.extensions.api.operations.AddElement.IfPresentartifactId, groupIdUTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
PomAddDependency() |
+
PomAddDependency(String groupId,
+ String artifactId)
+Operation to add a new dependency to a POM file.
+ |
+
PomAddDependency(String groupId,
+ String artifactId,
+ String version)
+Operation to add a new dependency to a POM file.
+ |
+
PomAddDependency(String groupId,
+ String artifactId,
+ String version,
+ String scope)
+Operation to add a new dependency to a POM file.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
PomAddDependency |
+failIfPresent() |
+
String |
+getDescription() |
+
String |
+getScope() |
+
String |
+getVersion() |
+
PomAddDependency |
+noOpIfPresent() |
+
PomAddDependency |
+overwriteIfPresent() |
+
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+pomExecution(String relativePomFile,
+ org.apache.maven.model.Model model) |
+
PomAddDependency |
+setScope(String scope) |
+
PomAddDependency |
+setVersion(String version) |
+
PomAddDependency |
+warnButAddIfPresent() |
+
PomAddDependency |
+warnNotAddIfPresent() |
+
equals, getArtifactId, getDependency, getDependency, getGroupId, getManagedDependency, getManagedDependency, getManagedPlugin, getManagedPlugin, getPlugin, getPlugin, hashCode, setArtifact, setArtifactId, setGroupIdgetOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic PomAddDependency()+
public PomAddDependency(String groupId, + String artifactId)+
groupId - new dependency group idartifactId - new dependency artifact idpublic PomAddDependency(String groupId, + String artifactId, + String version)+
groupId - new dependency group idartifactId - new dependency artifact idversion - new dependency artifact versionpublic PomAddDependency(String groupId, + String artifactId, + String version, + String scope)+
groupId - new dependency group idartifactId - new dependency artifact idversion - new dependency artifact versionscope - new dependency artifact scopepublic PomAddDependency setVersion(String version)+
public PomAddDependency setScope(String scope)+
public PomAddDependency failIfPresent()+
failIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddDependency>public PomAddDependency warnNotAddIfPresent()+
warnNotAddIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddDependency>public PomAddDependency warnButAddIfPresent()+
warnButAddIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddDependency>public PomAddDependency noOpIfPresent()+
noOpIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddDependency>public PomAddDependency overwriteIfPresent()+
overwriteIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddDependency>public String getVersion()+
public String getScope()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomAddDependency>protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(String relativePomFile, + org.apache.maven.model.Model model)+
protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddParent.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddParent.html new file mode 100644 index 00000000..f9d3dd77 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddParent.html @@ -0,0 +1,611 @@ + + + + + + +public class PomAddParent +extends AbstractStaxArtifactPomOperation<PomAddParent> +implements com.paypal.butterfly.extensions.api.operations.AddElement<PomAddParent>+
com.paypal.butterfly.extensions.api.operations.AddElement.IfPresentartifactId, groupIdeventFactory, LINE_FEEDUTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
PomAddParent()
+Add a parent artifact in a Maven POM file.
+ |
+
PomAddParent(String groupId,
+ String artifactId,
+ String version)
+Operation to add a parent artifact in a Maven POM file
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
PomAddParent |
+failIfPresent() |
+
String |
+getDescription() |
+
protected org.apache.maven.model.Model |
+getModel(File pomFile) |
+
String |
+getVersion() |
+
PomAddParent |
+noOpIfPresent() |
+
PomAddParent |
+overwriteIfPresent() |
+
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+pomExecution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
PomAddParent |
+setVersion(String version) |
+
PomAddParent |
+warnButAddIfPresent() |
+
PomAddParent |
+warnNotAddIfPresent() |
+
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+xmlExecution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
equals, getArtifactId, getGroupId, hashCode, setArtifact, setArtifactId, setGroupIdclone, copyUntil, getIndentation, getReader, getWriter, skipUntil, writeMultiplegetOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, copy, dependsOn, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic PomAddParent()+
public PomAddParent(String groupId, + String artifactId, + String version)+
groupId - parent artifact group id to be setartifactId - parent artifact id to be setversion - parent artifact version to be setpublic PomAddParent setVersion(String version)+
public PomAddParent failIfPresent()+
failIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddParent>public PomAddParent warnNotAddIfPresent()+
warnNotAddIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddParent>public PomAddParent warnButAddIfPresent()+
warnButAddIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddParent>public PomAddParent noOpIfPresent()+
noOpIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddParent>public PomAddParent overwriteIfPresent()+
overwriteIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddParent>public String getVersion()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomAddParent>protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) + throws org.codehaus.plexus.util.xml.pull.XmlPullParserException, + XMLStreamException, + IOException+
org.codehaus.plexus.util.xml.pull.XmlPullParserExceptionXMLStreamExceptionIOExceptionprotected org.apache.maven.model.Model getModel(File pomFile) + throws IOException, + org.codehaus.plexus.util.xml.pull.XmlPullParserException+
IOExceptionorg.codehaus.plexus.util.xml.pull.XmlPullParserExceptionprotected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class AbstractStaxOperation<T extends com.paypal.butterfly.utilities.operations.pom.AbstractStaxPomOperation>protected com.paypal.butterfly.extensions.api.TOExecutionResult xmlExecution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) + throws org.codehaus.plexus.util.xml.pull.XmlPullParserException, + XMLStreamException, + IOException+
xmlExecution in class AbstractStaxOperation<T extends com.paypal.butterfly.utilities.operations.pom.AbstractStaxPomOperation>org.codehaus.plexus.util.xml.pull.XmlPullParserExceptionXMLStreamExceptionIOExceptionCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddPlugin.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddPlugin.html new file mode 100644 index 00000000..3a6140ac --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddPlugin.html @@ -0,0 +1,589 @@ + + + + + + +public class PomAddPlugin +extends com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomAddPlugin> +implements com.paypal.butterfly.extensions.api.operations.AddElement<PomAddPlugin>+
com.paypal.butterfly.extensions.api.operations.AddElement.IfPresentartifactId, groupIdUTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
PomAddPlugin() |
+
PomAddPlugin(String groupId,
+ String artifactId)
+Operation to add a new plugin to a POM file.
+ |
+
PomAddPlugin(String groupId,
+ String artifactId,
+ String version)
+Operation to add a new plugin to a POM file.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(Object obj) |
+
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
PomAddPlugin |
+failIfPresent() |
+
String |
+getDescription() |
+
String |
+getVersion() |
+
int |
+hashCode() |
+
PomAddPlugin |
+noOpIfPresent() |
+
PomAddPlugin |
+overwriteIfPresent() |
+
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+pomExecution(String relativePomFile,
+ org.apache.maven.model.Model model) |
+
PomAddPlugin |
+setVersion(String version) |
+
PomAddPlugin |
+warnButAddIfPresent() |
+
PomAddPlugin |
+warnNotAddIfPresent() |
+
getArtifactId, getDependency, getDependency, getGroupId, getManagedDependency, getManagedDependency, getManagedPlugin, getManagedPlugin, getPlugin, getPlugin, setArtifact, setArtifactId, setGroupIdgetOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic PomAddPlugin()+
public PomAddPlugin(String groupId, + String artifactId)+
groupId - new plugin group idartifactId - new plugin artifact idpublic PomAddPlugin setVersion(String version)+
public PomAddPlugin failIfPresent()+
failIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddPlugin>public PomAddPlugin warnNotAddIfPresent()+
warnNotAddIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddPlugin>public PomAddPlugin warnButAddIfPresent()+
warnButAddIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddPlugin>public PomAddPlugin noOpIfPresent()+
noOpIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddPlugin>public PomAddPlugin overwriteIfPresent()+
overwriteIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddPlugin>public String getVersion()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomAddPlugin>protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(String relativePomFile, + org.apache.maven.model.Model model)+
public boolean equals(Object obj)+
equals in class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomAddPlugin>public int hashCode()+
hashCode in class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomAddPlugin>protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangeDependency.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangeDependency.html new file mode 100644 index 00000000..4f53cbce --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangeDependency.html @@ -0,0 +1,693 @@ + + + + + + +public class PomChangeDependency +extends com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomChangeDependency> +implements com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeDependency>+
com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresentartifactId, groupIdUTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
PomChangeDependency() |
+
PomChangeDependency(String groupId,
+ String artifactId)
+Operation to change a dependency in a Maven POM file.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
PomChangeDependency |
+failIfNotPresent() |
+
String |
+getDescription() |
+
String |
+getScope() |
+
String |
+getType() |
+
String |
+getVersion() |
+
boolean |
+isOptional() |
+
boolean |
+isRemoveOptional() |
+
boolean |
+isRemoveScope() |
+
boolean |
+isRemoveType() |
+
boolean |
+isRemoveVersion() |
+
PomChangeDependency |
+noOpIfNotPresent() |
+
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+pomExecution(String relativePomFile,
+ org.apache.maven.model.Model model) |
+
PomChangeDependency |
+removeOptional() |
+
PomChangeDependency |
+removeScope() |
+
PomChangeDependency |
+removeType() |
+
PomChangeDependency |
+removeVersion() |
+
PomChangeDependency |
+setOptional() |
+
PomChangeDependency |
+setScope(String scope) |
+
PomChangeDependency |
+setType(String type) |
+
PomChangeDependency |
+setVersion(String version) |
+
PomChangeDependency |
+warnIfNotPresent() |
+
equals, getArtifactId, getDependency, getDependency, getGroupId, getManagedDependency, getManagedDependency, getManagedPlugin, getManagedPlugin, getPlugin, getPlugin, hashCode, setArtifact, setArtifactId, setGroupIdgetOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic PomChangeDependency()+
public PomChangeDependency(String groupId, + String artifactId)+
groupId - dependency group idartifactId - dependency artifact idpublic PomChangeDependency setVersion(String version)+
public PomChangeDependency setScope(String scope)+
public PomChangeDependency setType(String type)+
public PomChangeDependency setOptional()+
public PomChangeDependency removeVersion()+
public PomChangeDependency removeScope()+
public PomChangeDependency removeType()+
public PomChangeDependency removeOptional()+
public PomChangeDependency failIfNotPresent()+
failIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeDependency>public PomChangeDependency warnIfNotPresent()+
warnIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeDependency>public PomChangeDependency noOpIfNotPresent()+
noOpIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeDependency>public String getVersion()+
public String getScope()+
public String getType()+
public boolean isOptional()+
public boolean isRemoveVersion()+
public boolean isRemoveScope()+
public boolean isRemoveType()+
public boolean isRemoveOptional()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomChangeDependency>protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(String relativePomFile, + org.apache.maven.model.Model model)+
protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangePackaging.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangePackaging.html new file mode 100644 index 00000000..a2b89470 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangePackaging.html @@ -0,0 +1,438 @@ + + + + + + +public class PomChangePackaging
+extends com.paypal.butterfly.extensions.api.TransformationOperation<T>
+UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
PomChangePackaging() |
+
PomChangePackaging(String packagingType)
+Operation to change the packaging of a Maven artifact, by changing its POM file
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(Object obj) |
+
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
String |
+getPackagingType() |
+
int |
+hashCode() |
+
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+pomExecution(String relativePomFile,
+ org.apache.maven.model.Model model) |
+
PomChangePackaging |
+setPackagingType(String packagingType) |
+
getOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic PomChangePackaging()+
public PomChangePackaging(String packagingType)+
packagingType - packaging typepublic PomChangePackaging setPackagingType(String packagingType)+
public String getPackagingType()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomChangePackaging>protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(String relativePomFile, + org.apache.maven.model.Model model)+
public boolean equals(Object obj)+
equals in class com.paypal.butterfly.extensions.api.TransformationUtility<PomChangePackaging>public int hashCode()+
hashCode in class com.paypal.butterfly.extensions.api.TransformationUtility<PomChangePackaging>protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangeParent.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangeParent.html new file mode 100644 index 00000000..17aa8a78 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangeParent.html @@ -0,0 +1,586 @@ + + + + + + +@Deprecated +public class PomChangeParent +extends com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomChangeParent> +implements com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeParent>+
PomAddParent or PomChangeParentVersion instead.com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresentartifactId, groupIdUTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
PomChangeParent()
+Deprecated.
+ |
+
PomChangeParent(String version)
+Deprecated.
+Operation to change the parent, or its version, in a Maven POM file
+ |
+
PomChangeParent(String groupId,
+ String artifactId,
+ String version)
+Deprecated.
+Operation to change the parent, or its version, in a Maven POM file
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
PomChangeParent |
+failIfNotPresent()
+Deprecated.
+ |
+
String |
+getDescription()
+Deprecated.
+ |
+
String |
+getVersion()
+Deprecated.
+ |
+
PomChangeParent |
+noOpIfNotPresent()
+Deprecated.
+ |
+
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+pomExecution(String relativePomFile,
+ org.apache.maven.model.Model model)
+Deprecated.
+ |
+
PomChangeParent |
+setArtifactId(String artifactId)
+Deprecated.
+ |
+
PomChangeParent |
+setGroupId(String groupId)
+Deprecated.
+ |
+
PomChangeParent |
+setVersion(String version)
+Deprecated.
+ |
+
PomChangeParent |
+warnIfNotPresent()
+Deprecated.
+ |
+
equals, getArtifactId, getDependency, getDependency, getGroupId, getManagedDependency, getManagedDependency, getManagedPlugin, getManagedPlugin, getPlugin, getPlugin, hashCode, setArtifactgetOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic PomChangeParent()+
public PomChangeParent(String version)+
version - parent artifact version to be setpublic PomChangeParent(String groupId, + String artifactId, + String version)+
groupId - parent artifact group id to be setartifactId - parent artifact id to be setversion - parent artifact version to be setpublic PomChangeParent setGroupId(String groupId)+
setGroupId in class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomChangeParent>public PomChangeParent setArtifactId(String artifactId)+
setArtifactId in class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomChangeParent>public PomChangeParent setVersion(String version)+
public PomChangeParent failIfNotPresent()+
failIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeParent>public PomChangeParent warnIfNotPresent()+
warnIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeParent>public PomChangeParent noOpIfNotPresent()+
noOpIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeParent>public String getVersion()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomChangeParent>protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(String relativePomFile, + org.apache.maven.model.Model model)+
protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangeParentVersion.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangeParentVersion.html new file mode 100644 index 00000000..c54f8395 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangeParentVersion.html @@ -0,0 +1,546 @@ + + + + + + +public class PomChangeParentVersion +extends AbstractStaxOperation<T> +implements com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeParentVersion>+
com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresenteventFactory, LINE_FEEDUTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
PomChangeParentVersion() |
+
PomChangeParentVersion(String version)
+Operation to change the parent, or its version, in a Maven POM file
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
PomChangeParentVersion |
+failIfNotPresent() |
+
String |
+getDescription() |
+
protected org.apache.maven.model.Model |
+getModel(File pomFile) |
+
String |
+getVersion() |
+
PomChangeParentVersion |
+noOpIfNotPresent() |
+
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+pomExecution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
PomChangeParentVersion |
+setVersion(String version) |
+
PomChangeParentVersion |
+warnIfNotPresent() |
+
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+xmlExecution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
clone, copyUntil, getIndentation, getReader, getWriter, skipUntil, writeMultiplegetOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic PomChangeParentVersion()+
public PomChangeParentVersion(String version)+
version - parent artifact version to be setpublic PomChangeParentVersion setVersion(String version)+
public PomChangeParentVersion failIfNotPresent()+
failIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeParentVersion>public PomChangeParentVersion warnIfNotPresent()+
warnIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeParentVersion>public PomChangeParentVersion noOpIfNotPresent()+
noOpIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeParentVersion>public String getVersion()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomChangeParentVersion>protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) + throws org.codehaus.plexus.util.xml.pull.XmlPullParserException, + XMLStreamException, + IOException+
org.codehaus.plexus.util.xml.pull.XmlPullParserExceptionXMLStreamExceptionIOExceptionprotected org.apache.maven.model.Model getModel(File pomFile) + throws IOException, + org.codehaus.plexus.util.xml.pull.XmlPullParserException+
IOExceptionorg.codehaus.plexus.util.xml.pull.XmlPullParserExceptionprotected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class AbstractStaxOperation<T extends com.paypal.butterfly.utilities.operations.pom.AbstractStaxPomOperation>protected com.paypal.butterfly.extensions.api.TOExecutionResult xmlExecution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) + throws org.codehaus.plexus.util.xml.pull.XmlPullParserException, + XMLStreamException, + IOException+
xmlExecution in class AbstractStaxOperation<T extends com.paypal.butterfly.utilities.operations.pom.AbstractStaxPomOperation>org.codehaus.plexus.util.xml.pull.XmlPullParserExceptionXMLStreamExceptionIOExceptionCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveDependency.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveDependency.html new file mode 100644 index 00000000..8d040ef4 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveDependency.html @@ -0,0 +1,501 @@ + + + + + + +public class PomRemoveDependency +extends com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomRemoveDependency> +implements com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveDependency>+
com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresentartifactId, groupIdUTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
PomRemoveDependency() |
+
PomRemoveDependency(String groupId,
+ String artifactId)
+Operation to remove a dependency entry from a POM file
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(Object obj) |
+
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
PomRemoveDependency |
+failIfNotPresent() |
+
String |
+getDescription() |
+
int |
+hashCode() |
+
PomRemoveDependency |
+noOpIfNotPresent() |
+
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+pomExecution(String relativePomFile,
+ org.apache.maven.model.Model model) |
+
PomRemoveDependency |
+warnIfNotPresent() |
+
getArtifactId, getDependency, getDependency, getGroupId, getManagedDependency, getManagedDependency, getManagedPlugin, getManagedPlugin, getPlugin, getPlugin, setArtifact, setArtifactId, setGroupIdgetOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic PomRemoveDependency()+
public PomRemoveDependency failIfNotPresent()+
failIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveDependency>public PomRemoveDependency warnIfNotPresent()+
warnIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveDependency>public PomRemoveDependency noOpIfNotPresent()+
noOpIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveDependency>public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomRemoveDependency>protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(String relativePomFile, + org.apache.maven.model.Model model)+
public boolean equals(Object obj)+
equals in class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomRemoveDependency>public int hashCode()+
hashCode in class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomRemoveDependency>protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveManagedDependency.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveManagedDependency.html new file mode 100644 index 00000000..9fbd754b --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveManagedDependency.html @@ -0,0 +1,467 @@ + + + + + + +public class PomRemoveManagedDependency +extends com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomRemoveManagedDependency> +implements com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveManagedDependency>+
com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresentartifactId, groupIdUTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
PomRemoveManagedDependency() |
+
PomRemoveManagedDependency(String groupId,
+ String artifactId)
+Operation to remove a managed dependency entry from a POM file
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
PomRemoveManagedDependency |
+failIfNotPresent() |
+
String |
+getDescription() |
+
PomRemoveManagedDependency |
+noOpIfNotPresent() |
+
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+pomExecution(String relativePomFile,
+ org.apache.maven.model.Model model) |
+
PomRemoveManagedDependency |
+warnIfNotPresent() |
+
equals, getArtifactId, getDependency, getDependency, getGroupId, getManagedDependency, getManagedDependency, getManagedPlugin, getManagedPlugin, getPlugin, getPlugin, hashCode, setArtifact, setArtifactId, setGroupIdgetOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic PomRemoveManagedDependency()+
public PomRemoveManagedDependency failIfNotPresent()+
failIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveManagedDependency>public PomRemoveManagedDependency warnIfNotPresent()+
warnIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveManagedDependency>public PomRemoveManagedDependency noOpIfNotPresent()+
noOpIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveManagedDependency>public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomRemoveManagedDependency>protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(String relativePomFile, + org.apache.maven.model.Model model)+
protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemovePlugin.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemovePlugin.html new file mode 100644 index 00000000..1ba3655a --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemovePlugin.html @@ -0,0 +1,501 @@ + + + + + + +public class PomRemovePlugin +extends com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomRemovePlugin> +implements com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemovePlugin>+
com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresentartifactId, groupIdUTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
PomRemovePlugin() |
+
PomRemovePlugin(String groupId,
+ String artifactId)
+Operation to remove a plugin entry from a POM file
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(Object obj) |
+
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
PomRemovePlugin |
+failIfNotPresent() |
+
String |
+getDescription() |
+
int |
+hashCode() |
+
PomRemovePlugin |
+noOpIfNotPresent() |
+
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+pomExecution(String relativePomFile,
+ org.apache.maven.model.Model model) |
+
PomRemovePlugin |
+warnIfNotPresent() |
+
getArtifactId, getDependency, getDependency, getGroupId, getManagedDependency, getManagedDependency, getManagedPlugin, getManagedPlugin, getPlugin, getPlugin, setArtifact, setArtifactId, setGroupIdgetOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic PomRemovePlugin failIfNotPresent()+
failIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemovePlugin>public PomRemovePlugin warnIfNotPresent()+
warnIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemovePlugin>public PomRemovePlugin noOpIfNotPresent()+
noOpIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemovePlugin>public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomRemovePlugin>protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(String relativePomFile, + org.apache.maven.model.Model model)+
public boolean equals(Object obj)+
equals in class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomRemovePlugin>public int hashCode()+
hashCode in class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomRemovePlugin>protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveProperty.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveProperty.html new file mode 100644 index 00000000..15fd8e59 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveProperty.html @@ -0,0 +1,471 @@ + + + + + + +public class PomRemoveProperty +extends com.paypal.butterfly.extensions.api.TransformationOperation<T> +implements com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveProperty>+
com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresentUTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
PomRemoveProperty() |
+
PomRemoveProperty(String propertyName)
+Operation to remove a property entry from a properties file
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
PomRemoveProperty |
+failIfNotPresent() |
+
String |
+getDescription() |
+
String |
+getPropertyName() |
+
PomRemoveProperty |
+noOpIfNotPresent() |
+
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+pomExecution(String relativePomFile,
+ org.apache.maven.model.Model model) |
+
PomRemoveProperty |
+setPropertyName(String propertyName) |
+
PomRemoveProperty |
+warnIfNotPresent() |
+
getOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic PomRemoveProperty()+
public PomRemoveProperty(String propertyName)+
propertyName - property to be removedpublic PomRemoveProperty setPropertyName(String propertyName)+
public PomRemoveProperty failIfNotPresent()+
failIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveProperty>public PomRemoveProperty warnIfNotPresent()+
warnIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveProperty>public PomRemoveProperty noOpIfNotPresent()+
noOpIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveProperty>public String getPropertyName()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomRemoveProperty>protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(String relativePomFile, + org.apache.maven.model.Model model)+
protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomReplaceDependency.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomReplaceDependency.html new file mode 100644 index 00000000..eef3dd15 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomReplaceDependency.html @@ -0,0 +1,642 @@ + + + + + + +public class PomReplaceDependency +extends com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomReplaceDependency> +implements com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomReplaceDependency>+
com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresentartifactId, groupIdUTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
PomReplaceDependency() |
+
PomReplaceDependency(String groupId,
+ String artifactId,
+ String newGroupId,
+ String newArtifactId)
+Operation to replace a dependency by another one in a POM file
+ |
+
PomReplaceDependency(String groupId,
+ String artifactId,
+ String newGroupId,
+ String newArtifactId,
+ String newVersion)
+Operation to replace a dependency by another one in a POM file
+ |
+
PomReplaceDependency(String groupId,
+ String artifactId,
+ String newGroupId,
+ String newArtifactId,
+ String newVersion,
+ String newScope)
+Operation to replace a dependency by another one in a POM file
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
PomReplaceDependency |
+failIfNotPresent() |
+
String |
+getDescription() |
+
String |
+getNewArtifactId() |
+
String |
+getNewGroupId() |
+
String |
+getNewScope() |
+
String |
+getNewVersion() |
+
PomReplaceDependency |
+noOpIfNotPresent() |
+
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+pomExecution(String relativePomFile,
+ org.apache.maven.model.Model model) |
+
PomReplaceDependency |
+setNewArtifactId(String newArtifactId) |
+
PomReplaceDependency |
+setNewGroupId(String newGroupId) |
+
PomReplaceDependency |
+setNewScope(String newScope) |
+
PomReplaceDependency |
+setNewVersion(String newVersion) |
+
PomReplaceDependency |
+warnIfNotPresent() |
+
equals, getArtifactId, getDependency, getDependency, getGroupId, getManagedDependency, getManagedDependency, getManagedPlugin, getManagedPlugin, getPlugin, getPlugin, hashCode, setArtifact, setArtifactId, setGroupIdgetOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic PomReplaceDependency()+
public PomReplaceDependency(String groupId, + String artifactId, + String newGroupId, + String newArtifactId)+
groupId - group id of the dependency to be replacedartifactId - artifact id of the dependency to be replacednewGroupId - group id of the new dependencynewArtifactId - artifact id of the new dependencypublic PomReplaceDependency(String groupId, + String artifactId, + String newGroupId, + String newArtifactId, + String newVersion)+
groupId - group id of the dependency to be replacedartifactId - artifact id of the dependency to be replacednewGroupId - group id of the new dependencynewArtifactId - artifact id of the new dependencynewVersion - version of the new dependencypublic PomReplaceDependency(String groupId, + String artifactId, + String newGroupId, + String newArtifactId, + String newVersion, + String newScope)+
groupId - group id of the dependency to be replacedartifactId - artifact id of the dependency to be replacednewGroupId - group id of the new dependencynewArtifactId - artifact id of the new dependencynewVersion - version of the new dependencynewScope - version of the new dependencypublic PomReplaceDependency setNewGroupId(String newGroupId)+
public PomReplaceDependency setNewArtifactId(String newArtifactId)+
public PomReplaceDependency setNewVersion(String newVersion)+
public PomReplaceDependency setNewScope(String newScope)+
public PomReplaceDependency failIfNotPresent()+
failIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomReplaceDependency>public PomReplaceDependency warnIfNotPresent()+
warnIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomReplaceDependency>public PomReplaceDependency noOpIfNotPresent()+
noOpIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomReplaceDependency>public String getNewGroupId()+
public String getNewArtifactId()+
public String getNewVersion()+
public String getNewScope()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomReplaceDependency>protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(String relativePomFile, + org.apache.maven.model.Model model)+
protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/AbstractStaxArtifactPomOperation.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/AbstractStaxArtifactPomOperation.html new file mode 100644 index 00000000..8982a99c --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/AbstractStaxArtifactPomOperation.html @@ -0,0 +1,185 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.pom | +
+ Transformation operations to manipulate Maven POM files.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AbstractStaxArtifactPomOperation<T extends AbstractStaxArtifactPomOperation>
+Abstract Artifact POM operation.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+PomAddParent
+Add a parent artifact in a Maven POM file.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomAddDependency.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomAddDependency.html new file mode 100644 index 00000000..d113a803 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomAddDependency.html @@ -0,0 +1,192 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.pom | +
+ Transformation operations to manipulate Maven POM files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
PomAddDependency |
+PomAddDependency.failIfPresent() |
+
PomAddDependency |
+PomAddDependency.noOpIfPresent() |
+
PomAddDependency |
+PomAddDependency.overwriteIfPresent() |
+
PomAddDependency |
+PomAddDependency.setScope(String scope) |
+
PomAddDependency |
+PomAddDependency.setVersion(String version) |
+
PomAddDependency |
+PomAddDependency.warnButAddIfPresent() |
+
PomAddDependency |
+PomAddDependency.warnNotAddIfPresent() |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomAddParent.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomAddParent.html new file mode 100644 index 00000000..28d7b68a --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomAddParent.html @@ -0,0 +1,188 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.pom | +
+ Transformation operations to manipulate Maven POM files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
PomAddParent |
+PomAddParent.failIfPresent() |
+
PomAddParent |
+PomAddParent.noOpIfPresent() |
+
PomAddParent |
+PomAddParent.overwriteIfPresent() |
+
PomAddParent |
+PomAddParent.setVersion(String version) |
+
PomAddParent |
+PomAddParent.warnButAddIfPresent() |
+
PomAddParent |
+PomAddParent.warnNotAddIfPresent() |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomAddPlugin.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomAddPlugin.html new file mode 100644 index 00000000..c2f49577 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomAddPlugin.html @@ -0,0 +1,188 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.pom | +
+ Transformation operations to manipulate Maven POM files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
PomAddPlugin |
+PomAddPlugin.failIfPresent() |
+
PomAddPlugin |
+PomAddPlugin.noOpIfPresent() |
+
PomAddPlugin |
+PomAddPlugin.overwriteIfPresent() |
+
PomAddPlugin |
+PomAddPlugin.setVersion(String version) |
+
PomAddPlugin |
+PomAddPlugin.warnButAddIfPresent() |
+
PomAddPlugin |
+PomAddPlugin.warnNotAddIfPresent() |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomChangeDependency.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomChangeDependency.html new file mode 100644 index 00000000..77e918a9 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomChangeDependency.html @@ -0,0 +1,208 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.pom | +
+ Transformation operations to manipulate Maven POM files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
PomChangeDependency |
+PomChangeDependency.failIfNotPresent() |
+
PomChangeDependency |
+PomChangeDependency.noOpIfNotPresent() |
+
PomChangeDependency |
+PomChangeDependency.removeOptional() |
+
PomChangeDependency |
+PomChangeDependency.removeScope() |
+
PomChangeDependency |
+PomChangeDependency.removeType() |
+
PomChangeDependency |
+PomChangeDependency.removeVersion() |
+
PomChangeDependency |
+PomChangeDependency.setOptional() |
+
PomChangeDependency |
+PomChangeDependency.setScope(String scope) |
+
PomChangeDependency |
+PomChangeDependency.setType(String type) |
+
PomChangeDependency |
+PomChangeDependency.setVersion(String version) |
+
PomChangeDependency |
+PomChangeDependency.warnIfNotPresent() |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomChangePackaging.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomChangePackaging.html new file mode 100644 index 00000000..e128a757 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomChangePackaging.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.pom | +
+ Transformation operations to manipulate Maven POM files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
PomChangePackaging |
+PomChangePackaging.setPackagingType(String packagingType) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomChangeParent.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomChangeParent.html new file mode 100644 index 00000000..571469dc --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomChangeParent.html @@ -0,0 +1,200 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.pom | +
+ Transformation operations to manipulate Maven POM files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
PomChangeParent |
+PomChangeParent.failIfNotPresent()
+Deprecated.
+ |
+
PomChangeParent |
+PomChangeParent.noOpIfNotPresent()
+Deprecated.
+ |
+
PomChangeParent |
+PomChangeParent.setArtifactId(String artifactId)
+Deprecated.
+ |
+
PomChangeParent |
+PomChangeParent.setGroupId(String groupId)
+Deprecated.
+ |
+
PomChangeParent |
+PomChangeParent.setVersion(String version)
+Deprecated.
+ |
+
PomChangeParent |
+PomChangeParent.warnIfNotPresent()
+Deprecated.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomChangeParentVersion.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomChangeParentVersion.html new file mode 100644 index 00000000..897f7056 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomChangeParentVersion.html @@ -0,0 +1,180 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.pom | +
+ Transformation operations to manipulate Maven POM files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
PomChangeParentVersion |
+PomChangeParentVersion.failIfNotPresent() |
+
PomChangeParentVersion |
+PomChangeParentVersion.noOpIfNotPresent() |
+
PomChangeParentVersion |
+PomChangeParentVersion.setVersion(String version) |
+
PomChangeParentVersion |
+PomChangeParentVersion.warnIfNotPresent() |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomRemoveDependency.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomRemoveDependency.html new file mode 100644 index 00000000..334e24a8 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomRemoveDependency.html @@ -0,0 +1,176 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.pom | +
+ Transformation operations to manipulate Maven POM files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
PomRemoveDependency |
+PomRemoveDependency.failIfNotPresent() |
+
PomRemoveDependency |
+PomRemoveDependency.noOpIfNotPresent() |
+
PomRemoveDependency |
+PomRemoveDependency.warnIfNotPresent() |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomRemoveManagedDependency.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomRemoveManagedDependency.html new file mode 100644 index 00000000..4533f60c --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomRemoveManagedDependency.html @@ -0,0 +1,176 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.pom | +
+ Transformation operations to manipulate Maven POM files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
PomRemoveManagedDependency |
+PomRemoveManagedDependency.failIfNotPresent() |
+
PomRemoveManagedDependency |
+PomRemoveManagedDependency.noOpIfNotPresent() |
+
PomRemoveManagedDependency |
+PomRemoveManagedDependency.warnIfNotPresent() |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomRemovePlugin.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomRemovePlugin.html new file mode 100644 index 00000000..4b2d6111 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomRemovePlugin.html @@ -0,0 +1,176 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.pom | +
+ Transformation operations to manipulate Maven POM files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
PomRemovePlugin |
+PomRemovePlugin.failIfNotPresent() |
+
PomRemovePlugin |
+PomRemovePlugin.noOpIfNotPresent() |
+
PomRemovePlugin |
+PomRemovePlugin.warnIfNotPresent() |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomRemoveProperty.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomRemoveProperty.html new file mode 100644 index 00000000..ef3fb967 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomRemoveProperty.html @@ -0,0 +1,180 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.pom | +
+ Transformation operations to manipulate Maven POM files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
PomRemoveProperty |
+PomRemoveProperty.failIfNotPresent() |
+
PomRemoveProperty |
+PomRemoveProperty.noOpIfNotPresent() |
+
PomRemoveProperty |
+PomRemoveProperty.setPropertyName(String propertyName) |
+
PomRemoveProperty |
+PomRemoveProperty.warnIfNotPresent() |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomReplaceDependency.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomReplaceDependency.html new file mode 100644 index 00000000..e368434a --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/class-use/PomReplaceDependency.html @@ -0,0 +1,192 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.pom | +
+ Transformation operations to manipulate Maven POM files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
PomReplaceDependency |
+PomReplaceDependency.failIfNotPresent() |
+
PomReplaceDependency |
+PomReplaceDependency.noOpIfNotPresent() |
+
PomReplaceDependency |
+PomReplaceDependency.setNewArtifactId(String newArtifactId) |
+
PomReplaceDependency |
+PomReplaceDependency.setNewGroupId(String newGroupId) |
+
PomReplaceDependency |
+PomReplaceDependency.setNewScope(String newScope) |
+
PomReplaceDependency |
+PomReplaceDependency.setNewVersion(String newVersion) |
+
PomReplaceDependency |
+PomReplaceDependency.warnIfNotPresent() |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/package-frame.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/package-frame.html new file mode 100644 index 00000000..fc76d373 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/package-frame.html @@ -0,0 +1,33 @@ + + + + + + +See: Description
+| Class | +Description | +
|---|---|
| AbstractStaxArtifactPomOperation<T extends AbstractStaxArtifactPomOperation> | +
+ Abstract Artifact POM operation.
+ |
+
| PomAddDependency | +
+ Adds a new dependency to a POM file.
+ |
+
| PomAddParent | +
+ Add a parent artifact in a Maven POM file.
+ |
+
| PomAddPlugin | +
+ Adds a new plugin to a POM file.
+ |
+
| PomChangeDependency | +
+ Changes a dependency in a Maven POM file.
+ |
+
| PomChangePackaging | +
+ Changes the packaging of a Maven artifact, by changing its POM file.
+ |
+
| PomChangeParent | +Deprecated | +
| PomChangeParentVersion | +
+ Changes the parent's version in a Maven POM file.
+ |
+
| PomRemoveDependency | +
+ Removes a dependency entry from a POM file.
+ |
+
| PomRemoveManagedDependency | +
+ Removes a managed dependency entry from a POM file.
+ |
+
| PomRemovePlugin | +
+ Removes a plugin entry from a POM file.
+ |
+
| PomRemoveProperty | +
+ Removes a property entry from a POM file.
+ |
+
| PomReplaceDependency | +
+ Replaces a dependency by another one in a POM file.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/package-tree.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/package-tree.html new file mode 100644 index 00000000..588c49be --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/package-tree.html @@ -0,0 +1,170 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/package-use.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/package-use.html new file mode 100644 index 00000000..4e8acc4b --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/package-use.html @@ -0,0 +1,228 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.pom | +
+ Transformation operations to manipulate Maven POM files.
+ |
+
| Class and Description | +
|---|
| AbstractArtifactPomOperation
+ Abstract Artifact POM operation.
+ |
+
| AbstractStaxArtifactPomOperation
+ Abstract Artifact POM operation.
+ |
+
| PomAddDependency
+ Adds a new dependency to a POM file.
+ |
+
| PomAddParent
+ Add a parent artifact in a Maven POM file.
+ |
+
| PomAddPlugin
+ Adds a new plugin to a POM file.
+ |
+
| PomChangeDependency
+ Changes a dependency in a Maven POM file.
+ |
+
| PomChangePackaging
+ Changes the packaging of a Maven artifact, by changing its POM file.
+ |
+
| PomChangeParent
+ Deprecated.
+ |
+
| PomChangeParentVersion
+ Changes the parent's version in a Maven POM file.
+ |
+
| PomRemoveDependency
+ Removes a dependency entry from a POM file.
+ |
+
| PomRemoveManagedDependency
+ Removes a managed dependency entry from a POM file.
+ |
+
| PomRemovePlugin
+ Removes a plugin entry from a POM file.
+ |
+
| PomRemoveProperty
+ Removes a property entry from a POM file.
+ |
+
| PomReplaceDependency
+ Replaces a dependency by another one in a POM file.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/AbstractStaxOperation.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/AbstractStaxOperation.html new file mode 100644 index 00000000..78c145d3 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/AbstractStaxOperation.html @@ -0,0 +1,545 @@ + + + + + + +public abstract class AbstractStaxOperation<T extends AbstractStaxOperation>
+extends com.paypal.butterfly.extensions.api.TransformationOperation<T>
+| Modifier and Type | +Field and Description | +
|---|---|
protected static XMLEventFactory |
+eventFactory |
+
protected static XMLEvent |
+LINE_FEED |
+
UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
AbstractStaxOperation() |
+
| Modifier and Type | +Method and Description | +
|---|---|
T |
+clone() |
+
protected XMLEvent |
+copyUntil(XMLEventReader reader,
+ XMLEventWriter writer,
+ com.paypal.butterfly.utilities.operations.pom.stax.EventCondition condition,
+ boolean writeLast) |
+
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
protected XMLEvent |
+getIndentation(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
protected XMLEventReader |
+getReader(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
protected XMLEventWriter |
+getWriter(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
protected XMLEvent |
+skipUntil(XMLEventReader reader,
+ com.paypal.butterfly.utilities.operations.pom.stax.EventCondition condition) |
+
protected static void |
+writeMultiple(XMLEventWriter writer,
+ XMLEvent xmlEvent,
+ int n) |
+
protected abstract com.paypal.butterfly.extensions.api.TOExecutionResult |
+xmlExecution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
getOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getDescription, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetprotected static final XMLEventFactory eventFactory+
protected static final XMLEvent LINE_FEED+
protected XMLEvent copyUntil(XMLEventReader reader, + XMLEventWriter writer, + com.paypal.butterfly.utilities.operations.pom.stax.EventCondition condition, + boolean writeLast) + throws XMLStreamException+
XMLStreamExceptionprotected XMLEvent skipUntil(XMLEventReader reader, + com.paypal.butterfly.utilities.operations.pom.stax.EventCondition condition) + throws XMLStreamException+
XMLStreamExceptionprotected XMLEventReader getReader(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) + throws IOException, + XMLStreamException+
IOExceptionXMLStreamExceptionprotected XMLEventWriter getWriter(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) + throws FileNotFoundException, + XMLStreamException+
FileNotFoundExceptionXMLStreamExceptionprotected XMLEvent getIndentation(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) + throws IOException, + XMLStreamException+
IOExceptionXMLStreamExceptionprotected static void writeMultiple(XMLEventWriter writer, + XMLEvent xmlEvent, + int n) + throws XMLStreamException+
XMLStreamExceptionprotected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends AbstractStaxOperation>protected abstract com.paypal.butterfly.extensions.api.TOExecutionResult xmlExecution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) + throws org.codehaus.plexus.util.xml.pull.XmlPullParserException, + XMLStreamException, + IOException+
org.codehaus.plexus.util.xml.pull.XmlPullParserExceptionXMLStreamExceptionIOExceptionpublic T clone()+
clone in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends AbstractStaxOperation>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/EndElementEventCondition.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/EndElementEventCondition.html new file mode 100644 index 00000000..a14ef74a --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/EndElementEventCondition.html @@ -0,0 +1,273 @@ + + + + + + +public class EndElementEventCondition +extends Object+
| Constructor and Description | +
|---|
EndElementEventCondition(String tagName) |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+evaluateEvent(XMLEvent xmlEvent) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/StartDocumentEventCondition.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/StartDocumentEventCondition.html new file mode 100644 index 00000000..6960a49f --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/StartDocumentEventCondition.html @@ -0,0 +1,273 @@ + + + + + + +public class StartDocumentEventCondition +extends Object+
| Constructor and Description | +
|---|
StartDocumentEventCondition() |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+evaluateEvent(XMLEvent xmlEvent) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/StartElementEventCondition.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/StartElementEventCondition.html new file mode 100644 index 00000000..914da842 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/StartElementEventCondition.html @@ -0,0 +1,273 @@ + + + + + + +public class StartElementEventCondition +extends Object+
| Constructor and Description | +
|---|
StartElementEventCondition(String tagName) |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+evaluateEvent(XMLEvent xmlEvent) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/class-use/AbstractStaxOperation.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/class-use/AbstractStaxOperation.html new file mode 100644 index 00000000..2eeda562 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/class-use/AbstractStaxOperation.html @@ -0,0 +1,206 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.pom | +
+ Transformation operations to manipulate Maven POM files.
+ |
+
| com.paypal.butterfly.utilities.operations.pom.stax | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AbstractStaxArtifactPomOperation<T extends AbstractStaxArtifactPomOperation>
+Abstract Artifact POM operation.
+ |
+
class |
+PomAddParent
+Add a parent artifact in a Maven POM file.
+ |
+
class |
+PomChangeParentVersion
+Changes the parent's version in a Maven POM file.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AbstractStaxOperation<T extends AbstractStaxOperation>
+Abstract StAX operation, used to stream based XML manipulation.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/class-use/EndElementEventCondition.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/class-use/EndElementEventCondition.html new file mode 100644 index 00000000..604bc09a --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/class-use/EndElementEventCondition.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/class-use/StartDocumentEventCondition.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/class-use/StartDocumentEventCondition.html new file mode 100644 index 00000000..478d8a1e --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/class-use/StartDocumentEventCondition.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/class-use/StartElementEventCondition.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/class-use/StartElementEventCondition.html new file mode 100644 index 00000000..ac8393e7 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/class-use/StartElementEventCondition.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/package-frame.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/package-frame.html new file mode 100644 index 00000000..b41a1ae7 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/package-frame.html @@ -0,0 +1,24 @@ + + + + + + +| Class | +Description | +
|---|---|
| AbstractStaxOperation<T extends AbstractStaxOperation> | +
+ Abstract StAX operation, used to stream based XML manipulation.
+ |
+
| EndElementEventCondition | ++ |
| StartDocumentEventCondition | ++ |
| StartElementEventCondition | ++ |
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/package-tree.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/package-tree.html new file mode 100644 index 00000000..5adde57b --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/package-tree.html @@ -0,0 +1,150 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/package-use.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/package-use.html new file mode 100644 index 00000000..ec249bf7 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/stax/package-use.html @@ -0,0 +1,184 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.pom | +
+ Transformation operations to manipulate Maven POM files.
+ |
+
| com.paypal.butterfly.utilities.operations.pom.stax | ++ |
| Class and Description | +
|---|
| AbstractStaxOperation
+ Abstract StAX operation, used to stream based XML manipulation.
+ |
+
| Class and Description | +
|---|
| AbstractStaxOperation
+ Abstract StAX operation, used to stream based XML manipulation.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/AddProperty.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/AddProperty.html new file mode 100644 index 00000000..23999e1e --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/AddProperty.html @@ -0,0 +1,420 @@ + + + + + + +public class AddProperty +extends com.paypal.butterfly.extensions.api.TransformationOperation<AddProperty>+
UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
AddProperty() |
+
AddProperty(String propertyName,
+ String propertyValue)
+Operation to add a new property to a properties file.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
String |
+getPropertyName() |
+
String |
+getPropertyValue() |
+
AddProperty |
+setPropertyName(String propertyName) |
+
AddProperty |
+setPropertyValue(String propertyValue) |
+
getOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic AddProperty()+
public AddProperty(String propertyName, + String propertyValue)+
propertyName - name to the property to be addedpropertyValue - value to be set to the new propertypublic AddProperty setPropertyName(String propertyName)+
public AddProperty setPropertyValue(String propertyValue)+
public String getPropertyName()+
public String getPropertyValue()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<AddProperty>protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<AddProperty>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/RemoveProperty.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/RemoveProperty.html new file mode 100644 index 00000000..07961994 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/RemoveProperty.html @@ -0,0 +1,389 @@ + + + + + + +public class RemoveProperty +extends com.paypal.butterfly.extensions.api.TransformationOperation<RemoveProperty>+
UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
RemoveProperty() |
+
RemoveProperty(String propertyName)
+Operation to remove a property from a properties file.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
String |
+getPropertyName() |
+
RemoveProperty |
+setPropertyName(String propertyName) |
+
getOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic RemoveProperty()+
public RemoveProperty(String propertyName)+
propertyName - name to the property to be removedpublic RemoveProperty setPropertyName(String propertyName)+
public String getPropertyName()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<RemoveProperty>protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<RemoveProperty>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/class-use/AddProperty.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/class-use/AddProperty.html new file mode 100644 index 00000000..5acd56e3 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/class-use/AddProperty.html @@ -0,0 +1,172 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.properties | +
+ Transformation operations to manipulate properties files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
AddProperty |
+AddProperty.setPropertyName(String propertyName) |
+
AddProperty |
+AddProperty.setPropertyValue(String propertyValue) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/class-use/RemoveProperty.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/class-use/RemoveProperty.html new file mode 100644 index 00000000..4aab2a0a --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/class-use/RemoveProperty.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.properties | +
+ Transformation operations to manipulate properties files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
RemoveProperty |
+RemoveProperty.setPropertyName(String propertyName) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/package-frame.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/package-frame.html new file mode 100644 index 00000000..db978b1f --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/package-frame.html @@ -0,0 +1,22 @@ + + + + + + +See: Description
+| Class | +Description | +
|---|---|
| AddProperty | +
+ Adds a new property to a properties file.
+ |
+
| RemoveProperty | +
+ Removes a property from a properties file.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/package-tree.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/package-tree.html new file mode 100644 index 00000000..3652a6e3 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/package-tree.html @@ -0,0 +1,148 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/package-use.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/package-use.html new file mode 100644 index 00000000..f745c19a --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/package-use.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.properties | +
+ Transformation operations to manipulate properties files.
+ |
+
| Class and Description | +
|---|
| AddProperty
+ Adds a new property to a properties file.
+ |
+
| RemoveProperty
+ Removes a property from a properties file.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/AddLine.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/AddLine.html new file mode 100644 index 00000000..75446d94 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/AddLine.html @@ -0,0 +1,400 @@ + + + + + + +UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
AddLine() |
+
AddLine(String newLine)
+Operation to add a new line to the end of a file.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
String |
+getNewLine() |
+
AddLine |
+setNewLine(String newLine)
+Sets the new line to be inserted.
+ |
+
getOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic AddLine()+
public AddLine(String newLine)+
newLine to an empty string ""newLine - the new line to be addedpublic AddLine setNewLine(String newLine)+
newLine to an empty string ""newLine - the new line to be insertedpublic String getNewLine()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<AddLine>protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<AddLine>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertLine.InsertionMode.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertLine.InsertionMode.html new file mode 100644 index 00000000..74dfdfa1 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertLine.InsertionMode.html @@ -0,0 +1,404 @@ + + + + + + +public static enum InsertLine.InsertionMode +extends Enum<InsertLine.InsertionMode>+
TOExecutionResult.Type.NO_OP will be returned| Enum Constant and Description | +
|---|
CONCAT |
+
LINE_NUMBER |
+
REGEX_ALL |
+
REGEX_BEFORE_ALL |
+
REGEX_BEFORE_FIRST |
+
REGEX_FIRST |
+
| Modifier and Type | +Method and Description | +
|---|---|
static InsertLine.InsertionMode |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static InsertLine.InsertionMode[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final InsertLine.InsertionMode CONCAT+
public static final InsertLine.InsertionMode LINE_NUMBER+
public static final InsertLine.InsertionMode REGEX_FIRST+
public static final InsertLine.InsertionMode REGEX_ALL+
public static final InsertLine.InsertionMode REGEX_BEFORE_FIRST+
public static final InsertLine.InsertionMode REGEX_BEFORE_ALL+
public static InsertLine.InsertionMode[] values()+
+for (InsertLine.InsertionMode c : InsertLine.InsertionMode.values()) + System.out.println(c); +
public static InsertLine.InsertionMode valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertLine.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertLine.html new file mode 100644 index 00000000..2653777e --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertLine.html @@ -0,0 +1,580 @@ + + + + + + +public class InsertLine +extends com.paypal.butterfly.extensions.api.TransformationOperation<InsertLine>+
TOExecutionResult.Type.NO_OP will be returnedsetInsertionMode(InsertionMode).InsertLine.InsertionMode| Modifier and Type | +Class and Description | +
|---|---|
static class |
+InsertLine.InsertionMode
+The new line(s) can be inserted:
+
+ InsertionMode.CONCAT: At the final of the file (default)
+ InsertionMode.LINE_NUMBER: At one particular specified line number (first line is number 1).
+ |
+
UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
InsertLine()
+Operation to insert new line(s) into a text file.
+ |
+
InsertLine(String newLine)
+Operation to insert a new line into a text file.
+ |
+
InsertLine(String newLine,
+ Integer lineNumber)
+Operation to insert a new line into a text file.
+ |
+
InsertLine(String newLine,
+ String regex)
+Operation to insert a new line into a text file.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
InsertLine |
+setInsertionMode(InsertLine.InsertionMode insertionMode)
+Sets the insertion mode
+ |
+
InsertLine |
+setLineNumber(Integer lineNumber)
+Sets the line number the new line should be added at.
+ |
+
InsertLine |
+setNewLine(String newLine)
+Sets the new line to be inserted.
+ |
+
InsertLine |
+setRegex(String regex)
+Sets the regular expression to find insertion points
+ Notice that the insertion mode is automatically set to
+
+InsertLine.InsertionMode.REGEX_FIRST, unless already set
+ to InsertLine.InsertionMode.REGEX_ALL, InsertLine.InsertionMode.REGEX_BEFORE_FIRST
+ or InsertLine.InsertionMode.REGEX_BEFORE_ALL. |
+
getOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic InsertLine()+
TOExecutionResult.Type.NO_OP will be returnedsetInsertionMode(InsertionMode).InsertLine.InsertionModepublic InsertLine(String newLine)+
setInsertionMode(InsertionMode).newLine - the new line to be insertedpublic InsertLine(String newLine, + Integer lineNumber)+
InsertLine.InsertionMode.LINE_NUMBERnewLine - the new line to be insertedlineNumber - the line number where the new line will be insertedpublic InsertLine(String newLine, + String regex)+
InsertLine.InsertionMode.REGEX_FIRSTnewLine - the new line to be insertedregex - the regular expression used to determine where
+ the new line should be insertedpublic InsertLine setInsertionMode(InsertLine.InsertionMode insertionMode)+
insertionMode - the insertion modepublic InsertLine setNewLine(String newLine)+
newLine to an empty string ""newLine - the new line to be insertedpublic InsertLine setLineNumber(Integer lineNumber)+
TOExecutionResult.Type.NO_OP will be returned.
+ Notice that the insertion mode is automatically set to
+ InsertLine.InsertionMode.LINE_NUMBER.lineNumber - the line number the new line should be added atpublic InsertLine setRegex(String regex)+
InsertLine.InsertionMode.REGEX_FIRST, unless already set
+ to InsertLine.InsertionMode.REGEX_ALL, InsertLine.InsertionMode.REGEX_BEFORE_FIRST
+ or InsertLine.InsertionMode.REGEX_BEFORE_ALL.
+ setInsertionMode(InsertionMode).regex - the regular expression to find insertion pointsInsertLine.InsertionModepublic String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<InsertLine>protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<InsertLine>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertText.InsertionMode.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertText.InsertionMode.html new file mode 100644 index 00000000..e6912cfd --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertText.InsertionMode.html @@ -0,0 +1,378 @@ + + + + + + +public static enum InsertText.InsertionMode +extends Enum<InsertText.InsertionMode>+
| Enum Constant and Description | +
|---|
CONCAT |
+
LINE_NUMBER |
+
REGEX_ALL |
+
REGEX_FIRST |
+
| Modifier and Type | +Method and Description | +
|---|---|
static InsertText.InsertionMode |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static InsertText.InsertionMode[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final InsertText.InsertionMode CONCAT+
public static final InsertText.InsertionMode LINE_NUMBER+
public static final InsertText.InsertionMode REGEX_FIRST+
public static final InsertText.InsertionMode REGEX_ALL+
public static InsertText.InsertionMode[] values()+
+for (InsertText.InsertionMode c : InsertText.InsertionMode.values()) + System.out.println(c); +
public static InsertText.InsertionMode valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertText.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertText.html new file mode 100644 index 00000000..a5e13047 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertText.html @@ -0,0 +1,572 @@ + + + + + + +public class InsertText +extends com.paypal.butterfly.extensions.api.TransformationOperation<InsertText>+
setInsertionMode(InsertionMode)InsertText.InsertionMode| Modifier and Type | +Class and Description | +
|---|---|
static class |
+InsertText.InsertionMode
+The text can be inserted:
+
+ InsertionMode.CONCAT: At the final of the file (default)
+ InsertionMode.LINE_NUMBER: At one particular specified line number (first line is number 1)
+ InsertionMode.REGEX_FIRST: Right after only the first line to match the specified regular expression
+ InsertionMode.REGEX_ALL: Right after any line to match the specified regular expression
+
+ |
+
UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
InsertText()
+Operation to insert text into another text file.
+ |
+
InsertText(URL textFileUrl)
+Operation to insert text into another text file.
+ |
+
InsertText(URL textFileUrl,
+ Integer lineNumber)
+Operation to insert text into another text file.
+ |
+
InsertText(URL textFileUrl,
+ String regex)
+Operation to insert text into another text file.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
InsertText |
+setInsertionMode(InsertText.InsertionMode insertionMode)
+Sets the insertion mode
+ |
+
InsertText |
+setLineNumber(Integer lineNumber)
+Sets the line number the text should be added at.
+ |
+
InsertText |
+setRegex(String regex)
+Sets the regular expression to find insertion points
+
++ See setInsertionMode(InsertionMode) |
+
InsertText |
+setTextFileUrl(URL textFileUrl)
+Sets the URL to the text to be inserted
+ |
+
getOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic InsertText()+
setInsertionMode(InsertionMode)InsertText.InsertionModepublic InsertText(URL textFileUrl)+
setInsertionMode(InsertionMode)textFileUrl - the URL to the text to be insertedpublic InsertText(URL textFileUrl, + Integer lineNumber)+
InsertText.InsertionMode.LINE_NUMBERtextFileUrl - the URL to the text to be insertedlineNumber - the line number the text should be added atpublic InsertText(URL textFileUrl, + String regex)+
InsertText.InsertionMode.REGEX_FIRSTtextFileUrl - the URL to the text to be insertedregex - the regular expression to find insertion pointspublic InsertText setInsertionMode(InsertText.InsertionMode insertionMode)+
insertionMode - the insertion modepublic InsertText setTextFileUrl(URL textFileUrl)+
textFileUrl - the URL to the text to be insertedpublic InsertText setLineNumber(Integer lineNumber)+
lineNumber - the line number the text should be added atpublic InsertText setRegex(String regex)+
setInsertionMode(InsertionMode)regex - the regular expression to find insertion pointsInsertText.InsertionModepublic String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<InsertText>protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<InsertText>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/RemoveLine.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/RemoveLine.html new file mode 100644 index 00000000..d17b9100 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/RemoveLine.html @@ -0,0 +1,483 @@ + + + + + + +public class RemoveLine +extends com.paypal.butterfly.utilities.operations.text.AbstractLineOperation<RemoveLine>+
AbstractLineOperation.setFirstOnly(boolean) is set to false, then
+ all lines that match it will be removed.
+ manipulationWordUTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
RemoveLine()
+Operation to remove one, or more, lines from a text file.
+ |
+
RemoveLine(Integer lineNumber)
+Operation to remove one line from a text file, based on a
+ line number.
+ |
+
RemoveLine(String regex)
+Operation to remove one, or more, lines from a text file.
+ |
+
RemoveLine(String regex,
+ boolean firstOnly)
+Operation to remove one, or more, lines from a text file.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getDescription() |
+
protected boolean |
+manipulateLine(String lineToBeManipulated,
+ Writer writer)
+To be specialized by subclasses, defining what specific change should be done
+ |
+
execution, getLineNumber, getRegex, isFirstOnly, setFirstOnly, setLineNumber, setRegexgetOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic RemoveLine()+
AbstractLineOperation.setFirstOnly(boolean) is set to false, then
+ all lines that match it will be removed.
+ public RemoveLine(String regex)+
AbstractLineOperation.setFirstOnly(boolean) is set to false, then
+ all lines that match it will be removed.
+ regex - the regular expression to identify the line(s) to be removedpublic RemoveLine(String regex, + boolean firstOnly)+
AbstractLineOperation.setFirstOnly(boolean) is set to false, then
+ all lines that match it will be removed.
+ regex - the regular expression to identify the line(s) to be removedfirstOnly - if true, only the first line found (from top down) to match
+ the regular expression will be removed. If false, all of them
+ willpublic RemoveLine(Integer lineNumber)+
lineNumber - the number of the line to be removedprotected boolean manipulateLine(String lineToBeManipulated, + Writer writer)+
com.paypal.butterfly.utilities.operations.text.AbstractLineOperationmanipulateLine in class com.paypal.butterfly.utilities.operations.text.AbstractLineOperation<RemoveLine>lineToBeManipulated - if it has an EOL character, it will be in the beginning, not in the endwriter - used to manipulate the file to be changedwriterpublic String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<RemoveLine>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/ReplaceLine.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/ReplaceLine.html new file mode 100644 index 00000000..af8968f3 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/ReplaceLine.html @@ -0,0 +1,550 @@ + + + + + + +public class ReplaceLine +extends com.paypal.butterfly.utilities.operations.text.AbstractLineOperation<ReplaceLine>+
AbstractLineOperation.setFirstOnly(boolean) is set to false, then
+ all lines that match it will be replaced.
+ manipulationWordUTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
ReplaceLine()
+Operation to replace one, or more, lines from a text file.
+ |
+
ReplaceLine(Integer lineNumber,
+ String replacement)
+Operation to replace one line from a text file, based on a
+ line number.
+ |
+
ReplaceLine(String regex,
+ String replacement)
+Operation to replace one, or more, lines from a text file.
+ |
+
ReplaceLine(String regex,
+ String replacement,
+ boolean firstOnly)
+Operation to replace one, or more, lines from a text file.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getDescription() |
+
String |
+getReplacement() |
+
protected boolean |
+manipulateLine(String lineToBeManipulated,
+ Writer writer)
+To be specialized by subclasses, defining what specific change should be done
+ |
+
ReplaceLine |
+setReplacement(String replacement)
+Sets the replacement line
+ |
+
execution, getLineNumber, getRegex, isFirstOnly, setFirstOnly, setLineNumber, setRegexgetOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic ReplaceLine()+
AbstractLineOperation.setFirstOnly(boolean) is set to false, then
+ all lines that match it will be replaced.
+ public ReplaceLine(String regex, + String replacement)+
AbstractLineOperation.setFirstOnly(boolean) is set to false, then
+ all lines that match it will be replaced.
+ regex - the regular expression to identify the line(s) to be replacedreplacement - the replacement line. It is not necessary to add explicitly any
+ end of line (EOL) character in the end of the line, that will be done
+ automatically, but ONLY if the original line has an EOL character too.
+ The same format of EOL character will be preserved.
+ If any EOL character is present anywhere in replacement, it
+ will not be removed nor changed.public ReplaceLine(String regex, + String replacement, + boolean firstOnly)+
AbstractLineOperation.setFirstOnly(boolean) is set to false, then
+ all lines that match it will be replaced.
+ regex - the regular expression to identify the line(s) to be replacedreplacement - the replacement line. It is not necessary to add explicitly any
+ end of line (EOL) character in the end of the line, that will be done
+ automatically, but ONLY if the original line has an EOL character too.
+ The same format of EOL character will be preserved.
+ If any EOL character is present anywhere in replacement, it
+ will not be removed nor changed.firstOnly - if true, only the first line found (from top down) to match
+ the regular expression will be replaced. If false, all of them
+ willpublic ReplaceLine(Integer lineNumber, + String replacement)+
replacement - the replacement line. It is not necessary to add explicitly any
+ end of line (EOL) character in the end of the line, that will be done
+ automatically, but ONLY if the original line has an EOL character too.
+ The same format of EOL character will be preserved.
+ If any EOL character is present anywhere in replacement, it
+ will not be removed nor changed.lineNumber - the number of the line to be replacedpublic ReplaceLine setReplacement(String replacement)+
replacement - the replacement line. It is not necessary to add explicitly any
+ end of line (EOL) character in the end of the line, that will be done
+ automatically, but ONLY if the original line has an EOL character too.
+ The same format of EOL character will be preserved.
+ If any EOL character is present anywhere in replacement, it
+ will not be removed nor changed.public String getReplacement()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<ReplaceLine>protected boolean manipulateLine(String lineToBeManipulated, + Writer writer) + throws IOException+
com.paypal.butterfly.utilities.operations.text.AbstractLineOperationmanipulateLine in class com.paypal.butterfly.utilities.operations.text.AbstractLineOperation<ReplaceLine>lineToBeManipulated - if it has an EOL character, it will be in the beginning, not in the endwriter - used to manipulate the file to be changedwriterIOException - if an IO operation failsCopyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/ReplaceText.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/ReplaceText.html new file mode 100644 index 00000000..e0798b89 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/ReplaceText.html @@ -0,0 +1,503 @@ + + + + + + +public class ReplaceText +extends com.paypal.butterfly.extensions.api.TransformationOperation<ReplaceText>+
UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
ReplaceText()
+Operation to replace text in a text file
+ based on a regular expression.
+ |
+
ReplaceText(String regex)
+Operation to replace text in a text file
+ based on a regular expression.
+ |
+
ReplaceText(String regex,
+ String replacement)
+Operation to replace text in a text file
+ based on a regular expression.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TOExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
String |
+getRegex() |
+
String |
+getReplacement() |
+
boolean |
+isFirstOnly() |
+
ReplaceText |
+setFirstOnly(boolean firstOnly)
+Sets whether all lines, or only the first, to match the
+ regular expression will be replaced
+ |
+
ReplaceText |
+setRegex(String regex)
+Sets the regular expression to find replacement points
+ |
+
ReplaceText |
+setReplacement(String replacement)
+Sets the replacement text
+ |
+
getOrCreateReadFile, perform, setSaveResultabortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySetpublic ReplaceText()+
public ReplaceText(String regex)+
regex - the regular expression to find replacement pointspublic ReplaceText setRegex(String regex)+
regex - the regular expression to find replacement pointspublic ReplaceText setReplacement(String replacement)+
replacement - the replacement textpublic ReplaceText setFirstOnly(boolean firstOnly)+
firstOnly - all lines, or only the first, to match the
+ regular expression will be replacedpublic String getRegex()+
public String getReplacement()+
public boolean isFirstOnly()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<ReplaceText>protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<ReplaceText>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/AddLine.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/AddLine.html new file mode 100644 index 00000000..256100fa --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/AddLine.html @@ -0,0 +1,170 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.text | +
+ Transformation operations to manipulate text files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
AddLine |
+AddLine.setNewLine(String newLine)
+Sets the new line to be inserted.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/InsertLine.InsertionMode.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/InsertLine.InsertionMode.html new file mode 100644 index 00000000..6de218d1 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/InsertLine.InsertionMode.html @@ -0,0 +1,192 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.text | +
+ Transformation operations to manipulate text files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static InsertLine.InsertionMode |
+InsertLine.InsertionMode.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static InsertLine.InsertionMode[] |
+InsertLine.InsertionMode.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
InsertLine |
+InsertLine.setInsertionMode(InsertLine.InsertionMode insertionMode)
+Sets the insertion mode
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/InsertLine.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/InsertLine.html new file mode 100644 index 00000000..a61ce586 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/InsertLine.html @@ -0,0 +1,192 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.text | +
+ Transformation operations to manipulate text files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
InsertLine |
+InsertLine.setInsertionMode(InsertLine.InsertionMode insertionMode)
+Sets the insertion mode
+ |
+
InsertLine |
+InsertLine.setLineNumber(Integer lineNumber)
+Sets the line number the new line should be added at.
+ |
+
InsertLine |
+InsertLine.setNewLine(String newLine)
+Sets the new line to be inserted.
+ |
+
InsertLine |
+InsertLine.setRegex(String regex)
+Sets the regular expression to find insertion points
+ Notice that the insertion mode is automatically set to
+
+InsertLine.InsertionMode.REGEX_FIRST, unless already set
+ to InsertLine.InsertionMode.REGEX_ALL, InsertLine.InsertionMode.REGEX_BEFORE_FIRST
+ or InsertLine.InsertionMode.REGEX_BEFORE_ALL. |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/InsertText.InsertionMode.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/InsertText.InsertionMode.html new file mode 100644 index 00000000..56862e5b --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/InsertText.InsertionMode.html @@ -0,0 +1,192 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.text | +
+ Transformation operations to manipulate text files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static InsertText.InsertionMode |
+InsertText.InsertionMode.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static InsertText.InsertionMode[] |
+InsertText.InsertionMode.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
InsertText |
+InsertText.setInsertionMode(InsertText.InsertionMode insertionMode)
+Sets the insertion mode
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/InsertText.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/InsertText.html new file mode 100644 index 00000000..e461e4e7 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/InsertText.html @@ -0,0 +1,190 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.text | +
+ Transformation operations to manipulate text files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
InsertText |
+InsertText.setInsertionMode(InsertText.InsertionMode insertionMode)
+Sets the insertion mode
+ |
+
InsertText |
+InsertText.setLineNumber(Integer lineNumber)
+Sets the line number the text should be added at.
+ |
+
InsertText |
+InsertText.setRegex(String regex)
+Sets the regular expression to find insertion points
+
++ See setInsertionMode(InsertionMode) |
+
InsertText |
+InsertText.setTextFileUrl(URL textFileUrl)
+Sets the URL to the text to be inserted
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/RemoveLine.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/RemoveLine.html new file mode 100644 index 00000000..d4b0e727 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/RemoveLine.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/ReplaceLine.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/ReplaceLine.html new file mode 100644 index 00000000..8afb4a14 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/ReplaceLine.html @@ -0,0 +1,170 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.text | +
+ Transformation operations to manipulate text files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ReplaceLine |
+ReplaceLine.setReplacement(String replacement)
+Sets the replacement line
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/ReplaceText.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/ReplaceText.html new file mode 100644 index 00000000..aabd8493 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/class-use/ReplaceText.html @@ -0,0 +1,183 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.text | +
+ Transformation operations to manipulate text files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ReplaceText |
+ReplaceText.setFirstOnly(boolean firstOnly)
+Sets whether all lines, or only the first, to match the
+ regular expression will be replaced
+ |
+
ReplaceText |
+ReplaceText.setRegex(String regex)
+Sets the regular expression to find replacement points
+ |
+
ReplaceText |
+ReplaceText.setReplacement(String replacement)
+Sets the replacement text
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/package-frame.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/package-frame.html new file mode 100644 index 00000000..efd223c3 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/package-frame.html @@ -0,0 +1,31 @@ + + + + + + +See: Description
+| Class | +Description | +
|---|---|
| AddLine | +
+ Adds a new line to the end of a file.
+ |
+
| InsertLine | +
+ Inserts new line(s) into a text file.
+ |
+
| InsertText | +
+ Inserts text from one file into another text file.
+ |
+
| RemoveLine | +
+ Removes one, or more, lines from a text file.
+ |
+
| ReplaceLine | +
+ Replaces one, or more, lines from a text file.
+ |
+
| ReplaceText | +
+ Replaces text in a text file
+ based on a regular expression.
+ |
+
| Enum | +Description | +
|---|---|
| InsertLine.InsertionMode | +
+ The new line(s) can be inserted:
+
+ InsertionMode.CONCAT: At the final of the file (default)
+ InsertionMode.LINE_NUMBER: At one particular specified line number (first line is number 1).
+ |
+
| InsertText.InsertionMode | +
+ The text can be inserted:
+
+ InsertionMode.CONCAT: At the final of the file (default)
+ InsertionMode.LINE_NUMBER: At one particular specified line number (first line is number 1)
+ InsertionMode.REGEX_FIRST: Right after only the first line to match the specified regular expression
+ InsertionMode.REGEX_ALL: Right after any line to match the specified regular expression
+
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/package-tree.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/package-tree.html new file mode 100644 index 00000000..3f3487e3 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/package-tree.html @@ -0,0 +1,169 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/package-use.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/package-use.html new file mode 100644 index 00000000..db140730 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/package-use.html @@ -0,0 +1,208 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.operations.text | +
+ Transformation operations to manipulate text files.
+ |
+
| Class and Description | +
|---|
| AbstractLineOperation
+ Abstract operation to manipulate one, or more, lines from a text file.
+ |
+
| AddLine
+ Adds a new line to the end of a file.
+ |
+
| InsertLine
+ Inserts new line(s) into a text file.
+ |
+
| InsertLine.InsertionMode
+ The new line(s) can be inserted:
+
+ InsertionMode.CONCAT: At the final of the file (default)
+ InsertionMode.LINE_NUMBER: At one particular specified line number (first line is number 1).
+ |
+
| InsertText
+ Inserts text from one file into another text file.
+ |
+
| InsertText.InsertionMode
+ The text can be inserted:
+
+ InsertionMode.CONCAT: At the final of the file (default)
+ InsertionMode.LINE_NUMBER: At one particular specified line number (first line is number 1)
+ InsertionMode.REGEX_FIRST: Right after only the first line to match the specified regular expression
+ InsertionMode.REGEX_ALL: Right after any line to match the specified regular expression
+
+ |
+
| ReplaceLine
+ Replaces one, or more, lines from a text file.
+ |
+
| ReplaceText
+ Replaces text in a text file
+ based on a regular expression.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/text/StringFormat.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/text/StringFormat.html new file mode 100644 index 00000000..9927133b --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/text/StringFormat.html @@ -0,0 +1,401 @@ + + + + + + +public class StringFormat +extends com.paypal.butterfly.extensions.api.TransformationUtility<StringFormat>+
String.format(String, Object...).
+ The setting order of attributes will be
+ honored when applying the formatting.UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
StringFormat() |
+
StringFormat(String format) |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TUExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String[] |
+getAttributeNames() |
+
String |
+getDescription() |
+
String |
+getFormat() |
+
StringFormat |
+setAttributeNames(String... attributeNames) |
+
StringFormat |
+setFormat(String format) |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic StringFormat()+
public StringFormat(String format)+
public StringFormat setFormat(String format)+
public StringFormat setAttributeNames(String... attributeNames)+
public String getFormat()+
public String[] getAttributeNames()+
public String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<StringFormat>protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<StringFormat>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/text/class-use/StringFormat.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/text/class-use/StringFormat.html new file mode 100644 index 00000000..c0469068 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/text/class-use/StringFormat.html @@ -0,0 +1,172 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.text | +
+ Transformation utilities to gather meta-data about text files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
StringFormat |
+StringFormat.setAttributeNames(String... attributeNames) |
+
StringFormat |
+StringFormat.setFormat(String format) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/text/package-frame.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/text/package-frame.html new file mode 100644 index 00000000..bfef5ae9 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/text/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +See: Description
+| Class | +Description | +
|---|---|
| StringFormat | +
+ Registers a new transformation context
+ attribute by applying one or more existent
+ String transformation context attributes to
+
+String.format(String, Object...). |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/text/package-tree.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/text/package-tree.html new file mode 100644 index 00000000..1bf1440f --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/text/package-tree.html @@ -0,0 +1,143 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/text/package-use.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/text/package-use.html new file mode 100644 index 00000000..213c85b4 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/text/package-use.html @@ -0,0 +1,166 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.text | +
+ Transformation utilities to gather meta-data about text files.
+ |
+
| Class and Description | +
|---|
| StringFormat
+ Registers a new transformation context
+ attribute by applying one or more existent
+ String transformation context attributes to
+
+String.format(String, Object...). |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/xml/XmlElement.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/xml/XmlElement.html new file mode 100644 index 00000000..38b9a7b6 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/xml/XmlElement.html @@ -0,0 +1,460 @@ + + + + + + +public class XmlElement +extends com.paypal.butterfly.extensions.api.TransformationUtility<XmlElement>+
TUExecutionResult.Type.NULL is returned.
+ If the file is not a well formed XML file, an error is returned.UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
XmlElement()
+Retrieves the value of an element,
+ or one of its attributes, in a XML file.
+ |
+
XmlElement(String xmlElement)
+Retrieves the value of an element,
+ or one of its attributes, in a XML file.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TUExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
XmlElement |
+setAttribute(String attribute)
+Set the name of the XML element attribute
+ to be retrieved.
+ |
+
XmlElement |
+setXmlElement(String xmlElement)
+The XML element whose value, or an attribute, should be
+ the result of this transformation utility.
+ |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic XmlElement()+
public XmlElement(String xmlElement)+
xmlElement the XML element whose value, or an attribute, should be
+ the result of this transformation utility. The element specified
+ here should be set based on a path containing all its
+ parent elements separated by '.'. See the example bellow.
+ xmlElement
+ to person.child.name. In this example,
+ that would return Gabriela
+ <?xml version="1.0" encoding="UTF-8"?>
+ <person>
+ <name>Bruna</name>
+ <child>
+ <name>Gabriela</name>
+ </child>
+ </peson>
+ xmlElement - the XML element whose value, or an attribute, should be
+ the result of this transformation utilitypublic XmlElement setXmlElement(String xmlElement)+
xmlElement
+ to person.child.name. In this example,
+ that would return Gabriela
+ <?xml version="1.0" encoding="UTF-8"?>
+ <person>
+ <name>Bruna</name>
+ <child>
+ <name>Gabriela</name>
+ </child>
+ </peson>
+ xmlElement - the XML element whose value, or an attribute, should be
+ the result of this transformation utilitypublic XmlElement setAttribute(String attribute)+
attribute - the name of the XML element attribute
+ to be retrievedpublic String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<XmlElement>protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<XmlElement>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/xml/XmlIndentation.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/xml/XmlIndentation.html new file mode 100644 index 00000000..94b49cc8 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/xml/XmlIndentation.html @@ -0,0 +1,368 @@ + + + + + + +public class XmlIndentation +extends com.paypal.butterfly.extensions.api.TransformationUtility<XmlIndentation>+
TUExecutionResult.Type.NULL if the root tag has no children,
+ or if the first tag is at the same line as the root tag.UTILITY_NAME_SYNTAX| Constructor and Description | +
|---|
XmlIndentation() |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected com.paypal.butterfly.extensions.api.TUExecutionResult |
+execution(File transformedAppFolder,
+ com.paypal.butterfly.extensions.api.TransformationContext transformationContext) |
+
String |
+getDescription() |
+
static String |
+getFirst(File xmlFile)
+Returns a String that represents the indentation used in the very first
+ tag, inside the root tag, in the given XML file.
+ |
+
abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySetpublic static String getFirst(File xmlFile) + throws XMLStreamException, + FileNotFoundException+
null if the root tag has no children,
+ or if the first tag is at the same line as the root tag.xmlFile - XML file to be evaluatedFileNotFoundException - if the given file does not existXMLStreamException - if an error occurs when reading the XML filepublic String getDescription()+
getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<XmlIndentation>protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext)+
execution in class com.paypal.butterfly.extensions.api.TransformationUtility<XmlIndentation>Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/xml/class-use/XmlElement.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/xml/class-use/XmlElement.html new file mode 100644 index 00000000..ba27b4c8 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/xml/class-use/XmlElement.html @@ -0,0 +1,178 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.xml | +
+ Transformation utilities to gather meta-data about XML files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
XmlElement |
+XmlElement.setAttribute(String attribute)
+Set the name of the XML element attribute
+ to be retrieved.
+ |
+
XmlElement |
+XmlElement.setXmlElement(String xmlElement)
+The XML element whose value, or an attribute, should be
+ the result of this transformation utility.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/xml/class-use/XmlIndentation.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/xml/class-use/XmlIndentation.html new file mode 100644 index 00000000..186f67ea --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/xml/class-use/XmlIndentation.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/xml/package-frame.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/xml/package-frame.html new file mode 100644 index 00000000..ed65527d --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/xml/package-frame.html @@ -0,0 +1,22 @@ + + + + + + +See: Description
+| Class | +Description | +
|---|---|
| XmlElement | +
+ Retrieves the value of an element,
+ or one of its attributes, in a XML file.
+ |
+
| XmlIndentation | +
+ Utility to find out indentation usage in a given XML file.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/xml/package-tree.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/xml/package-tree.html new file mode 100644 index 00000000..9586d480 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/xml/package-tree.html @@ -0,0 +1,144 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/xml/package-use.html b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/xml/package-use.html new file mode 100644 index 00000000..ae9c6f6f --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/com/paypal/butterfly/utilities/xml/package-use.html @@ -0,0 +1,164 @@ + + + + + + +| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.xml | +
+ Transformation utilities to gather meta-data about XML files.
+ |
+
| Class and Description | +
|---|
| XmlElement
+ Retrieves the value of an element,
+ or one of its attributes, in a XML file.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/constant-values.html b/docs/javadocs/2.3.0/butterfly-utilities/constant-values.html new file mode 100644 index 00000000..2d26e357 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/constant-values.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/deprecated-list.html b/docs/javadocs/2.3.0/butterfly-utilities/deprecated-list.html new file mode 100644 index 00000000..a4a13abe --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/deprecated-list.html @@ -0,0 +1,148 @@ + + + + + + +| Class and Description | +
|---|
| com.paypal.butterfly.utilities.operations.pom.PomChangeParent | +
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/help-doc.html b/docs/javadocs/2.3.0/butterfly-utilities/help-doc.html new file mode 100644 index 00000000..eae750c8 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/help-doc.html @@ -0,0 +1,231 @@ + + + + + + +The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/index-all.html b/docs/javadocs/2.3.0/butterfly-utilities/index-all.html new file mode 100644 index 00000000..90d1bc2e --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/index-all.html @@ -0,0 +1,1786 @@ + + + + + + +CompilationUnit.JavaCondition.JavaCondition.JavaCondition.File reference to it, which is saved in the transformation
+ context.File reference to it, which is saved in the transformation
+ context.File reference to it, which is saved in the transformation
+ context.File objects and
+ a parent artifact, this transformation utility results in a sub-list of those pom.xml files containing only the ones
+ that are, directly or indirectly, a child of the specified parent artifact.File objects and
+ a parent artifact, results in a sub-list of those pom.xml files containing only the ones
+ that are, directly or indirectly, a child of the specified parent artifact.InsertLine.InsertionMode.REGEX_FIRST, unless already set
+ to InsertLine.InsertionMode.REGEX_ALL, InsertLine.InsertionMode.REGEX_BEFORE_FIRST
+ or InsertLine.InsertionMode.REGEX_BEFORE_ALL.InsertText.setInsertionMode(InsertionMode)String.format(String, Object...).Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/index.html b/docs/javadocs/2.3.0/butterfly-utilities/index.html new file mode 100644 index 00000000..14f84e17 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/index.html @@ -0,0 +1,76 @@ + + + + + + ++ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/overview-summary.html b/docs/javadocs/2.3.0/butterfly-utilities/overview-summary.html new file mode 100644 index 00000000..0ade5596 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/overview-summary.html @@ -0,0 +1,218 @@ + + + + + + +
| Package | +Description | +
|---|---|
| com.paypal.butterfly.utilities.conditions | +
+ Multiple transformation utility conditions, organized by type, each one having its own subpackage.
+ |
+
| com.paypal.butterfly.utilities.conditions.java | +
+ Transformation utility conditions to analyze and evaluate Java class files.
+ |
+
| com.paypal.butterfly.utilities.conditions.pom | +
+ Transformation utility conditions to analyze and evaluate Maven POM files.
+ |
+
| com.paypal.butterfly.utilities.file | +
+ Transformation utilities to gather meta-data, find and locate files.
+ |
+
| com.paypal.butterfly.utilities.java | +
+ Transformation utilities to gather meta-data about Java class files.
+ |
+
| com.paypal.butterfly.utilities.maven | +
+ Transformation utilities to gather meta-data about Maven POM files.
+ |
+
| com.paypal.butterfly.utilities.misc | +
+ Miscellaneous collection of transformation utilities.
+ |
+
| com.paypal.butterfly.utilities.operations.file | +
+ Transformation operations to manipulate files.
+ |
+
| com.paypal.butterfly.utilities.operations.pom | +
+ Transformation operations to manipulate Maven POM files.
+ |
+
| com.paypal.butterfly.utilities.operations.pom.stax | ++ |
| com.paypal.butterfly.utilities.operations.properties | +
+ Transformation operations to manipulate properties files.
+ |
+
| com.paypal.butterfly.utilities.operations.text | +
+ Transformation operations to manipulate text files.
+ |
+
| com.paypal.butterfly.utilities.text | +
+ Transformation utilities to gather meta-data about text files.
+ |
+
| com.paypal.butterfly.utilities.xml | +
+ Transformation utilities to gather meta-data about XML files.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/overview-tree.html b/docs/javadocs/2.3.0/butterfly-utilities/overview-tree.html new file mode 100644 index 00000000..f7828c49 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/overview-tree.html @@ -0,0 +1,275 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/javadocs/2.3.0/butterfly-utilities/package-list b/docs/javadocs/2.3.0/butterfly-utilities/package-list new file mode 100644 index 00000000..f78c1b23 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/package-list @@ -0,0 +1,14 @@ +com.paypal.butterfly.utilities.conditions +com.paypal.butterfly.utilities.conditions.java +com.paypal.butterfly.utilities.conditions.pom +com.paypal.butterfly.utilities.file +com.paypal.butterfly.utilities.java +com.paypal.butterfly.utilities.maven +com.paypal.butterfly.utilities.misc +com.paypal.butterfly.utilities.operations.file +com.paypal.butterfly.utilities.operations.pom +com.paypal.butterfly.utilities.operations.pom.stax +com.paypal.butterfly.utilities.operations.properties +com.paypal.butterfly.utilities.operations.text +com.paypal.butterfly.utilities.text +com.paypal.butterfly.utilities.xml diff --git a/docs/javadocs/2.3.0/butterfly-utilities/script.js b/docs/javadocs/2.3.0/butterfly-utilities/script.js new file mode 100644 index 00000000..b3463569 --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/docs/javadocs/2.3.0/butterfly-utilities/stylesheet.css b/docs/javadocs/2.3.0/butterfly-utilities/stylesheet.css new file mode 100644 index 00000000..c4f6312c --- /dev/null +++ b/docs/javadocs/2.3.0/butterfly-utilities/stylesheet.css @@ -0,0 +1,571 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#0085DC; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#0085DC; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#0085DC; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding:5px 12px 7px 12px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#0085DC; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#0085DC; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/pom.xml b/pom.xml index 65334233..71eeeeb2 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@