From b74c9c23a7aa62397d2f557c931687185e0ea5de Mon Sep 17 00:00:00 2001 From: facarvalho Date: Tue, 21 Dec 2021 09:52:02 -0300 Subject: [PATCH] Adding javadocs for version 3.2.1 --- .../allclasses-frame.html | 59 + .../allclasses-noframe.html | 59 + .../api/ContextAttributeRetriever.html | 411 +++ .../extensions/api/DoubleCondition.html | 461 ++++ .../extensions/api/ExecutionResult.html | 392 +++ .../butterfly/extensions/api/Extension.html | 427 +++ .../butterfly/extensions/api/FilterFiles.html | 531 ++++ .../api/MultipleConditions.Mode.html | 351 +++ .../extensions/api/MultipleConditions.html | 607 +++++ .../extensions/api/MultipleOperations.html | 638 +++++ .../extensions/api/PerformResult.Type.html | 382 +++ .../extensions/api/PerformResult.html | 561 ++++ .../extensions/api/SingleCondition.html | 284 ++ .../api/TOExecutionResult.Type.html | 381 +++ .../extensions/api/TOExecutionResult.html | 614 +++++ .../api/TUExecutionResult.Type.html | 368 +++ .../extensions/api/TUExecutionResult.html | 595 ++++ .../extensions/api/TransformationContext.html | 282 ++ .../api/TransformationOperation.html | 427 +++ .../api/TransformationTemplate.html | 823 ++++++ .../extensions/api/TransformationUtility.html | 1626 +++++++++++ .../api/TransformationUtilityGroup.html | 582 ++++ .../api/TransformationUtilityLoop.html | 661 +++++ .../extensions/api/UtilityCondition.html | 285 ++ .../ApplicationValidationException.html | 285 ++ .../api/exception/ButterflyException.html | 279 ++ .../exception/ButterflyRuntimeException.html | 284 ++ .../TemplateResolutionException.html | 300 ++ .../TransformationDefinitionException.html | 285 ++ .../TransformationOperationException.html | 293 ++ .../TransformationUtilityException.html | 291 ++ .../api/exception/package-frame.html | 26 + .../api/exception/package-summary.html | 194 ++ .../api/exception/package-tree.html | 162 ++ .../api/operations/AddElement.IfPresent.html | 397 +++ .../extensions/api/operations/AddElement.html | 357 +++ .../api/operations/AddElementTO.html | 471 ++++ .../ChangeOrRemoveElement.IfNotPresent.html | 367 +++ .../api/operations/ChangeOrRemoveElement.html | 313 +++ .../operations/ChangeOrRemoveElementTO.html | 421 +++ .../api/operations/package-frame.html | 31 + .../api/operations/package-summary.html | 211 ++ .../api/operations/package-tree.html | 162 ++ .../extensions/api/package-frame.html | 47 + .../extensions/api/package-summary.html | 317 +++ .../extensions/api/package-tree.html | 179 ++ .../extensions/api/upgrade/UpgradeStep.html | 380 +++ .../extensions/api/upgrade/package-frame.html | 20 + .../api/upgrade/package-summary.html | 156 ++ .../extensions/api/upgrade/package-tree.html | 139 + .../extensions/api/utilities/Abort.html | 407 +++ .../extensions/api/utilities/Log.html | 497 ++++ .../api/utilities/ManualInstruction.html | 405 +++ .../extensions/api/utilities/MapValue.html | 480 ++++ .../api/utilities/ResultCondition.html | 476 ++++ .../api/utilities/package-frame.html | 24 + .../api/utilities/package-summary.html | 181 ++ .../api/utilities/package-tree.html | 147 + .../constant-values.html | 170 ++ .../deprecated-list.html | 153 ++ .../butterfly-extensions-api/help-doc.html | 223 ++ .../butterfly-extensions-api/index-all.html | 1469 ++++++++++ .../3.2.1/butterfly-extensions-api/index.html | 75 + .../overview-frame.html | 25 + .../overview-summary.html | 163 ++ .../overview-tree.html | 229 ++ .../butterfly-extensions-api/package-list | 5 + .../3.2.1/butterfly-extensions-api/script.js | 30 + .../serialized-form.html | 165 ++ .../butterfly-extensions-api/stylesheet.css | 574 ++++ .../butterfly-utilities/allclasses-frame.html | 95 + .../allclasses-noframe.html | 95 + .../utilities/conditions/CompareFiles.html | 394 +++ .../utilities/conditions/CompareXMLFiles.html | 403 +++ .../utilities/conditions/FileExists.html | 334 +++ .../utilities/conditions/PropertyExists.html | 417 +++ .../utilities/conditions/RegexMatch.html | 400 +++ .../utilities/conditions/XmlXPathExists.html | 412 +++ .../conditions/java/AbstractTypeCheck.html | 347 +++ .../conditions/java/AnnotatedWith.html | 331 +++ .../utilities/conditions/java/Extends.html | 331 +++ .../conditions/java/JavaCondition.html | 342 +++ .../utilities/conditions/java/JavaMatch.html | 491 ++++ .../conditions/java/package-frame.html | 24 + .../conditions/java/package-summary.html | 187 ++ .../conditions/java/package-tree.html | 157 ++ .../utilities/conditions/package-frame.html | 25 + .../utilities/conditions/package-summary.html | 194 ++ .../utilities/conditions/package-tree.html | 156 ++ .../conditions/pom/PomDependencyExists.html | 462 ++++ .../conditions/pom/PomHasParent.html | 338 +++ .../conditions/pom/PomJavaMatch.html | 449 +++ .../conditions/pom/PomParentMatch.html | 462 ++++ .../conditions/pom/package-frame.html | 23 + .../conditions/pom/package-summary.html | 174 ++ .../conditions/pom/package-tree.html | 150 + .../butterfly/utilities/file/FindFile.html | 410 +++ .../butterfly/utilities/file/FindFiles.html | 754 ++++++ .../butterfly/utilities/file/LoadFile.html | 402 +++ .../butterfly/utilities/file/LocateFile.html | 410 +++ .../utilities/file/package-frame.html | 23 + .../utilities/file/package-summary.html | 177 ++ .../utilities/file/package-tree.html | 142 + .../butterfly/utilities/java/JavaPackage.html | 325 +++ .../utilities/java/package-frame.html | 20 + .../utilities/java/package-summary.html | 156 ++ .../utilities/java/package-tree.html | 139 + .../maven/EnforcerErrorsOutputHandler.html | 327 +++ .../maven/GenericErrorsOutputHandler.html | 327 +++ .../butterfly/utilities/maven/MavenGoal.html | 551 ++++ .../maven/MavenInvocationOutputHandler.html | 265 ++ .../utilities/maven/RelatedArtifacts.html | 463 ++++ .../utilities/maven/package-frame.html | 27 + .../utilities/maven/package-summary.html | 192 ++ .../utilities/maven/package-tree.html | 154 ++ .../butterfly/utilities/misc/RunScript.html | 486 ++++ .../utilities/misc/WebXmlContextParams.html | 330 +++ .../utilities/misc/package-frame.html | 21 + .../utilities/misc/package-summary.html | 163 ++ .../utilities/misc/package-tree.html | 140 + .../operations/AbstractToOperation.html | 563 ++++ .../utilities/operations/file/ApplyFile.html | 436 +++ .../utilities/operations/file/ApplyZip.html | 410 +++ .../operations/file/CopyDirectory.html | 361 +++ .../utilities/operations/file/CopyFile.html | 368 +++ .../utilities/operations/file/DeleteFile.html | 337 +++ .../operations/file/MoveDirectory.html | 359 +++ .../utilities/operations/file/MoveFile.html | 360 +++ .../utilities/operations/file/RenameFile.html | 384 +++ .../operations/file/package-frame.html | 27 + .../operations/file/package-summary.html | 200 ++ .../operations/file/package-tree.html | 154 ++ .../utilities/operations/package-frame.html | 20 + .../utilities/operations/package-summary.html | 165 ++ .../utilities/operations/package-tree.html | 143 + .../pom/AbstractStaxArtifactPomOperation.html | 565 ++++ .../operations/pom/PomAddDependency.html | 603 +++++ .../pom/PomAddManagedDependency.html | 607 +++++ .../operations/pom/PomAddModule.html | 556 ++++ .../operations/pom/PomAddParent.html | 603 +++++ .../operations/pom/PomAddPlugin.html | 583 ++++ .../operations/pom/PomAddProperty.html | 601 ++++ .../operations/pom/PomChangeDependency.html | 685 +++++ .../operations/pom/PomChangePackaging.html | 430 +++ .../operations/pom/PomChangeParent.html | 578 ++++ .../pom/PomChangeParentVersion.html | 539 ++++ .../operations/pom/PomChangePlugin.html | 749 +++++ .../operations/pom/PomCopyDependencies.html | 431 +++ .../pom/PomCopyManagedDependencies.html | 431 +++ .../utilities/operations/pom/PomFile.html | 508 ++++ .../operations/pom/PomRemoveDependency.html | 495 ++++ .../pom/PomRemoveDependencyExclusion.html | 493 ++++ .../pom/PomRemoveManagedDependency.html | 461 ++++ .../operations/pom/PomRemoveModule.html | 472 ++++ .../operations/pom/PomRemovePlugin.html | 495 ++++ .../operations/pom/PomRemoveProperty.html | 465 ++++ .../operations/pom/PomReplaceDependency.html | 638 +++++ .../operations/pom/package-frame.html | 41 + .../operations/pom/package-summary.html | 279 ++ .../operations/pom/package-tree.html | 183 ++ .../operations/properties/AddProperty.html | 412 +++ .../operations/properties/RemoveProperty.html | 387 +++ .../operations/properties/package-frame.html | 21 + .../properties/package-summary.html | 161 ++ .../operations/properties/package-tree.html | 144 + .../utilities/operations/text/AddLine.html | 392 +++ .../text/InsertLine.InsertionMode.html | 400 +++ .../utilities/operations/text/InsertLine.html | 574 ++++ .../text/InsertText.InsertionMode.html | 374 +++ .../utilities/operations/text/InsertText.html | 566 ++++ .../utilities/operations/text/RemoveLine.html | 466 ++++ .../operations/text/ReplaceLine.html | 533 ++++ .../operations/text/ReplaceText.html | 495 ++++ .../operations/text/package-frame.html | 30 + .../operations/text/package-summary.html | 218 ++ .../operations/text/package-tree.html | 165 ++ .../operations/xml/XmlXPathReplace.html | 481 ++++ .../operations/xml/package-frame.html | 20 + .../operations/xml/package-summary.html | 155 ++ .../operations/xml/package-tree.html | 143 + .../utilities/pom/AbstractPomGetUtility.html | 388 +++ .../utilities/pom/PomGetPackaging.html | 374 +++ .../butterfly/utilities/pom/PomGetParent.html | 380 +++ .../butterfly/utilities/pom/PomModel.html | 567 ++++ .../utilities/pom/package-frame.html | 23 + .../utilities/pom/package-summary.html | 160 ++ .../butterfly/utilities/pom/package-tree.html | 145 + .../utilities/text/StringFormat.html | 422 +++ .../utilities/text/package-frame.html | 20 + .../utilities/text/package-summary.html | 155 ++ .../utilities/text/package-tree.html | 139 + .../butterfly/utilities/xml/XmlElement.html | 460 ++++ .../utilities/xml/XmlIndentation.html | 360 +++ .../utilities/xml/XmlXPathRetrieve.html | 501 ++++ .../utilities/xml/package-frame.html | 22 + .../utilities/xml/package-summary.html | 165 ++ .../butterfly/utilities/xml/package-tree.html | 141 + .../butterfly-utilities/constant-values.html | 122 + .../butterfly-utilities/deprecated-list.html | 147 + .../3.2.1/butterfly-utilities/help-doc.html | 223 ++ .../3.2.1/butterfly-utilities/index-all.html | 2405 +++++++++++++++++ .../3.2.1/butterfly-utilities/index.html | 75 + .../butterfly-utilities/overview-frame.html | 36 + .../butterfly-utilities/overview-summary.html | 226 ++ .../butterfly-utilities/overview-tree.html | 299 ++ .../3.2.1/butterfly-utilities/package-list | 16 + .../3.2.1/butterfly-utilities/script.js | 30 + .../3.2.1/butterfly-utilities/stylesheet.css | 574 ++++ 208 files changed, 69159 insertions(+) create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/allclasses-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/allclasses-noframe.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/ContextAttributeRetriever.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/DoubleCondition.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/ExecutionResult.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/Extension.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/FilterFiles.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/MultipleConditions.Mode.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/MultipleConditions.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/MultipleOperations.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/PerformResult.Type.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/PerformResult.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/SingleCondition.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TOExecutionResult.Type.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TOExecutionResult.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TUExecutionResult.Type.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TUExecutionResult.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationContext.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationOperation.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationTemplate.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationUtility.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationUtilityGroup.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationUtilityLoop.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/UtilityCondition.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/ApplicationValidationException.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/ButterflyException.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/ButterflyRuntimeException.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TemplateResolutionException.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TransformationDefinitionException.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TransformationOperationException.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TransformationUtilityException.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/package-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/package-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/package-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/AddElement.IfPresent.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/AddElement.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/AddElementTO.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/ChangeOrRemoveElement.IfNotPresent.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/ChangeOrRemoveElement.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/ChangeOrRemoveElementTO.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/package-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/package-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/package-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/package-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/package-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/package-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/UpgradeStep.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/package-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/package-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/package-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/Abort.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/Log.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/ManualInstruction.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/MapValue.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/ResultCondition.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/package-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/package-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/package-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/constant-values.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/deprecated-list.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/help-doc.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/index-all.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/index.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/overview-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/overview-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/overview-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/package-list create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/script.js create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/serialized-form.html create mode 100644 docs/javadocs/3.2.1/butterfly-extensions-api/stylesheet.css create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/allclasses-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/allclasses-noframe.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/CompareFiles.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/CompareXMLFiles.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/FileExists.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/PropertyExists.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/RegexMatch.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/XmlXPathExists.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/AbstractTypeCheck.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/AnnotatedWith.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/Extends.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/JavaCondition.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/JavaMatch.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/package-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/package-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/package-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/package-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/package-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/package-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/PomDependencyExists.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/PomHasParent.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/PomJavaMatch.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/PomParentMatch.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/package-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/package-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/package-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/FindFile.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/FindFiles.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/LoadFile.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/LocateFile.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/package-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/package-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/package-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/java/JavaPackage.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/java/package-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/java/package-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/java/package-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/EnforcerErrorsOutputHandler.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/GenericErrorsOutputHandler.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/MavenGoal.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/MavenInvocationOutputHandler.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/RelatedArtifacts.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/package-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/package-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/package-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/misc/RunScript.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/misc/WebXmlContextParams.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/misc/package-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/misc/package-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/misc/package-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/AbstractToOperation.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/ApplyFile.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/ApplyZip.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/CopyDirectory.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/CopyFile.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/DeleteFile.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/MoveDirectory.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/MoveFile.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/RenameFile.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/package-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/package-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/package-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/package-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/package-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/package-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/AbstractStaxArtifactPomOperation.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddDependency.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddManagedDependency.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddModule.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddParent.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddPlugin.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddProperty.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangeDependency.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangePackaging.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangeParent.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangeParentVersion.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangePlugin.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomCopyDependencies.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomCopyManagedDependencies.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomFile.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveDependency.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveDependencyExclusion.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveManagedDependency.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveModule.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemovePlugin.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveProperty.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomReplaceDependency.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/package-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/package-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/package-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/AddProperty.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/RemoveProperty.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/package-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/package-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/package-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/AddLine.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertLine.InsertionMode.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertLine.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertText.InsertionMode.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertText.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/RemoveLine.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/ReplaceLine.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/ReplaceText.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/package-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/package-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/package-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/xml/XmlXPathReplace.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/xml/package-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/xml/package-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/xml/package-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/AbstractPomGetUtility.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/PomGetPackaging.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/PomGetParent.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/PomModel.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/package-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/package-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/package-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/text/StringFormat.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/text/package-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/text/package-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/text/package-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/XmlElement.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/XmlIndentation.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/XmlXPathRetrieve.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/package-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/package-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/package-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/constant-values.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/deprecated-list.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/help-doc.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/index-all.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/index.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/overview-frame.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/overview-summary.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/overview-tree.html create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/package-list create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/script.js create mode 100644 docs/javadocs/3.2.1/butterfly-utilities/stylesheet.css diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/allclasses-frame.html b/docs/javadocs/3.2.1/butterfly-extensions-api/allclasses-frame.html new file mode 100644 index 00000000..8bd030ad --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/allclasses-frame.html @@ -0,0 +1,59 @@ + + + + + +All Classes (butterfly-extensions-api 3.2.1 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/allclasses-noframe.html b/docs/javadocs/3.2.1/butterfly-extensions-api/allclasses-noframe.html new file mode 100644 index 00000000..29bb28bf --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/allclasses-noframe.html @@ -0,0 +1,59 @@ + + + + + +All Classes (butterfly-extensions-api 3.2.1 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/ContextAttributeRetriever.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/ContextAttributeRetriever.html new file mode 100644 index 00000000..9e35d17e --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/ContextAttributeRetriever.html @@ -0,0 +1,411 @@ + + + + + +ContextAttributeRetriever (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api
+

Class ContextAttributeRetriever<T>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class ContextAttributeRetriever<T>
+extends TransformationUtility
    +
    Transformation utility to fetch transformation context attributes post + transformation time, since they are always set + during transformation time. +
    + An example of usage of this feature would be implementing + 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).
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ContextAttributeRetriever

        +
        public ContextAttributeRetriever()
        +
        • +
      + + + +
        +
      • +

        ContextAttributeRetriever

        +
        public ContextAttributeRetriever(java.lang.String attributeName)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setAttributeName

        +
        public void setAttributeName(java.lang.String attributeName)
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        Description copied from class: TransformationUtility
        +
        Returns a short one line, but SPECIFIC, description about the transformation + utility, including mentioning the files and/or folders + to be manipulated. This is supposed to be an one line statement about the + specific transformation utility that was executed. This would be used for example in + log statements or user interfaces.
        +
        +
        Specified by:
        +
        getDescription in class TransformationUtility
        +
        Returns:
        +
        a short one line, but specific, description about the transformation + utility
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected ExecutionResult execution(java.io.File transformedAppFolder,
+                                    TransformationContext transformationContext)
        +
        Description copied from class: TransformationUtility
        +
        The implementation execution of this transformation utility. + The returned object is the result of the execution and is always + automatically saved in the transformation context as a new + attribute (whose key is the name of the transformation utility), unless + TransformationUtility.isSaveResult() returns false. +
        + Important: this method MUST NEVER return null, and it must catch its executions exceptions + and wrap them into a ExecutionResult error object.
        +
        +
        Specified by:
        +
        execution in class TransformationUtility
        +
        Parameters:
        +
        transformedAppFolder - the folder where the transformed application code is
        +
        transformationContext - the transformation context object
        +
        Returns:
        +
        an object with the result of this execution, to be better defined + by the concrete utility class, since its type is generic
        +
        +
        • +
      + + + +
        +
      • +

        getAttributeValue

        +
        public T getAttributeValue()
        +
        Returns the value of the transformation context attribute + specified earlier. If the attribute value is null, null is returned. + If this method is called prior to the execution of this transformation + utility, an IllegalStateException is thrown.
        +
        +
        Returns:
        +
        the value of the transformation context attribute specified earlier
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/DoubleCondition.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/DoubleCondition.html new file mode 100644 index 00000000..fb019e03 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/DoubleCondition.html @@ -0,0 +1,461 @@ + + + + + +DoubleCondition (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api
+

Class DoubleCondition<T extends DoubleCondition>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public abstract class DoubleCondition<T extends DoubleCondition>
+extends UtilityCondition<T>
    +
    Transformation utility condition to determine if a transformation utility + should be executed or not, based on a two files criteria. Every + 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 +
    + Important: it returns true if both files don't exist, + and it returns false if only one of them exists.
    +
    +
    See Also:
    +
    SingleCondition, +MultipleConditions
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DoubleCondition

        +
        public DoubleCondition()
        +
        Condition to determine if a transformation utility + should be executed or not. Every + 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)
        +
        • +
      + + + +
        +
      • +

        DoubleCondition

        +
        public DoubleCondition(java.lang.String attribute)
        +
        Condition to determine if a transformation utility + should be executed or not. Every + 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)
        +
        +
        Parameters:
        +
        attribute - the name of the transformation context attribute + that refers to the file to be compared against the baseline file
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAttribute

        +
        public java.lang.String getAttribute()
        +
        Return the name of the transformation context attribute + that refers to the file to be compared against the + baseline file
        +
        +
        Returns:
        +
        the name of the transformation context attribute + that refers to the file to be compared against the + baseline file
        +
        +
        • +
      + + + +
        +
      • +

        setAttribute

        +
        public T setAttribute(java.lang.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)
        +
        +
        Parameters:
        +
        attribute - the name of the transformation context attribute + that refers to the file to be compared against the baseline file
        +
        Returns:
        +
        this utility condition instance
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected TUExecutionResult execution(java.io.File transformedAppFolder,
+                                      TransformationContext transformationContext)
        +
        Description copied from class: TransformationUtility
        +
        The implementation execution of this transformation utility. + The returned object is the result of the execution and is always + automatically saved in the transformation context as a new + attribute (whose key is the name of the transformation utility), unless + TransformationUtility.isSaveResult() returns false. +
        + Important: this method MUST NEVER return null, and it must catch its executions exceptions + and wrap them into a ExecutionResult error object.
        +
        +
        Specified by:
        +
        execution in class TransformationUtility<T extends DoubleCondition>
        +
        Parameters:
        +
        transformedAppFolder - the folder where the transformed application code is
        +
        transformationContext - the transformation context object
        +
        Returns:
        +
        an object with the result of this execution, to be better defined + by the concrete utility class, since its type is generic
        +
        +
        • +
      + + + +
        +
      • +

        compare

        +
        protected abstract boolean compare(java.io.File baselineFile,
+                                   java.io.File comparisonFile)
        +
        Returns true only if the compared files meet the comparison + criteria established and implemented by the subclass
        +
        +
        Parameters:
        +
        baselineFile - the baseline file used for comparison
        +
        comparisonFile - the file to be compared against the baseline file
        +
        Returns:
        +
        this utility condition instance
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/ExecutionResult.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/ExecutionResult.html new file mode 100644 index 00000000..64992797 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/ExecutionResult.html @@ -0,0 +1,392 @@ + + + + + +ExecutionResult (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.paypal.butterfly.extensions.api
+

Class ExecutionResult<S,R,T>

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        setType

        +
        protected R setType(T arg0)
        +
        • +
      + + + +
        +
      • +

        setDetails

        +
        public R setDetails(java.lang.String arg0)
        +
        • +
      + + + +
        +
      • +

        setException

        +
        protected R setException(java.lang.Exception arg0)
        +
        • +
      + + + +
        +
      • +

        addWarning

        +
        public R addWarning(java.lang.Exception arg0)
        +
        • +
      + + + +
        +
      • +

        changeTypeOnWarning

        +
        protected abstract void changeTypeOnWarning()
        +
        • +
      + + + +
        +
      • +

        isExceptionType

        +
        protected abstract boolean isExceptionType()
        +
        • +
      + + + +
        +
      • +

        dependencyFailureCheck

        +
        protected abstract boolean dependencyFailureCheck()
        +
        • +
      + + + +
        +
      • +

        getSource

        +
        public S getSource()
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public T getType()
        +
        • +
      + + + +
        +
      • +

        getDetails

        +
        public java.lang.String getDetails()
        +
        • +
      + + + +
        +
      • +

        getException

        +
        public java.lang.Exception getException()
        +
        • +
      + + + +
        +
      • +

        getWarnings

        +
        public java.util.List<java.lang.Exception> getWarnings()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/Extension.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/Extension.html new file mode 100644 index 00000000..e1706668 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/Extension.html @@ -0,0 +1,427 @@ + + + + + +Extension (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api
+

Class Extension<E>

+
+
+ +
+
    +
  • +
    +
    +
    public abstract class Extension<E>
+extends java.lang.Object
    +
    A Butterfly third-party extension. It provides custom + transformation templates and validations
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Extension() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected Eadd(java.lang.Class<? extends TransformationTemplate> templateClass) +
      Adds a new transformation template class to the set
      +
      java.util.Optional<java.lang.Class<? extends TransformationTemplate>>automaticResolution(java.io.File applicationFolder) +
      Butterfly might be able to automatically identify the type of application + and which transformation template to be applied to it.
      +
      abstract java.lang.StringgetDescription() +
      Returns the extension description
      +
      protected org.apache.maven.model.ModelgetRootPomFile(java.io.File folder) +
      This is a convenience method in case the Extension subclass wants to implement its + automaticResolution(File) method based on one or more Maven pom files
      +
      java.util.List<java.lang.Class<? extends TransformationTemplate>>getTemplateClasses() +
      Returns a read-only set containing all transformation template classes
      +
      abstract java.lang.StringgetVersion() +
      Returns the extension version
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        Extension

        +
        public Extension()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        add

        +
        protected final E add(java.lang.Class<? extends TransformationTemplate> templateClass)
        +
        Adds a new transformation template class to the set
        +
        +
        Parameters:
        +
        templateClass - the transformation template class to be added to the extension
        +
        Returns:
        +
        this extension
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public abstract java.lang.String getDescription()
        +
        Returns the extension description
        +
        +
        Returns:
        +
        the extension description
        +
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        public abstract java.lang.String getVersion()
        +
        Returns the extension version
        +
        +
        Returns:
        +
        the extension version
        +
        +
        • +
      + + + +
        +
      • +

        getTemplateClasses

        +
        public final java.util.List<java.lang.Class<? extends TransformationTemplate>> getTemplateClasses()
        +
        Returns a read-only set containing all transformation template classes
        +
        +
        Returns:
        +
        a read-only set containing all transformation template classes
        +
        +
        • +
      + + + +
        +
      • +

        automaticResolution

        +
        public java.util.Optional<java.lang.Class<? extends TransformationTemplate>> automaticResolution(java.io.File applicationFolder)
+                                                                                          throws TemplateResolutionException
        +
        Butterfly might be able to automatically identify the type of application + and which transformation template to be applied to it. This automatic + transformation template resolution is actually performed by each registered + Extension class. Based on the application folder, and its content, each + registered extension might decide which transformation template should be used + to transform it. These are the possible resolution results: +
          +
        1. Empty optional is returned: if application type is not recognized as a known and supported type by the extension
          2. +
        2. An optional with TransformationTemplate class is returned: if application type is recognized and application is valid
          3. +
        3. A TemplateResolutionException exception is thrown: if the application type is recognized as a known and supported type + (based on most of its folders and files structure and content), however, the extension identifies it as invalid for specific reasons, + (for missing a required file for example, having an invalid property version, etc). Call Throwable.getMessage() for details. +
        +
        + Notice the difference between "not recognized" and "invalid" can be vague and arbitrary. + It is entirely up to the extension to define its own criteria and communicate it with the application owners.
        +
        +
        Parameters:
        +
        applicationFolder - the folder where the code of the application to be transformed is
        +
        Returns:
        +
        see above
        +
        Throws:
        +
        TemplateResolutionException - see above
        +
        +
        • +
      + + + +
        +
      • +

        getRootPomFile

        +
        protected org.apache.maven.model.Model getRootPomFile(java.io.File folder)
+                                               throws java.io.IOException,
+                                                      org.codehaus.plexus.util.xml.pull.XmlPullParserException
        +
        This is a convenience method in case the Extension subclass wants to implement its + automaticResolution(File) method based on one or more Maven pom files
        +
        +
        Parameters:
        +
        folder - the folder where the pom.xml file would be
        +
        Returns:
        +
        the Model object related to the pom.xml file under folder
        +
        Throws:
        +
        java.io.IOException - if pom file does not exist, or any error happens when trying to read it
        +
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - if any error happens when trying to parse the pom file
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/FilterFiles.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/FilterFiles.html new file mode 100644 index 00000000..ff85b511 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/FilterFiles.html @@ -0,0 +1,531 @@ + + + + + +FilterFiles (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api
+

Class FilterFiles

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class FilterFiles
+extends TransformationUtility<FilterFiles>
    +
    Transformation utility to filter a list of files based on a given + SingleCondition, + returning in a sub-list of files.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FilterFiles

        +
        public FilterFiles()
        +
        Utility to filter a list of files based on a given + SingleCondition, + returning in a sub-list of files
        +
        • +
      + + + +
        +
      • +

        FilterFiles

        +
        public FilterFiles(SingleCondition conditionTemplate)
        +
        Utility to filter a list of files based on a given + SingleCondition, + returning in a sub-list of files
        +
        +
        Parameters:
        +
        conditionTemplate - the single condition template to be evaluated against all files
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setFiles

        +
        public FilterFiles setFiles(java.lang.String... filesAttributes)
        +
        Sets one or more transformation context attributes that hold list of Files + which the single condition should be evaluated against. + If more than one attribute is specified, all list of files will be + combined into a single one
        +
        +
        Parameters:
        +
        filesAttributes - one or more transformation context attributes that hold list + of Files which the condition should be evaluated against
        +
        Returns:
        +
        this transformation utility object
        +
        +
        • +
      + + + +
        +
      • +

        setConditionTemplate

        +
        public FilterFiles setConditionTemplate(SingleCondition conditionTemplate)
        +
        Set the single condition template to be evaluated against all files
        +
        +
        Parameters:
        +
        conditionTemplate - the single condition template to be evaluated against all files
        +
        Returns:
        +
        this transformation utility object
        +
        +
        • +
      + + + +
        +
      • +

        setName

        +
        protected FilterFiles setName(java.lang.String name)
        +
        Description copied from class: TransformationUtility
        +
        Set this transformation utility instance name. + If not set, a default name will be assigned at the + time it is added to a parent.
        +
        +
        Overrides:
        +
        setName in class TransformationUtility<FilterFiles>
        +
        Parameters:
        +
        name - transformation utility instance name
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        Description copied from class: TransformationUtility
        +
        Returns a short one line, but SPECIFIC, description about the transformation + utility, including mentioning the files and/or folders + to be manipulated. This is supposed to be an one line statement about the + specific transformation utility that was executed. This would be used for example in + log statements or user interfaces.
        +
        +
        Specified by:
        +
        getDescription in class TransformationUtility<FilterFiles>
        +
        Returns:
        +
        a short one line, but specific, description about the transformation + utility
        +
        +
        • +
      + + + +
        +
      • +

        getFilesAttributes

        +
        public java.lang.String[] getFilesAttributes()
        +
        Return an array containing the name of transformation context attributes + that hold the list of files to be filtered
        +
        +
        Returns:
        +
        an array containing the name of transformation context attributes + that hold the list of files to be filtered
        +
        +
        • +
      + + + +
        +
      • +

        getConditionTemplate

        +
        public SingleCondition getConditionTemplate()
        +
        Return the single condition template to be evaluated against all files
        +
        +
        Returns:
        +
        the single condition template to be evaluated against all files
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected TUExecutionResult execution(java.io.File transformedAppFolder,
+                                      TransformationContext transformationContext)
        +
        Description copied from class: TransformationUtility
        +
        The implementation execution of this transformation utility. + The returned object is the result of the execution and is always + automatically saved in the transformation context as a new + attribute (whose key is the name of the transformation utility), unless + TransformationUtility.isSaveResult() returns false. +
        + Important: this method MUST NEVER return null, and it must catch its executions exceptions + and wrap them into a ExecutionResult error object.
        +
        +
        Specified by:
        +
        execution in class TransformationUtility<FilterFiles>
        +
        Parameters:
        +
        transformedAppFolder - the folder where the transformed application code is
        +
        transformationContext - the transformation context object
        +
        Returns:
        +
        an object with the result of this execution, to be better defined + by the concrete utility class, since its type is generic
        +
        +
        • +
      + + + +
        +
      • +

        newConditionInstance

        +
        public SingleCondition newConditionInstance(java.io.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
        +
        +
        Parameters:
        +
        file - the actual file to be performed against
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/MultipleConditions.Mode.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/MultipleConditions.Mode.html new file mode 100644 index 00000000..56696bdd --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/MultipleConditions.Mode.html @@ -0,0 +1,351 @@ + + + + + +MultipleConditions.Mode (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api
+

Enum MultipleConditions.Mode

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + +
      Enum Constants 
      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.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static MultipleConditions.ModevalueOf(java.lang.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.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static MultipleConditions.Mode[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (MultipleConditions.Mode c : MultipleConditions.Mode.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static MultipleConditions.Mode valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/MultipleConditions.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/MultipleConditions.html new file mode 100644 index 00000000..e1e8b300 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/MultipleConditions.html @@ -0,0 +1,607 @@ + + + + + +MultipleConditions (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api
+

Class MultipleConditions

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class MultipleConditions
+extends UtilityCondition<MultipleConditions>
    +
    Transformation utility condition to determine if a transformation utility should be executed or not, + based on a multiple files criteria. + It performs condition instances based on a 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 +
    + Note 1: if an evaluation against a specific file fails for any reason, then the + overall evaluation will be interrupted and result also in a failure. + Note 2: if the utility condition object (to be executed against the specified files) + has conditions, they will be ignored.
    +
    +
    See Also:
    +
    setMode(Mode), +SingleCondition, +DoubleCondition
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MultipleConditions

        +
        public MultipleConditions(SingleCondition conditionTemplate)
        +
        Perform one transformation utility condition 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 MultipleConditions
        +
        +
        Parameters:
        +
        conditionTemplate - the utility condition template used to create conditions, + used to be evaluated against the list of files
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setMode

        +
        public MultipleConditions setMode(MultipleConditions.Mode mode)
        +
        Set the evaluation mode. The default mode is "at least one", + which means the result will be true if at least one file + meets the condition. The alternative mode is "all", which + requires all files to meet the evaluation condition to result + in true.
        +
        +
        Parameters:
        +
        mode - the evaluation mode
        +
        Returns:
        +
        this utility condition instance
        +
        +
        • +
      + + + +
        +
      • +

        setFiles

        +
        public MultipleConditions setFiles(java.lang.String... filesAttributes)
        +
        Sets one or more transformation context attributes that hold list of Files + which the condition should perform against. + If more than one attribute is specified, all list of files will be + combined into a single one.
        +
        +
        Parameters:
        +
        filesAttributes - one or more transformation context attributes that hold list + of Files which the condition should perform + against
        +
        Returns:
        +
        this transformation utility object
        +
        +
        • +
      + + + +
        +
      • +

        setConditionTemplate

        +
        public MultipleConditions setConditionTemplate(SingleCondition conditionTemplate)
        +
        Set the utility condition template used to create conditions + to be evaluated against the list of files
        +
        +
        Parameters:
        +
        conditionTemplate - the utility condition template used to create conditions + to be evaluated against the list of files
        +
        Returns:
        +
        this utility condition instance
        +
        +
        • +
      + + + +
        +
      • +

        setName

        +
        public MultipleConditions setName(java.lang.String name)
        +
        Description copied from class: TransformationUtility
        +
        Set this transformation utility instance name. + If not set, a default name will be assigned at the + time it is added to a parent.
        +
        +
        Overrides:
        +
        setName in class TransformationUtility<MultipleConditions>
        +
        Parameters:
        +
        name - transformation utility instance name
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        getMode

        +
        public MultipleConditions.Mode getMode()
        +
        Return the evaluation mode
        +
        +
        Returns:
        +
        the evaluation mode
        +
        +
        • +
      + + + +
        +
      • +

        getFilesAttributes

        +
        public java.lang.String[] getFilesAttributes()
        +
        A copy of the array of transformation context attributes that hold list of Files + which the condition should perform against.
        +
        +
        Returns:
        +
        a copy of the array of transformation context attributes that hold list of Files + which the condition should perform against
        +
        +
        • +
      + + + +
        +
      • +

        getConditionTemplate

        +
        public SingleCondition getConditionTemplate()
        +
        Return the condition template
        +
        +
        Returns:
        +
        the condition template
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        Description copied from class: TransformationUtility
        +
        Returns a short one line, but SPECIFIC, description about the transformation + utility, including mentioning the files and/or folders + to be manipulated. This is supposed to be an one line statement about the + specific transformation utility that was executed. This would be used for example in + log statements or user interfaces.
        +
        +
        Specified by:
        +
        getDescription in class TransformationUtility<MultipleConditions>
        +
        Returns:
        +
        a short one line, but specific, description about the transformation + utility
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected TUExecutionResult execution(java.io.File transformedAppFolder,
+                                      TransformationContext transformationContext)
        +
        Description copied from class: TransformationUtility
        +
        The implementation execution of this transformation utility. + The returned object is the result of the execution and is always + automatically saved in the transformation context as a new + attribute (whose key is the name of the transformation utility), unless + TransformationUtility.isSaveResult() returns false. +
        + Important: this method MUST NEVER return null, and it must catch its executions exceptions + and wrap them into a ExecutionResult error object.
        +
        +
        Specified by:
        +
        execution in class TransformationUtility<MultipleConditions>
        +
        Parameters:
        +
        transformedAppFolder - the folder where the transformed application code is
        +
        transformationContext - the transformation context object
        +
        Returns:
        +
        an object with the result of this execution, to be better defined + by the concrete utility class, since its type is generic
        +
        +
        • +
      + + + +
        +
      • +

        newConditionInstance

        +
        public UtilityCondition newConditionInstance(java.io.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
        +
        +
        Parameters:
        +
        file - the actual file to be performed against
        +
        Returns:
        +
        the new utility condition created based on this instance
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/MultipleOperations.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/MultipleOperations.html new file mode 100644 index 00000000..6228505a --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/MultipleOperations.html @@ -0,0 +1,638 @@ + + + + + +MultipleOperations (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api
+

Class MultipleOperations

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.paypal.butterfly.extensions.api.TransformationUtilityParent, java.lang.Cloneable
    +
    +
    +
    +
    public class MultipleOperations
+extends TransformationUtility<MultipleOperations>
+implements com.paypal.butterfly.extensions.api.TransformationUtilityParent
    +
    Transformation utility to perform multiple transformation operations. Multiple transformation operations + are defined based on an operation template and two other factors, that could be applied + exclusively or together. They are: +
      +
    1. Multiple files: multiple operations are defined based on multiple files specified as a + list, held as one or more transformation context attribute, and set via setFiles(String...)
      2. +
    2. Multiple configurations: multiple operations are defined based on different configurations, + set via setProperties(String, String)
      3. +
    +
    + In other words, there are two possible ways to define multiple operations: multiple + files, or multiple configurations (different property values). It is also possible + to combine both, resulting in multiple operations to be executed against multiple files and + with multiple configurations. +
    + Important: when running against multiple files, any path set to this operation, + either relative or absolute, will be ignored, and set later at transformation time based on + the dynamically set multiple files. When running with multiple configurations, the properties set + during transformation time will override any value that could have been set during definition time
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MultipleOperations

        +
        public MultipleOperations()
        +
        Utility to perform multiple transformation operations. Multiple transformation operations + are defined based on an operation template and two other factors, that could be applied + exclusively or together. They are: +
          +
        1. Multiple files: multiple operations are defined based on multiple files specified as a + list, held as one or more transformation context attribute, and set via setFiles(String...)
          2. +
        2. Multiple configurations: multiple operations are defined based on different configurations, + set via setProperties(String, String)
          3. +
        +
        + In other words, there are two possible ways to define multiple operations: multiple + files, or multiple configurations (different property values). It is also possible + to combine both, resulting in multiple operations to be executed against multiple files and + with multiple configurations. +
        + Important: when running against multiple files, any path set to this operation, + either relative or absolute, will be ignored, and set later at transformation time based on + the dynamically set multiple files. When running with multiple configurations, the properties set + during transformation time will override any value that could have been set during definition time
        +
        • +
      + + + +
        +
      • +

        MultipleOperations

        +
        public MultipleOperations(TransformationOperation templateOperation)
        +
        Utility to perform multiple transformation operations. Multiple transformation operations + are defined based on an operation template and two other factors, that could be applied + exclusively or together. They are: +
          +
        1. Multiple files: multiple operations are defined based on multiple files specified as a + list, held as one or more transformation context attribute, and set via setFiles(String...)
          2. +
        2. Multiple configurations: multiple operations are defined based on different configurations, + set via setProperties(String, String)
          3. +
        +
        + In other words, there are two possible ways to define multiple operations: multiple + files, or multiple configurations (different property values). It is also possible + to combine both, resulting in multiple operations to be executed against multiple files and + with multiple configurations. +
        + Important: when running against multiple files, any path set to this operation, + either relative or absolute, will be ignored, and set later at transformation time based on + the dynamically set multiple files. When running with multiple configurations, the properties set + during transformation time will override any value that could have been set during definition time
        +
        +
        Parameters:
        +
        templateOperation - a template of transformation operation to be performed + against all specified files
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setFiles

        +
        public MultipleOperations setFiles(java.lang.String... filesAttributes)
        +
        Sets one or more transformation context attributes that hold list of Files + which the transformation operations should perform against. + If more than one attribute is specified, all list of files will be + combined into a single one
        +
        +
        Parameters:
        +
        filesAttributes - one or more transformation context attributes that hold list + of Files which the transformation operation should perform + against
        +
        Returns:
        +
        this transformation utility object
        +
        +
        • +
      + + + +
        +
      • +

        setProperties

        +
        public final MultipleOperations setProperties(java.lang.String propertyName,
+                                              java.lang.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. +
        + That being said, calling this method will only make a difference if this operation is executed as the + template operation for a multiple operations utility. That usually can be done by adding it to a + transformation template via TransformationTemplate.addMultiple(TransformationOperation, String...)
        +
        +
        Parameters:
        +
        propertyName - the operation Java bean property name to be set during transformation time
        +
        propertyAttribute - 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 execution
        +
        Returns:
        +
        this instance
        +
        +
        • +
      + + + +
        +
      • +

        setOperationTemplate

        +
        public MultipleOperations setOperationTemplate(TransformationOperation templateOperation)
        +
        Sets the template of transformation operation to be performed against all specified files. +
        + Important: any path set to this operation, either relative + or absolute, will be ignored, and set later at transformation time based on + the dynamically set multiple files
        +
        +
        Parameters:
        +
        templateOperation - the template of transformation operation to be performed against + all specified files
        +
        Returns:
        +
        this transformation utility object
        +
        +
        • +
      + + + +
        +
      • +

        setName

        +
        public MultipleOperations setName(java.lang.String name)
        +
        Description copied from class: TransformationUtility
        +
        Set this transformation utility instance name. + If not set, a default name will be assigned at the + time it is added to a parent.
        +
        +
        Overrides:
        +
        setName in class TransformationUtility<MultipleOperations>
        +
        Parameters:
        +
        name - transformation utility instance name
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        getFilesAttributes

        +
        public java.lang.String[] getFilesAttributes()
        +
        Return an array containing the name of transformation context attributes + that hold the list of files the operations should be performed against
        +
        +
        Returns:
        +
        an array containing the name of transformation context attributes + that hold the list of files the operations should be performed against
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        Description copied from class: TransformationUtility
        +
        Returns a short one line, but SPECIFIC, description about the transformation + utility, including mentioning the files and/or folders + to be manipulated. This is supposed to be an one line statement about the + specific transformation utility that was executed. This would be used for example in + log statements or user interfaces.
        +
        +
        Specified by:
        +
        getDescription in class TransformationUtility<MultipleOperations>
        +
        Returns:
        +
        a short one line, but specific, description about the transformation + utility
        +
        +
        • +
      + + + +
        +
      • +

        setPropertySetter

        +
        public void setPropertySetter()
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected TUExecutionResult execution(java.io.File transformedAppFolder,
+                                      TransformationContext transformationContext)
        +
        Description copied from class: TransformationUtility
        +
        The implementation execution of this transformation utility. + The returned object is the result of the execution and is always + automatically saved in the transformation context as a new + attribute (whose key is the name of the transformation utility), unless + TransformationUtility.isSaveResult() returns false. +
        + Important: this method MUST NEVER return null, and it must catch its executions exceptions + and wrap them into a ExecutionResult error object.
        +
        +
        Specified by:
        +
        execution in class TransformationUtility<MultipleOperations>
        +
        Parameters:
        +
        transformedAppFolder - the folder where the transformed application code is
        +
        transformationContext - the transformation context object
        +
        Returns:
        +
        an object with the result of this execution, to be better defined + by the concrete utility class, since its type is generic
        +
        +
        • +
      + + + +
        +
      • +

        getChildren

        +
        public java.util.List<TransformationUtility> getChildren()
        +
        Returns all TransformationOperation instances generated out of the + transformation operation template. + Those instances though are not accessible during transformation definition time, + neither before this multiple operations is performed. + Actually, the purpose of a multiple operation is exactly to generate + all children transformation operation instances, which get them executed behind the scenes + by the transformation engine.
        +
        +
        Specified by:
        +
        getChildren in interface com.paypal.butterfly.extensions.api.TransformationUtilityParent
        +
        Returns:
        +
        the generated multiple transformation operation instances, based on the specified + transformation operation template
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/PerformResult.Type.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/PerformResult.Type.html new file mode 100644 index 00000000..a7a23542 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/PerformResult.Type.html @@ -0,0 +1,382 @@ + + + + + +PerformResult.Type (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api
+

Enum PerformResult.Type

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + +
      Enum Constants 
      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.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static PerformResult.TypevalueOf(java.lang.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.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        EXECUTION_RESULT

        +
        public static final PerformResult.Type EXECUTION_RESULT
        +
        The result type is defined based on the utility execution result type.
        +
        • +
      + + + + + + + +
        +
      • +

        SKIPPED_DEPENDENCY

        +
        public static final PerformResult.Type SKIPPED_DEPENDENCY
        +
        The TU depends on one or more TUs, and at least one of them didn't result in SUCCESS.
        +
        • +
      + + + +
        +
      • +

        ERROR

        +
        public static final PerformResult.Type ERROR
        +
        The TU failed, but not because of its utility execution itself, but because of an internal reason. + For example, when a TransformationUtilityException is thrown because the absolute file + the TU should execute against could not be resolved during transformation time.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static PerformResult.Type[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (PerformResult.Type c : PerformResult.Type.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static PerformResult.Type valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/PerformResult.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/PerformResult.html new file mode 100644 index 00000000..aa99b4a8 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/PerformResult.html @@ -0,0 +1,561 @@ + + + + + +PerformResult (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.paypal.butterfly.extensions.api
+

Class PerformResult

+
+
+ +
+
    +
  • +
    +
    +
    public class PerformResult
+extends java.lang.Object
    +
    The meta-data object resulted after the TransformationUtility instance has been performed.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + + + + + +
        +
      • +

        error

        +
        public static PerformResult error(TransformationUtility transformationUtility,
+                                  java.lang.Exception exception,
+                                  java.lang.String details)
        +
        This means The TU failed, but not because of its utility execution itself, but because of an internal reason. + For example, when a TransformationOperationException is thrown because the absolute file the TU should execute + against could not be resolved during transformation time
        +
        +
        Parameters:
        +
        transformationUtility - the TransformationUtility object that produced this result
        +
        exception - the exception to be registered to the result object
        +
        details - details about the result
        +
        Returns:
        +
        the created PerformResult object of type PerformResult.Type.ERROR
        +
        +
        • +
      + + + +
        +
      • +

        error

        +
        public static PerformResult error(TransformationUtility transformationUtility,
+                                  java.lang.Exception exception)
        +
        This means The TU failed, but not because of its utility execution itself, but because of an internal reason. + For example, when a TransformationOperationException is thrown because the absolute file the TU should execute + against could not be resolved during transformation time
        +
        +
        Parameters:
        +
        transformationUtility - the TransformationUtility object that produced this result
        +
        exception - the exception to be registered to the result object
        +
        Returns:
        +
        the created PerformResult object of type PerformResult.Type.ERROR
        +
        +
        • +
      + + + +
        +
      • +

        changeTypeOnWarning

        +
        protected void changeTypeOnWarning()
        +
        • +
      + + + + + + + +
        +
      • +

        isExceptionType

        +
        protected boolean isExceptionType()
        +
        • +
      + + + +
        +
      • +

        dependencyFailureCheck

        +
        protected boolean dependencyFailureCheck()
        +
        • +
      + + + + + +
        +
      • +

        setType

        +
        protected R setType(T arg0)
        +
        • +
      + + + +
        +
      • +

        setDetails

        +
        public R setDetails(java.lang.String arg0)
        +
        • +
      + + + +
        +
      • +

        setException

        +
        protected R setException(java.lang.Exception arg0)
        +
        • +
      + + + +
        +
      • +

        addWarning

        +
        public R addWarning(java.lang.Exception arg0)
        +
        • +
      + + + +
        +
      • +

        getSource

        +
        public S getSource()
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public T getType()
        +
        • +
      + + + +
        +
      • +

        getDetails

        +
        public java.lang.String getDetails()
        +
        • +
      + + + +
        +
      • +

        getException

        +
        public java.lang.Exception getException()
        +
        • +
      + + + +
        +
      • +

        getWarnings

        +
        public java.util.List<java.lang.Exception> getWarnings()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/SingleCondition.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/SingleCondition.html new file mode 100644 index 00000000..f05225f4 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/SingleCondition.html @@ -0,0 +1,284 @@ + + + + + +SingleCondition (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.paypal.butterfly.extensions.api
+

Class SingleCondition<T extends SingleCondition>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public abstract class SingleCondition<T extends SingleCondition>
+extends UtilityCondition<T>
    +
    Transformation utility condition to determine if a transformation utility + should be executed or not, based on an one file criteria. Every + 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 MultipleConditions
    +
    +
    See Also:
    +
    DoubleCondition, +MultipleConditions
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SingleCondition

        +
        public SingleCondition()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TOExecutionResult.Type.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TOExecutionResult.Type.html new file mode 100644 index 00000000..0365a2b5 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TOExecutionResult.Type.html @@ -0,0 +1,381 @@ + + + + + +TOExecutionResult.Type (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api
+

Enum TOExecutionResult.Type

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + +
      Enum Constants 
      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.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static TOExecutionResult.TypevalueOf(java.lang.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.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        NO_OP

        +
        public static final TOExecutionResult.Type NO_OP
        +
        No error happened, but for some reason the TO didn't apply any change. For example, when it was supposed to + delete lines in a text file based on a regular expression, but no lines were found to match the regular expression.
        +
        • +
      + + + +
        +
      • +

        SUCCESS

        +
        public static final TOExecutionResult.Type SUCCESS
        +
        The TO executed normally and a change was performed.
        +
        • +
      + + + +
        +
      • +

        WARNING

        +
        public static final TOExecutionResult.Type WARNING
        +
        The TO executed, a complete and valid change was performed, but a "non-fatal" unexpected situation happened.
        +
        • +
      + + + +
        +
      • +

        ERROR

        +
        public static final TOExecutionResult.Type 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.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static TOExecutionResult.Type[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (TOExecutionResult.Type c : TOExecutionResult.Type.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static TOExecutionResult.Type valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TOExecutionResult.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TOExecutionResult.html new file mode 100644 index 00000000..d072788c --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TOExecutionResult.html @@ -0,0 +1,614 @@ + + + + + +TOExecutionResult (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.paypal.butterfly.extensions.api
+

Class TOExecutionResult

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        warning

        +
        public static TOExecutionResult warning(TransformationOperation transformationOperation,
+                                        java.lang.Exception exception,
+                                        java.lang.String details)
        +
        Creates and returns a new TOExecutionResult.Type.WARNING result
        +
        +
        Parameters:
        +
        transformationOperation - the TransformationOperation object that produced this result
        +
        exception - the exception to be registered to the result object
        +
        details - details about the result
        +
        Returns:
        +
        the created result object
        +
        +
        • +
      + + + + + + + +
        +
      • +

        error

        +
        public static TOExecutionResult error(TransformationOperation transformationOperation,
+                                      java.lang.Exception exception,
+                                      java.lang.String details)
        +
        Creates and returns a new TOExecutionResult.Type.ERROR result
        +
        +
        Parameters:
        +
        transformationOperation - the TransformationOperation object that produced this result
        +
        exception - the exception to be registered to the result object
        +
        details - details about the result
        +
        Returns:
        +
        the created result object
        +
        +
        • +
      + + + +
        +
      • +

        changeTypeOnWarning

        +
        protected void changeTypeOnWarning()
        +
        • +
      + + + +
        +
      • +

        isExceptionType

        +
        protected boolean isExceptionType()
        +
        • +
      + + + +
        +
      • +

        dependencyFailureCheck

        +
        protected boolean dependencyFailureCheck()
        +
        • +
      + + + + + +
        +
      • +

        setType

        +
        protected R setType(T arg0)
        +
        • +
      + + + +
        +
      • +

        setDetails

        +
        public R setDetails(java.lang.String arg0)
        +
        • +
      + + + +
        +
      • +

        setException

        +
        protected R setException(java.lang.Exception arg0)
        +
        • +
      + + + +
        +
      • +

        addWarning

        +
        public R addWarning(java.lang.Exception arg0)
        +
        • +
      + + + +
        +
      • +

        getSource

        +
        public S getSource()
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public T getType()
        +
        • +
      + + + +
        +
      • +

        getDetails

        +
        public java.lang.String getDetails()
        +
        • +
      + + + +
        +
      • +

        getException

        +
        public java.lang.Exception getException()
        +
        • +
      + + + +
        +
      • +

        getWarnings

        +
        public java.util.List<java.lang.Exception> getWarnings()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TUExecutionResult.Type.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TUExecutionResult.Type.html new file mode 100644 index 00000000..9579f5fc --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TUExecutionResult.Type.html @@ -0,0 +1,368 @@ + + + + + +TUExecutionResult.Type (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api
+

Enum TUExecutionResult.Type

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      ERROR 
      NULL 
      VALUE 
      WARNING 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static TUExecutionResult.TypevalueOf(java.lang.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.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static TUExecutionResult.Type[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (TUExecutionResult.Type c : TUExecutionResult.Type.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static TUExecutionResult.Type valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TUExecutionResult.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TUExecutionResult.html new file mode 100644 index 00000000..9034cf2e --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TUExecutionResult.html @@ -0,0 +1,595 @@ + + + + + +TUExecutionResult (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.paypal.butterfly.extensions.api
+

Class TUExecutionResult

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        warning

        +
        public static TUExecutionResult warning(TransformationUtility transformationUtility,
+                                        java.lang.Exception exception,
+                                        java.lang.String details,
+                                        java.lang.Object value)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        error

        +
        public static TUExecutionResult error(TransformationUtility transformationUtility,
+                                      java.lang.Object value,
+                                      java.lang.Exception exception,
+                                      java.lang.String details)
        +
        • +
      + + + +
        +
      • +

        changeTypeOnWarning

        +
        protected void changeTypeOnWarning()
        +
        • +
      + + + +
        +
      • +

        getValue

        +
        public java.lang.Object getValue()
        +
        Returns the value returned by the transformation utility, which can be null
        +
        +
        Returns:
        +
        the value returned by the transformation utility, which can be null
        +
        +
        • +
      + + + +
        +
      • +

        isExceptionType

        +
        protected boolean isExceptionType()
        +
        • +
      + + + +
        +
      • +

        dependencyFailureCheck

        +
        protected boolean dependencyFailureCheck()
        +
        • +
      + + + + + +
        +
      • +

        setType

        +
        protected R setType(T arg0)
        +
        • +
      + + + +
        +
      • +

        setDetails

        +
        public R setDetails(java.lang.String arg0)
        +
        • +
      + + + +
        +
      • +

        setException

        +
        protected R setException(java.lang.Exception arg0)
        +
        • +
      + + + +
        +
      • +

        addWarning

        +
        public R addWarning(java.lang.Exception arg0)
        +
        • +
      + + + +
        +
      • +

        getSource

        +
        public S getSource()
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public T getType()
        +
        • +
      + + + +
        +
      • +

        getDetails

        +
        public java.lang.String getDetails()
        +
        • +
      + + + +
        +
      • +

        getException

        +
        public java.lang.Exception getException()
        +
        • +
      + + + +
        +
      • +

        getWarnings

        +
        public java.util.List<java.lang.Exception> getWarnings()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationContext.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationContext.html new file mode 100644 index 00000000..3b7cf5f9 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationContext.html @@ -0,0 +1,282 @@ + + + + + +TransformationContext (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.paypal.butterfly.extensions.api
+

Interface TransformationContext

+
+
+
+
    +
  • +
    +
    +
    public interface TransformationContext
    +
    Holds meta-data information + to be shared among transformation utility objects, + allowing communication among them, and helping the + transformation process.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      booleancontains(java.lang.String name) +
      Return true if the transformation context has an attribute whose name is name
      +
      java.lang.Objectget(java.lang.String name) +
      Returns the attribute object associated with the key + (which is the attribute name), or null, if there is none
      +
      PerformResultgetResult(java.lang.String utilityName) +
      Returns the performing result of the TransformationUtility + identified by the specified name.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        get

        +
        java.lang.Object get(java.lang.String name)
        +
        Returns the attribute object associated with the key + (which is the attribute name), or null, if there is none
        +
        +
        Parameters:
        +
        name - the transformation context attribute name
        +
        Returns:
        +
        the attribute object
        +
        +
        • +
      + + + + + + + +
        +
      • +

        contains

        +
        boolean contains(java.lang.String name)
        +
        Return true if the transformation context has an attribute whose name is name
        +
        +
        Parameters:
        +
        name - the transformation context attribute name
        +
        Returns:
        +
        true if the transformation context has an attribute whose name is name
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationOperation.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationOperation.html new file mode 100644 index 00000000..56a53abe --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationOperation.html @@ -0,0 +1,427 @@ + + + + + +TransformationOperation (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api
+

Class TransformationOperation<T extends TransformationOperation>

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TransformationOperation

        +
        public TransformationOperation()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setSaveResult

        +
        protected final T setSaveResult(boolean saveResult)
        +
        Description copied from class: TransformationUtility
        +
        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. See also TransformationUtility.isSaveResult().
        +
        +
        Overrides:
        +
        setSaveResult in class TransformationUtility<T extends TransformationOperation>
        +
        Parameters:
        +
        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 object
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        getOrCreateReadFile

        +
        protected final java.io.File getOrCreateReadFile(java.io.File transformedAppFolder,
+                                                 TransformationContext transformationContext)
+                                          throws java.io.IOException
        +
        Creates and returns a temporary read-only copy of the file to be modified. +
        + The file to be modified by any transformation operation is set via + 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 a 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. +
        + Important notes: +
          +
        1. At the first time this method is called, the temporary file will be created and returned. If called again, the same temporary file created at the first time will be returned.
          2. +
        2. The read-only file will not reflect the changes performed in the original file at any moment, always keeping its original state.
          3. +
        3. There is no need to delete the temporary file after using it. Butterfly automatically deletes it when the JVM terminates.
          4. +
        +
        +
        Parameters:
        +
        transformedAppFolder - the folder where the transformed application code is
        +
        transformationContext - the transformation context object
        +
        Returns:
        +
        a temporary read-only copy of the file to be modified
        +
        Throws:
        +
        java.io.IOException - if the temporary file could not be created, if the specified file is actually a directory, or if it does not exist
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationTemplate.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationTemplate.html new file mode 100644 index 00000000..b82f1df9 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationTemplate.html @@ -0,0 +1,823 @@ + + + + + +TransformationTemplate (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api
+

Class TransformationTemplate

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    UpgradeStep
    +
    +
    +
    +
    public abstract class TransformationTemplate
+extends java.lang.Object
    +
    A template made of a set of transformation utilities to be applied against an application to be transformed.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.lang.StringBASELINE 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      java.lang.Stringadd(TransformationUtility utility) +
      Adds a new transformation utility to the end of the list.
      +
      java.lang.Stringadd(TransformationUtility utility, + java.lang.String utilityName) +
      Adds a new transformation utility to the end of the list.
      +
      java.lang.StringaddMultiple(TransformationOperation templateOperation, + java.lang.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 +
      +
      voiddebug(java.lang.String debugMessage) 
      voiddebug(java.lang.String debugMessage, + java.lang.String... attributeNames) 
      java.lang.StringgetApplicationName() +
      Returns the name of the transformed application, + Returns null if the application name is unknown.
      +
      java.lang.StringgetApplicationType() +
      Returns the type of the transformed application, + Returns null if the application type is unknown.
      +
      java.util.List<TransformationUtility>getChildren() 
      abstract java.lang.StringgetDescription() +
      Returns the transformation template description
      +
      abstract java.lang.Class<? extends Extension>getExtensionClass() +
      Returns the class of the extension this transformation + template belongs to
      +
      java.lang.StringgetName() 
      protected java.lang.StringgetSimpleClassName() +
      Returns the transformation template class simple name + (see Class.getSimpleName()), or "AnonymousTransformationTemplate" + if that is an anonymous class
      +
      java.util.List<TransformationUtility>getUtilities() +
      Returns a read-only ordered list of transformation utilities to be executed, + which defines the actual transformation offered by this template
      +
      voidinfo(java.lang.String infoMessage) 
      voidinfo(java.lang.String infoMessage, + java.lang.String... attributeNames) 
      booleanisBlank() +
      Returns true if this is a blank transformation template.
      +
      voidlog(org.slf4j.event.Level logLevel, + java.lang.String logMessage) 
      voidlog(org.slf4j.event.Level logLevel, + java.lang.String logMessage, + java.lang.String... attributeNames) 
      voidlog(java.lang.String logMessage) +
      Deprecated. 
      +
      voidlog(java.lang.String logMessage, + java.lang.String... attributeNames) +
      Deprecated. 
      +
      java.lang.Stringloop(TransformationUtility utility, + int iterations) +
      Execute an utility in a loop a number times specified in iterations
      +
      java.lang.Stringloop(TransformationUtility utility, + java.lang.String attribute) +
      Execute an utility in a loop while the value in TransformationContext attribute is true.
      +
      java.lang.Stringloop(TransformationUtility utility, + UtilityCondition condition) +
      Execute an utility in a loop while the execution value resulted by condition is true.
      +
      voidsetBlank(boolean blank) +
      Sets whether this is a blank transformation template or not.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        TransformationTemplate

        +
        public TransformationTemplate()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getExtensionClass

        +
        public abstract java.lang.Class<? extends Extension> getExtensionClass()
        +
        Returns the class of the extension this transformation + template belongs to
        +
        +
        Returns:
        +
        the class of the extension this transformation + template belongs to
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public abstract java.lang.String getDescription()
        +
        Returns the transformation template description
        +
        +
        Returns:
        +
        the transformation template description
        +
        +
        • +
      + + + +
        +
      • +

        add

        +
        public final java.lang.String add(TransformationUtility utility)
        +
        Adds a new transformation utility to the end of the list. + Also, if no name has been set for this utility yet, the template + names the utility based on this template's name and the order of + execution. +
        + This method also register the template within the utility, which + means a transformation utility instance can be registered to + ONLY ONE transformation template
        +
        +
        Parameters:
        +
        utility - the utility to be added
        +
        Returns:
        +
        the utility name
        +
        +
        • +
      + + + +
        +
      • +

        add

        +
        public final java.lang.String add(TransformationUtility utility,
+                                  java.lang.String utilityName)
        +
        Adds a new transformation utility to the end of the list. + It sets the utility name before adding it though. +
        + This method also register the template within the utility, which + means a transformation utility instance can be registered to + ONLY ONE transformation template
        +
        +
        Parameters:
        +
        utility - the utility to be added
        +
        utilityName - the name to be set to the utility before adding it
        +
        Returns:
        +
        the utility name
        +
        +
        • +
      + + + +
        +
      • +

        addMultiple

        +
        public final java.lang.String addMultiple(TransformationOperation templateOperation,
+                                          java.lang.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 +
        +
        +
        Parameters:
        +
        templateOperation - a template of transformation operation to be performed + against all specified files
        +
        attributes - one or more transformation context attributes that hold list + of Files which the transformation operations should perform + against
        +
        Returns:
        +
        the utility name
        +
        +
        • +
      + + + +
        +
      • +

        loop

        +
        public final java.lang.String loop(TransformationUtility utility,
+                                   int iterations)
        +
        Execute an utility in a loop a number times specified in iterations
        +
        +
        Parameters:
        +
        utility - the utility to be executed each iteration of the loop. To execute more than one, use a TransformationUtilityGroup
        +
        iterations - the number of iterations to be executed
        +
        Returns:
        +
        the utility name
        +
        +
        • +
      + + + +
        +
      • +

        loop

        +
        public final java.lang.String loop(TransformationUtility utility,
+                                   java.lang.String attribute)
        +
        Execute an utility in a loop while the value in 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.
        +
        +
        Parameters:
        +
        utility - the utility to be executed each iteration of the loop. To execute more than one, use a TransformationUtilityGroup
        +
        attribute - the name of the transformation context attribute to hold the loop condition
        +
        Returns:
        +
        the utility name
        +
        +
        • +
      + + + +
        +
      • +

        loop

        +
        public final java.lang.String loop(TransformationUtility utility,
+                                   UtilityCondition condition)
        +
        Execute an utility in a loop while the execution value resulted by 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.
        +
        +
        Parameters:
        +
        utility - the utility to be executed each iteration of the loop. To execute more than one, use a TransformationUtilityGroup
        +
        condition - the UtilityCondition object whose execution result will be used as the loop condition
        +
        Returns:
        +
        the utility name
        +
        +
        • +
      + + + +
        +
      • +

        log

        +
        @Deprecated
+public final void log(java.lang.String logMessage)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        info

        +
        public final void info(java.lang.String infoMessage)
        +
        • +
      + + + +
        +
      • +

        debug

        +
        public final void debug(java.lang.String debugMessage)
        +
        • +
      + + + +
        +
      • +

        log

        +
        public final void log(org.slf4j.event.Level logLevel,
+                      java.lang.String logMessage)
        +
        • +
      + + + +
        +
      • +

        log

        +
        @Deprecated
+public final void log(java.lang.String logMessage,
+                                  java.lang.String... attributeNames)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        info

        +
        public final void info(java.lang.String infoMessage,
+                       java.lang.String... attributeNames)
        +
        • +
      + + + +
        +
      • +

        debug

        +
        public final void debug(java.lang.String debugMessage,
+                        java.lang.String... attributeNames)
        +
        • +
      + + + +
        +
      • +

        log

        +
        public final void log(org.slf4j.event.Level logLevel,
+                      java.lang.String logMessage,
+                      java.lang.String... attributeNames)
        +
        • +
      + + + +
        +
      • +

        getUtilities

        +
        public final java.util.List<TransformationUtility> getUtilities()
        +
        Returns a read-only ordered list of transformation utilities to be executed, + which defines the actual transformation offered by this template
        +
        +
        Returns:
        +
        the list of utilities to transform the application,
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getName

        +
        public final java.lang.String getName()
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        getApplicationType

        +
        public java.lang.String getApplicationType()
        +
        Returns the type of the transformed application, + Returns null if the application type is unknown. + This method is used mostly for meta-data purposes, + such as when providing transformation metrics.
        +
        +
        Returns:
        +
        the type of the transformed application
        +
        +
        • +
      + + + +
        +
      • +

        getApplicationName

        +
        public java.lang.String getApplicationName()
        +
        Returns the name of the transformed application, + Returns null if the application name is unknown. + This method is used mostly for meta-data purposes, + such as when providing transformation metrics.
        +
        +
        Returns:
        +
        the name of the transformed application
        +
        +
        • +
      + + + +
        +
      • +

        getSimpleClassName

        +
        protected java.lang.String getSimpleClassName()
        +
        Returns the transformation template class simple name + (see Class.getSimpleName()), or "AnonymousTransformationTemplate" + if that is an anonymous class
        +
        +
        Returns:
        +
        the transformation template class simple name
        +
        +
        • +
      + + + +
        +
      • +

        setBlank

        +
        public void setBlank(boolean blank)
        +
        Sets whether this is a blank transformation template or not. + Commonly transformations are done by first copying all files and folders the current application has, and then performing a set of ordered operations, + one by one, on top of those files, until the final result is reached. + However, a few times transformations might be so massive that it would make more sense to take a reverse approach, starting from a blank folder, + followed by a set of copies from the original application folder plus eventual operations. + This reverse approach is called "blank transformation". + By default transformation templates are not blank. Notice that UpgradeStep cannot be blank.
        +
        +
        Parameters:
        +
        blank - whether this is a blank transformation template or not
        +
        +
        • +
      + + + +
        +
      • +

        isBlank

        +
        public boolean isBlank()
        +
        Returns true if this is a blank transformation template. + See setBlank(boolean).
        +
        +
        Returns:
        +
        true if this is a blank transformation template
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationUtility.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationUtility.html new file mode 100644 index 00000000..822235e0 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationUtility.html @@ -0,0 +1,1626 @@ + + + + + +TransformationUtility (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api
+

Class TransformationUtility<T extends TransformationUtility>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    +
    Abort, ContextAttributeRetriever, FilterFiles, Log, ManualInstruction, MapValue, MultipleOperations, TransformationOperation, TransformationUtilityGroup, TransformationUtilityLoop, UtilityCondition
    +
    +
    +
    +
    public abstract class TransformationUtility<T extends TransformationUtility>
+extends java.lang.Object
+implements java.lang.Cloneable
    +
    Gathers information about the project to be transformed without applying any modification on it. + It is the key element of Butterfly transformation engine. The result information is saved in the + TransformationContext object, to be used later by other transformation utilities. +
    + Transformation utilities are executed against the to be transformed project, + based on the absolute project root folder defined in runtime, and a relative + path to a target file or folder, defined in compilation time. +
    + Transformation utilities are also known by TU. +
    + An example of a transformation operation utility would be to find recursively + a particular file based on its name and from a particular location (which would + be relative to the project root folder) + + See 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.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      protected static java.lang.StringUTILITY_NAME_SYNTAX 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      TabortOnFailure(boolean abort) +
      If set to true, abort the whole transformation if validation or execution fails.
      +
      TabortOnFailure(java.lang.String abortionMessage) +
      Abort the whole transformation if validation or execution fails.
      +
      Tabsolute(java.lang.String contextAttributeName) +
      There are two ways to specify the file, or folder, the transformation + utility is suppose to perform against.
      +
      Tabsolute(java.lang.String contextAttributeName, + java.lang.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 voidapplyPropertiesFromContext(TransformationContext transformationContext) +
      Applies transformation utility properties during transformation time, but + prior to execution (right before it).
      +
      protected com.paypal.butterfly.extensions.api.ResultcheckDependencies(TransformationContext transformationContext) +
      Check if any of dependency of this TU failed.
      +
      protected static voidcheckForBlankString(java.lang.String name, + java.lang.String value) +
      Check if value is a blank String, if it is, then a + TransformationDefinitionException is thrown.
      +
      protected static voidcheckForEmptyString(java.lang.String name, + java.lang.String value) +
      Check if value is an empty String, if it is, then a + TransformationDefinitionException is thrown.
      +
      protected static voidcheckForNull(java.lang.String name, + java.lang.Object value) +
      Check if value is null, if it is, then a + TransformationDefinitionException is thrown.
      +
      Tclone() +
      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.
      +
      Tcopy() +
      Creates and returns a copy object similar to the original object.
      +
      TdependsOn(java.lang.String... dependencies) +
      Add all transformation utilities this utility depends on.
      +
      booleanequals(java.lang.Object obj) +
      Compare this instance against the specified object, and return + true only if they are equal.
      +
      TexecuteIf(java.lang.String conditionAttributeName) +
      When set, this TU will only execute if this transformation context + attribute is existent and its value is set to true (as String or Boolean).
      +
      TexecuteIf(UtilityCondition utilityCondition) +
      When set, this TU will only execute if this utilityCondition object, + executed right before this TU, result in true.
      +
      TexecuteUnless(java.lang.String conditionAttributeName) +
      When set, this TU will execute, unless this transformation context + attribute is existent and its value is set to true (as String or Boolean).
      +
      protected abstract ExecutionResultexecution(java.io.File transformedAppFolder, + TransformationContext transformationContext) +
      The implementation execution of this transformation utility.
      +
      java.lang.StringgetAbortionMessage() +
      Returns a message to be logged if a fail happens and transformation has to be aborted
      +
      protected java.io.FilegetAbsoluteFile(java.io.File transformedAppFolder, + TransformationContext transformationContext) +
      Returns an absolute path to the file or folder the transformation + utility is supposed to perform against
      +
      java.lang.StringgetContextAttributeName() +
      Return the name to be used as key for the result of this utility + when saved into the transformation context.
      +
      protected java.util.List<java.lang.String>getDependencies() +
      Returns an unmodifiable list of names of utilities this utility instance depends on.
      +
      abstract java.lang.StringgetDescription() +
      Returns a short one line, but SPECIFIC, description about the transformation + utility, including mentioning the files and/or folders + to be manipulated.
      +
      java.lang.StringgetIfConditionAttributeName() +
      Return the "if" condition attribute name associated with this transformation operation, + or null, if there is none
      +
      java.lang.StringgetName() 
      intgetOrder() +
      Returns the execution order for this utility on its parent.
      +
      com.paypal.butterfly.extensions.api.TransformationUtilityParentgetParent() +
      Returns the transformation utility parent
      +
      protected java.lang.StringgetRelativePath() +
      Returns relative path (from the application root folder) to the + file or folder the transformation utility is suppose to perform against
      +
      protected static java.lang.StringgetRelativePath(java.io.File baselineFile, + java.io.File targetFile) +
      Returns a relative path from baselineFile to targetFile.
      +
      protected java.lang.StringgetSimpleClassName() +
      Returns the transformation utility class simple name + (see Class.getSimpleName()), or "AnonymousTransformationUtility" + if that is an anonymous class
      +
      TransformationTemplategetTransformationTemplate() +
      Returns the transformation template this utility belongs to.
      +
      java.lang.StringgetUnlessConditionAttributeName() +
      Return the "unless" condition attribute name associated with this transformation operation, + or null, if there is none
      +
      booleanhasBeenPerformed() +
      Returns true only if this utility has already been performed, even + if the execution was skipped.
      +
      inthashCode() 
      protected inthashCode(int superHashCode, + java.lang.Object... elements) +
      Calculates and return a hash code starting from the + hash code generated from superclass
      +
      booleanisAbortOnFailure() +
      Returns whether this operation aborts the transformation or not in + case of an operation failure.
      +
      booleanisFileSet() +
      Return true only if a file has been set.
      +
      booleanisSaveResult() +
      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 java.lang.StringnormalizeRelativePathSeparator(java.lang.String relativePath) 
      PerformResultperform(java.io.File transformedAppFolder, + TransformationContext transformationContext) +
      Performs the transformation utility against + the application to be transformed.
      +
      Trelative(java.lang.String relativePath) +
      Sets the relative path from the application root folder + to the file or folder the transformation utility should perform against.
      +
      Tset(java.lang.String propertyName, + java.lang.String contextAttributeName) +
      This method allows setting properties in this transformation + utility during transformation time, right before its execution.
      +
      TsetContextAttributeName(java.lang.String contextAttributeName) +
      Set the name to be used as key for the result of this utility + when saved into the transformation context.
      +
      protected TsetName(java.lang.String name) +
      Set this transformation utility instance name.
      +
      TsetParent(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 TsetSaveResult(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.
      +
      java.lang.StringtoString() 
      booleanwasFileExplicitlySet() +
      Return true only if a file has been set explicitly either via relative(String), absolute(String) or absolute(String, String).
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        UTILITY_NAME_SYNTAX

        +
        protected static final java.lang.String UTILITY_NAME_SYNTAX
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TransformationUtility

        +
        public TransformationUtility()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setName

        +
        protected T setName(java.lang.String name)
        +
        Set this transformation utility instance name. + If not set, a default name will be assigned at the + time it is added to a parent.
        +
        +
        Parameters:
        +
        name - transformation utility instance name
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public final java.lang.String getName()
        +
        • +
      + + + +
        +
      • +

        setContextAttributeName

        +
        public T setContextAttributeName(java.lang.String contextAttributeName)
        +
        Set the name to be used as key for the result of this utility + when saved into the transformation context. + If this is not set, or null, then the utility name will be used instead
        +
        +
        Parameters:
        +
        contextAttributeName - the name to be used as key for the result of this utility + when saved into the transformation context.
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        getContextAttributeName

        +
        public java.lang.String getContextAttributeName()
        +
        Return the name to be used as key for the result of this utility + when saved into the transformation context. + If it is null, then the utility name will be used instead
        +
        +
        Returns:
        +
        the name to be used as key for the result of this utility + when saved into the transformation context
        +
        +
        • +
      + + + +
        +
      • +

        setParent

        +
        public final 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. +
        + Usually the parent is a TransformationTemplate
        +
        +
        Parameters:
        +
        parent - the parent to be set to this utility
        +
        order - the order of execution of this utility
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        getParent

        +
        public com.paypal.butterfly.extensions.api.TransformationUtilityParent getParent()
        +
        Returns the transformation utility parent
        +
        +
        Returns:
        +
        the transformation utility parent
        +
        +
        • +
      + + + +
        +
      • +

        getTransformationTemplate

        +
        public TransformationTemplate getTransformationTemplate()
        +
        Returns the transformation template this utility belongs to. + It returns null if hasn't been added to a transformation template yet.
        +
        +
        Returns:
        +
        the transformation template this utility belongs to
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public abstract java.lang.String getDescription()
        +
        Returns a short one line, but SPECIFIC, description about the transformation + utility, including mentioning the files and/or folders + to be manipulated. This is supposed to be an one line statement about the + specific transformation utility that was executed. This would be used for example in + log statements or user interfaces.
        +
        +
        Returns:
        +
        a short one line, but specific, description about the transformation + utility
        +
        +
        • +
      + + + +
        +
      • +

        getOrder

        +
        public int getOrder()
        +
        Returns the execution order for this utility on its parent. + Value -1 means it has not been registered to any parent yet, + while 1 means first.
        +
        +
        Returns:
        +
        the execution order for this utility on its parent
        +
        +
        • +
      + + + +
        +
      • +

        relative

        +
        public final T relative(java.lang.String relativePath)
        +
        Sets the relative path from the application root folder + to the file or folder the transformation utility should perform against. + The path separator is automatically normalized, so there are three valid + options when separating folders in the path: +
          +
        1. File.separatorChar (e.g. relative("myFolder" + File.separator + "file.txt")
          2. +
        2. Forward slash (e.g. relative("myFolder/file.txt")
          3. +
        3. Two backward slashes (e.g. relative("myFolder\\file.txt")
          4. +
        + The slashes are replaced by OS specific separator char in runtime. +
        + The default value is ".". which means the root of the transformed application
        +
        +
        Parameters:
        +
        relativePath - from the application root folder + to the file or folder the transformation utility should be performed against
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        normalizeRelativePathSeparator

        +
        protected static java.lang.String normalizeRelativePathSeparator(java.lang.String relativePath)
        +
        • +
      + + + +
        +
      • +

        getRelativePath

        +
        protected final java.lang.String getRelativePath()
        +
        Returns relative path (from the application root folder) to the + file or folder the transformation utility is suppose to perform against
        +
        +
        Returns:
        +
        relative path (from the application root folder) to the + file or folder the transformation utility is suppose to perform against
        +
        +
        • +
      + + + +
        +
      • +

        getAbsoluteFile

        +
        protected final java.io.File getAbsoluteFile(java.io.File transformedAppFolder,
+                                             TransformationContext transformationContext)
+                                      throws TransformationUtilityException
        +
        Returns an absolute path to the file or folder the transformation + utility is supposed to perform against
        +
        +
        Parameters:
        +
        transformedAppFolder - the folder where the transformed application code is
        +
        transformationContext - the transformation context object
        +
        Returns:
        +
        an absolute path to the file or folder the transformation + utility is suppose to perform against
        +
        Throws:
        +
        TransformationUtilityException
        +
        +
        • +
      + + + +
        +
      • +

        getRelativePath

        +
        protected static java.lang.String getRelativePath(java.io.File baselineFile,
+                                                  java.io.File targetFile)
        +
        Returns a relative path from 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 returned.
        +
        +
        Parameters:
        +
        baselineFile - the file whose returned relative path should start from. + It must be aa direct or indirect parent file to targetFile
        +
        targetFile - the file whose returned relative path should take to
        +
        Returns:
        +
        a relative path from baselineFile to targetFile
        +
        +
        • +
      + + + +
        +
      • +

        set

        +
        public final T set(java.lang.String propertyName,
+                   java.lang.String contextAttributeName)
        +
        This method allows setting properties in this transformation + utility during transformation time, right before its execution. +
        + The term "property" here refers to Java bean property, which means + an instance variable that has public setter and getter, named according + to the variable name. +
        + This is very useful when the property value is not known during + transformation definition. Any attribute stored in the + transformation context can be used as the value to be set to the + property. In most of the cases the result of a prior + transformation utility is used as property value. +
        + If there is no transformation context attribute named contextAttributeName + at the time this transformation utility is executed, a TransformationUtilityException + will be thrown. +
        + However, if such attribute exits, but its value is null, the property will be set as null + and its execution will proceed normally, unless that property is a primitive, + which would result in an error (TransformationUtilityException) with + IllegalArgumentException) as root cause. +
        + Notice that, because this feature relies on reflection, executing it is not + cheap, especially because it happens during transformation time. + So, use it only when really necessary.
        +
        +
        Parameters:
        +
        propertyName - the transformation utility Java property name
        +
        contextAttributeName - the name of the transformation context attribute whose + value will be set as the property value right before + execution
        +
        Returns:
        +
        this transformation utility instance
        +
        Throws:
        +
        TransformationUtilityException - if the transformation context does not have an + attribute named contextAttributeName
        +
        TransformationDefinitionException - if propertyName is not + an existent Java bean property + in this transformation utility class
        +
        +
        • +
      + + + +
        +
      • +

        applyPropertiesFromContext

        +
        protected final void applyPropertiesFromContext(TransformationContext transformationContext)
+                                         throws TransformationUtilityException
        +
        Applies transformation utility properties during transformation time, but + prior to execution (right before it). The properties values are gotten from + the transformation context object.
        +
        +
        Parameters:
        +
        transformationContext - the transformation context object
        +
        Throws:
        +
        TransformationUtilityException
        +
        +
        • +
      + + + +
        +
      • +

        absolute

        +
        public T absolute(java.lang.String contextAttributeName)
        +
        There are two ways to specify the file, or folder, the transformation + utility is suppose to perform against. The default and most commons one is + by setting the relative path to it, which is done usually via the constructor + or relative(String)). That should be the chosen option whenever + the relative location is known during transformation template definition time. +
        + However, sometimes that is not possible because that location will only be known + during transformation time. In cases like this, usually another utility is used to + find that location first, and then save it as transformation context attribute. In + this case, this setter here can be used to set the absolute file location based + on such context attribute. Whenever this is set, the relative path attribute is + ignored. +
        + See also getAbsoluteFile(File, TransformationContext), relative(String) + and getRelativePath()
        +
        +
        Parameters:
        +
        contextAttributeName - the name of the transformation context attribute whose + value will be set as the absolute file right before + execution
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        absolute

        +
        public T absolute(java.lang.String contextAttributeName,
+                  java.lang.String additionalRelativePath)
        +
        Same as 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 +
        + See also getAbsoluteFile(File, TransformationContext), relative(String) + and getRelativePath()
        +
        +
        Parameters:
        +
        contextAttributeName - the name of the transformation context attribute whose + value will be set as the absolute file right before + execution
        +
        additionalRelativePath - 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)
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + + + + + +
        +
      • +

        abortOnFailure

        +
        public final T abortOnFailure(boolean abort)
        +
        If set to true, abort the whole transformation if validation or execution fails. + If not, aborts the transformation utility execution only. This method will also + set the abortion message to null. + Use abortOnFailure(String) instead to set abort on failure to true, but also + set a custom abortion message. +
        + Notice that abortion here means interrupting the transformation. + It does not mean rolling back the changes that have might already been done + by this transformation operation by the time it failed.
        +
        +
        Parameters:
        +
        abort - if set to true, abort the whole transformation if validation or execution fails. + If not, just state a warning, aborts the operation execution only
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        abortOnFailure

        +
        public final T abortOnFailure(java.lang.String abortionMessage)
        +
        Abort the whole transformation if validation or execution fails. + This method has the same effect as calling abortOnFailure(true), but + it also allows setting an abortion message. + Notice that abortion here means interrupting the transformation. + It does not mean rolling back the changes that have might already been done + by this transformation operation by the time it failed
        +
        +
        Parameters:
        +
        abortionMessage - a message to be logged if transformation has to be aborted
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        getAbortionMessage

        +
        public java.lang.String getAbortionMessage()
        +
        Returns a message to be logged if a fail happens and transformation has to be aborted
        +
        +
        Returns:
        +
        a message to be logged if a fail happens and transformation has to be aborted
        +
        +
        • +
      + + + +
        +
      • +

        isAbortOnFailure

        +
        public final boolean isAbortOnFailure()
        +
        Returns whether this operation aborts the transformation or not in + case of an operation failure. Notice that this method does NOT + change the state this object in any ways, it is just a getter.
        +
        +
        Returns:
        +
        true only if this operation aborts the transformation or not in + case of an operation failure
        +
        +
        • +
      + + + +
        +
      • +

        isSaveResult

        +
        public 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. +
        + In most cases it should do so, because that is the main purpose of + every transformation utility, to produce and share useful data with other + transformation utilities and operations. +
        + However, there are rare cases, + for example Log, + where no value will be produced and nothing should be saved to the + transformation context attribute
        +
        +
        Returns:
        +
        true only 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 object
        +
        +
        • +
      + + + +
        +
      • +

        setSaveResult

        +
        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. See also isSaveResult().
        +
        +
        Parameters:
        +
        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 object
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        hasBeenPerformed

        +
        public final boolean hasBeenPerformed()
        +
        Returns true only if this utility has already been performed, even + if the execution was skipped.
        +
        +
        Returns:
        +
        true only if this utility has already been performed
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getDependencies

        +
        protected final java.util.List<java.lang.String> getDependencies()
        +
        Returns an unmodifiable list of names of utilities this utility instance depends on. + See also dependsOn(String...).
        +
        +
        Returns:
        +
        an unmodifiable list of names of utilities this utility instance depends on
        +
        +
        • +
      + + + +
        +
      • +

        checkDependencies

        +
        protected com.paypal.butterfly.extensions.api.Result checkDependencies(TransformationContext transformationContext)
        +
        Check if any of dependency of this TU failed. If that is true, + returns a result object stating so. If not, returns null. If this TU + has no dependencies it also returns null. See dependsOn(String...) + to find out the dependency failure criteria
        +
        +
        Parameters:
        +
        transformationContext - the transformation context object, in this case used + to check all past executed utilities
        +
        Returns:
        +
        a result object if any of dependency of this utility failed, + or null, if that is not the case, or if this utility does not have dependencies
        +
        +
        • +
      + + + +
        +
      • +

        executeIf

        +
        public final T executeIf(java.lang.String conditionAttributeName)
        +
        When set, this TU will only execute if this transformation context + attribute is existent and its value is set to true (as String or Boolean).
        +
        +
        Parameters:
        +
        conditionAttributeName - the name of the transformation context attribute which + holds a Boolean or String value used to evaluate if this + utility should be executed or not
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        executeIf

        +
        public final T executeIf(UtilityCondition utilityCondition)
        +
        When set, this TU will only execute if this utilityCondition object, + executed right before this TU, result in true. +
        + Differences between this approach and executeIf(String): +
          +
        1. Instead of relying on a TCA (attribute) with the condition result, this method is based on the direct execution of the UtilityCondition object
          2. +
        2. The UtilityCondition 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.
          3. +
        3. The 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).
          4. +
        4. The 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).
          5. +
        + The actual UtilityCondition object is not the one used, but a copy of it
        +
        +
        Parameters:
        +
        utilityCondition - the condition to be executed and evaluated right before this TU
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        executeUnless

        +
        public final T executeUnless(java.lang.String conditionAttributeName)
        +
        When set, this TU will execute, unless this transformation context + attribute is existent and its value is set to true (as String or Boolean).
        +
        +
        Parameters:
        +
        conditionAttributeName - the name of the transformation context attribute which + holds a Boolean or String value used to evaluate if this + utility should be executed or not
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        getIfConditionAttributeName

        +
        public java.lang.String getIfConditionAttributeName()
        +
        Return the "if" condition attribute name associated with this transformation operation, + or null, if there is none
        +
        +
        Returns:
        +
        the "if" condition attribute name associated with this transformation operation
        +
        +
        • +
      + + + +
        +
      • +

        getUnlessConditionAttributeName

        +
        public java.lang.String getUnlessConditionAttributeName()
        +
        Return the "unless" condition attribute name associated with this transformation operation, + or null, if there is none
        +
        +
        Returns:
        +
        the "unless" condition attribute name associated with this transformation operation
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected abstract ExecutionResult execution(java.io.File transformedAppFolder,
+                                             TransformationContext transformationContext)
        +
        The implementation execution of this transformation utility. + The returned object is the result of the execution and is always + automatically saved in the transformation context as a new + attribute (whose key is the name of the transformation utility), unless + isSaveResult() returns false. +
        + Important: this method MUST NEVER return null, and it must catch its executions exceptions + and wrap them into a ExecutionResult error object.
        +
        +
        Parameters:
        +
        transformedAppFolder - the folder where the transformed application code is
        +
        transformationContext - the transformation context object
        +
        Returns:
        +
        an object with the result of this execution, to be better defined + by the concrete utility class, since its type is generic
        +
        +
        • +
      + + + +
        +
      • +

        isFileSet

        +
        public final boolean isFileSet()
        +
        Return true only if a file has been set. Every 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).
        +
        +
        Returns:
        +
        true only if a file has been set
        +
        +
        • +
      + + + + + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        clone

        +
        public 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. See hasBeenPerformed().
        +
        +
        Overrides:
        +
        clone in class java.lang.Object
        +
        Returns:
        +
        the new object created as result of the clone operation
        +
        +
        • +
      + + + +
        +
      • +

        copy

        +
        public T copy()
        +
        Creates and returns a copy object similar to the original object. + All attributes are the same, except for the following ones, which are reset: +
          +
        1. parent
          2. +
        2. name
          3. +
        3. order
          4. +
        4. context attribute name
          5. +
        5. file relative and absolute path
          6. +
        6. has been performed flag
          7. +
        +
        +
        Returns:
        +
        the new object created as result of the copy operation
        +
        +
        • +
      + + + +
        +
      • +

        checkForBlankString

        +
        protected static void checkForBlankString(java.lang.String name,
+                                          java.lang.String value)
+                                   throws TransformationDefinitionException
        +
        Check if value is a blank String, if it is, then a + TransformationDefinitionException is thrown. +
        + This check is used for mandatory properties where value cannot be null + neither an empty string.
        +
        +
        Parameters:
        +
        name - the name of the property
        +
        value - the value to be verified
        +
        Throws:
        +
        TransformationDefinitionException - if check fails
        +
        +
        • +
      + + + +
        +
      • +

        checkForEmptyString

        +
        protected static void checkForEmptyString(java.lang.String name,
+                                          java.lang.String value)
+                                   throws TransformationDefinitionException
        +
        Check if value is an empty String, if it is, then a + TransformationDefinitionException is thrown. +
        + This check is used for optional properties where value can be null, + but not an empty string.
        +
        +
        Parameters:
        +
        name - the name of the property
        +
        value - the value to be verified
        +
        Throws:
        +
        TransformationDefinitionException - if check fails
        +
        +
        • +
      + + + + + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        Compare this instance against the specified object, and return + true only if they are equal. Notice though that the fact that + the utility has been performed or not will NOT be used for this + comparison.
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        Parameters:
        +
        obj - the object to be compared against this instance
        +
        Returns:
        +
        true only if they are equal
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        protected final int hashCode(int superHashCode,
+                             java.lang.Object... elements)
        +
        Calculates and return a hash code starting from the + hash code generated from superclass
        +
        +
        Parameters:
        +
        superHashCode - hash code generated from superclass
        +
        elements - array of Objects to be used to generate hashcode. + These elements should be the attributes used in + the equals method
        +
        Returns:
        +
        the generated hashcode
        +
        +
        • +
      + + + +
        +
      • +

        getSimpleClassName

        +
        protected java.lang.String getSimpleClassName()
        +
        Returns the transformation utility class simple name + (see Class.getSimpleName()), or "AnonymousTransformationUtility" + if that is an anonymous class
        +
        +
        Returns:
        +
        the transformation utility class simple name
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationUtilityGroup.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationUtilityGroup.html new file mode 100644 index 00000000..d7d2d8eb --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationUtilityGroup.html @@ -0,0 +1,582 @@ + + + + + +TransformationUtilityGroup (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api
+

Class TransformationUtilityGroup

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TransformationUtilityGroup

        +
        public TransformationUtilityGroup()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        Description copied from class: TransformationUtility
        +
        Returns a short one line, but SPECIFIC, description about the transformation + utility, including mentioning the files and/or folders + to be manipulated. This is supposed to be an one line statement about the + specific transformation utility that was executed. This would be used for example in + log statements or user interfaces.
        +
        +
        Specified by:
        +
        getDescription in class TransformationUtility<TransformationUtilityGroup>
        +
        Returns:
        +
        a short one line, but specific, description about the transformation + utility
        +
        +
        • +
      + + + + + + + +
        +
      • +

        add

        +
        public java.lang.String add(TransformationUtility utility,
+                            java.lang.String utilityName)
        +
        • +
      + + + +
        +
      • +

        addMultiple

        +
        public java.lang.String addMultiple(TransformationOperation templateOperation,
+                                    java.lang.String... attributes)
        +
        • +
      + + + +
        +
      • +

        log

        +
        @Deprecated
+public final void log(java.lang.String logMessage)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        info

        +
        public final void info(java.lang.String infoMessage)
        +
        • +
      + + + +
        +
      • +

        debug

        +
        public final void debug(java.lang.String debugMessage)
        +
        • +
      + + + +
        +
      • +

        log

        +
        public final void log(org.slf4j.event.Level logLevel,
+                      java.lang.String logMessage)
        +
        • +
      + + + +
        +
      • +

        log

        +
        @Deprecated
+public final void log(java.lang.String logMessage,
+                                  java.lang.String... attributeNames)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        info

        +
        public final void info(java.lang.String infoMessage,
+                       java.lang.String... attributeNames)
        +
        • +
      + + + +
        +
      • +

        debug

        +
        public final void debug(java.lang.String debugMessage,
+                        java.lang.String... attributeNames)
        +
        • +
      + + + +
        +
      • +

        log

        +
        public final void log(org.slf4j.event.Level logLevel,
+                      java.lang.String logMessage,
+                      java.lang.String... attributeNames)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        execution

        +
        protected ExecutionResult execution(java.io.File transformedAppFolder,
+                                    TransformationContext transformationContext)
        +
        Description copied from class: TransformationUtility
        +
        The implementation execution of this transformation utility. + The returned object is the result of the execution and is always + automatically saved in the transformation context as a new + attribute (whose key is the name of the transformation utility), unless + TransformationUtility.isSaveResult() returns false. +
        + Important: this method MUST NEVER return null, and it must catch its executions exceptions + and wrap them into a ExecutionResult error object.
        +
        +
        Specified by:
        +
        execution in class TransformationUtility<TransformationUtilityGroup>
        +
        Parameters:
        +
        transformedAppFolder - the folder where the transformed application code is
        +
        transformationContext - the transformation context object
        +
        Returns:
        +
        an object with the result of this execution, to be better defined + by the concrete utility class, since its type is generic
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationUtilityLoop.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationUtilityLoop.html new file mode 100644 index 00000000..353c9b01 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/TransformationUtilityLoop.html @@ -0,0 +1,661 @@ + + + + + +TransformationUtilityLoop (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api
+

Class TransformationUtilityLoop

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.paypal.butterfly.extensions.api.TransformationUtilityParent, java.lang.Cloneable
    +
    +
    +
    +
    public class TransformationUtilityLoop
+extends TransformationUtility<TransformationUtilityLoop>
+implements com.paypal.butterfly.extensions.api.TransformationUtilityParent
    +
    Allows the execution of any transformation utility instance, + including a TransformationUtilityGroup, multiple times in a loop. + The number of iterations is defined by one of these options: +
      +
    1. Specifying the number of iterations.
      2. +
    2. Specifying a 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.
      3. +
    3. Specifying a 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.
      4. +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TransformationUtilityLoop

        +
        public TransformationUtilityLoop()
        +
        Allows the execution of any transformation utility instance, + including a TransformationUtilityGroup, multiple times in a loop. + The number of iterations is defined by one of these options: +
          +
        1. Specifying the number of iterations.
          2. +
        2. Specifying a 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.
          3. +
        3. Specifying a 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.
          4. +
        +
        • +
      + + + +
        +
      • +

        TransformationUtilityLoop

        +
        public TransformationUtilityLoop(TransformationUtility template)
        +
        Allows the execution of any transformation utility instance, + including a TransformationUtilityGroup, multiple times in a loop. + The number of iterations is defined by one of these options: +
          +
        1. Specifying the number of iterations.
          2. +
        2. Specifying a 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.
          3. +
        3. Specifying a 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.
          4. +
        +
        +
        Parameters:
        +
        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.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setTemplate

        +
        public TransformationUtilityLoop setTemplate(TransformationUtility template)
        +
        Sets the transformation utility instance to be used as 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.
        +
        +
        Parameters:
        +
        template - the transformation utility instance to be used as template.
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        setCondition

        +
        public 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. Each execution + decrease the remaining number of iterations.
        +
        +
        Parameters:
        +
        iterations - the total number of iterations to be executed
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        setCondition

        +
        public TransformationUtilityLoop setCondition(java.lang.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. If that is not a boolean, or if non-existent, + it will be treated as false. If that is false, the loop is interrupted.
        +
        +
        Parameters:
        +
        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.
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        setCondition

        +
        public 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. + 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.
        +
        +
        Parameters:
        +
        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.
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getIterations

        +
        public int getIterations()
        +
        • +
      + + + +
        +
      • +

        getAttribute

        +
        public java.lang.String getAttribute()
        +
        • +
      + + + + + + + +
        +
      • +

        getNextIteration

        +
        public int getNextIteration()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        Description copied from class: TransformationUtility
        +
        Returns a short one line, but SPECIFIC, description about the transformation + utility, including mentioning the files and/or folders + to be manipulated. This is supposed to be an one line statement about the + specific transformation utility that was executed. This would be used for example in + log statements or user interfaces.
        +
        +
        Specified by:
        +
        getDescription in class TransformationUtility<TransformationUtilityLoop>
        +
        Returns:
        +
        a short one line, but specific, description about the transformation + utility
        +
        +
        • +
      + + + +
        +
      • +

        getChildren

        +
        public java.util.List<TransformationUtility> getChildren()
        +
        +
        Specified by:
        +
        getChildren in interface com.paypal.butterfly.extensions.api.TransformationUtilityParent
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected ExecutionResult execution(java.io.File transformedAppFolder,
+                                    TransformationContext transformationContext)
        +
        Returns, as its value, the condition to keep iterating over this loop
        +
        +
        Specified by:
        +
        execution in class TransformationUtility<TransformationUtilityLoop>
        +
        Parameters:
        +
        transformedAppFolder - the folder where the transformed application code is
        +
        transformationContext - the transformation context object
        +
        Returns:
        +
        a value execution result with the condition to keep iterating over this loop
        +
        +
        • +
      + + + +
        +
      • +

        run

        +
        public TransformationUtility run()
        +
        Returns the TU instance to be run in the this iteration. + This instance is created based on the template
        +
        +
        Returns:
        +
        the TU instance to be run in this iteration
        +
        +
        • +
      + + + +
        +
      • +

        iterate

        +
        public TransformationUtility iterate()
        +
        Returns a clone of this transformation utility loop ready for the next iteration
        +
        +
        Returns:
        +
        a clone of this transformation utility loop ready for the next iteration
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/UtilityCondition.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/UtilityCondition.html new file mode 100644 index 00000000..b393588f --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/UtilityCondition.html @@ -0,0 +1,285 @@ + + + + + +UtilityCondition (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.paypal.butterfly.extensions.api
+

Class UtilityCondition<U extends UtilityCondition>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    +
    DoubleCondition, MultipleConditions, ResultCondition, SingleCondition
    +
    +
    +
    +
    public abstract class UtilityCondition<U extends UtilityCondition>
+extends TransformationUtility<U>
    +
    Condition to determine if a transformation utility + should be executed or not. Although this type has no + explicitly defined structural additions to typical + 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.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        UtilityCondition

        +
        public UtilityCondition()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/ApplicationValidationException.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/ApplicationValidationException.html new file mode 100644 index 00000000..1c93b787 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/ApplicationValidationException.html @@ -0,0 +1,285 @@ + + + + + +ApplicationValidationException (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.paypal.butterfly.extensions.api.exception
+

Class ApplicationValidationException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class ApplicationValidationException
+extends ButterflyRuntimeException
    +
    Thrown whenever the application to be transformed is not in a valid state.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ApplicationValidationException

        +
        public ApplicationValidationException(java.lang.String exceptionMessage)
        +
        • +
      + + + +
        +
      • +

        ApplicationValidationException

        +
        public ApplicationValidationException(java.lang.String exceptionMessage,
+                                      java.lang.Throwable throwable)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/ButterflyException.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/ButterflyException.html new file mode 100644 index 00000000..b5023d09 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/ButterflyException.html @@ -0,0 +1,279 @@ + + + + + +ButterflyException (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.paypal.butterfly.extensions.api.exception
+

Class ButterflyException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    Direct Known Subclasses:
    +
    TemplateResolutionException
    +
    +
    +
    +
    public class ButterflyException
+extends java.lang.Exception
    +
    Butterfly generic checked exception.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      ButterflyException(java.lang.String exceptionMessage) 
      ButterflyException(java.lang.String exceptionMessage, + java.lang.Throwable throwable) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ButterflyException

        +
        public ButterflyException(java.lang.String exceptionMessage)
        +
        • +
      + + + +
        +
      • +

        ButterflyException

        +
        public ButterflyException(java.lang.String exceptionMessage,
+                          java.lang.Throwable throwable)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/ButterflyRuntimeException.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/ButterflyRuntimeException.html new file mode 100644 index 00000000..8583198b --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/ButterflyRuntimeException.html @@ -0,0 +1,284 @@ + + + + + +ButterflyRuntimeException (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.paypal.butterfly.extensions.api.exception
+

Class ButterflyRuntimeException

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ButterflyRuntimeException

        +
        public ButterflyRuntimeException(java.lang.String exceptionMessage)
        +
        • +
      + + + +
        +
      • +

        ButterflyRuntimeException

        +
        public ButterflyRuntimeException(java.lang.String exceptionMessage,
+                                 java.lang.Throwable throwable)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TemplateResolutionException.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TemplateResolutionException.html new file mode 100644 index 00000000..2113f9f2 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TemplateResolutionException.html @@ -0,0 +1,300 @@ + + + + + +TemplateResolutionException (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.paypal.butterfly.extensions.api.exception
+

Class TemplateResolutionException

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        TemplateResolutionException

        +
        public TemplateResolutionException(java.lang.String message)
        +
        This exception is thrown by Extension.automaticResolution(File) + whenever transformation template cannot be resolved
        +
        +
        Parameters:
        +
        message - explains why a transformation template could not be chosen
        +
        +
        • +
      + + + +
        +
      • +

        TemplateResolutionException

        +
        public TemplateResolutionException(java.lang.String message,
+                                   java.lang.Throwable throwable)
        +
        This exception is thrown by Extension.automaticResolution(File) + whenever transformation template cannot be resolved
        +
        +
        Parameters:
        +
        message - explains why a transformation template could not be chosen
        +
        throwable - reason why a transformation template could not be chosen
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TransformationDefinitionException.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TransformationDefinitionException.html new file mode 100644 index 00000000..f69bf981 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TransformationDefinitionException.html @@ -0,0 +1,285 @@ + + + + + +TransformationDefinitionException (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.paypal.butterfly.extensions.api.exception
+

Class TransformationDefinitionException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class TransformationDefinitionException
+extends ButterflyRuntimeException
    +
    Thrown whenever a transformation template definition is not well formed.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        TransformationDefinitionException

        +
        public TransformationDefinitionException(java.lang.String exceptionMessage)
        +
        • +
      + + + +
        +
      • +

        TransformationDefinitionException

        +
        public TransformationDefinitionException(java.lang.String exceptionMessage,
+                                         java.lang.Throwable throwable)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TransformationOperationException.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TransformationOperationException.html new file mode 100644 index 00000000..72b66877 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TransformationOperationException.html @@ -0,0 +1,293 @@ + + + + + +TransformationOperationException (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.paypal.butterfly.extensions.api.exception
+

Class TransformationOperationException

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        TransformationOperationException

        +
        public TransformationOperationException(java.lang.String exceptionMessage)
        +
        • +
      + + + +
        +
      • +

        TransformationOperationException

        +
        public TransformationOperationException(java.lang.String exceptionMessage,
+                                        java.lang.Throwable throwable)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TransformationUtilityException.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TransformationUtilityException.html new file mode 100644 index 00000000..ddc4e811 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/TransformationUtilityException.html @@ -0,0 +1,291 @@ + + + + + +TransformationUtilityException (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.paypal.butterfly.extensions.api.exception
+

Class TransformationUtilityException

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        TransformationUtilityException

        +
        public TransformationUtilityException(java.lang.String exceptionMessage)
        +
        • +
      + + + +
        +
      • +

        TransformationUtilityException

        +
        public TransformationUtilityException(java.lang.String exceptionMessage,
+                                      java.lang.Throwable throwable)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/package-frame.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/package-frame.html new file mode 100644 index 00000000..6cd95304 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/package-frame.html @@ -0,0 +1,26 @@ + + + + + +com.paypal.butterfly.extensions.api.exception (butterfly-extensions-api 3.2.1 API) + + + + + +

com.paypal.butterfly.extensions.api.exception

+
+

Exceptions

+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/package-summary.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/package-summary.html new file mode 100644 index 00000000..2542bf2d --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/package-summary.html @@ -0,0 +1,194 @@ + + + + + +com.paypal.butterfly.extensions.api.exception (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.paypal.butterfly.extensions.api.exception

+
+
Butterfly exceptions.
+
+

See: Description

+
+
+ + + + +

Package com.paypal.butterfly.extensions.api.exception Description

+
Butterfly exceptions.
+
+
Since:
+
1.0.0
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/package-tree.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/package-tree.html new file mode 100644 index 00000000..e31711fb --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/exception/package-tree.html @@ -0,0 +1,162 @@ + + + + + +com.paypal.butterfly.extensions.api.exception Class Hierarchy (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.paypal.butterfly.extensions.api.exception

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/AddElement.IfPresent.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/AddElement.IfPresent.html new file mode 100644 index 00000000..297b5b2e --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/AddElement.IfPresent.html @@ -0,0 +1,397 @@ + + + + + +AddElement.IfPresent (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api.operations
+

Enum AddElement.IfPresent

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<AddElement.IfPresent>
    +
    +
    +
    Enclosing interface:
    +
    AddElement<T extends TransformationOperation>
    +
    +
    +
    +
    public static enum AddElement.IfPresent
+extends java.lang.Enum<AddElement.IfPresent>
    +
    Possible behaviors in case the element to be added already exists. + Each of these options is related to instances of TOExecutionResult.Type, + although they are intentionally not supposed to match necessarily one-to-one.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      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
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static AddElement.IfPresentvalueOf(java.lang.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.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        Fail

        +
        public static final AddElement.IfPresent Fail
        +
        Fail if the element to be added is already present
        +
        • +
      + + + +
        +
      • +

        WarnNotAdd

        +
        public static final AddElement.IfPresent WarnNotAdd
        +
        Warn and do not add if the element to be added is already present
        +
        • +
      + + + +
        +
      • +

        WarnButAdd

        +
        public static final AddElement.IfPresent WarnButAdd
        +
        Warn, but add, if the element to be added is already present
        +
        • +
      + + + +
        +
      • +

        NoOp

        +
        public static final AddElement.IfPresent NoOp
        +
        Do nothing, not add, not warn neither fail, if the element to be added is already present
        +
        • +
      + + + +
        +
      • +

        Overwrite

        +
        public static final AddElement.IfPresent Overwrite
        +
        Overwrite and not warn if the element to be added is already present
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static AddElement.IfPresent[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (AddElement.IfPresent c : AddElement.IfPresent.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static AddElement.IfPresent valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/AddElement.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/AddElement.html new file mode 100644 index 00000000..7a0bb6e9 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/AddElement.html @@ -0,0 +1,357 @@ + + + + + +AddElement (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.paypal.butterfly.extensions.api.operations
+

Interface AddElement<T extends TransformationOperation>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    AddElementTO
    +
    +
    +
    +
    public 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. +
    +
    + Examples: +
      +
    • files
      • +
    • folders
      • +
    • properties, in properties files
      • +
    • POM dependencies
      • +
    • POM managed dependencies
      • +
    • POM plugins
      • +
    • POM managed plugins
      • +
    • POM properties
      • +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        failIfPresent

        +
        T failIfPresent()
        +
        Fail (TOExecutionResult.Type.ERROR) + if the element to be added is already present
        +
        +
        Returns:
        +
        the transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        warnNotAddIfPresent

        +
        T warnNotAddIfPresent()
        +
        Warn and do not add (TOExecutionResult.Type.WARNING) + if the element to be added is already present
        +
        +
        Returns:
        +
        the transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        warnButAddIfPresent

        +
        T warnButAddIfPresent()
        +
        Warn, but add, (TOExecutionResult.Type.WARNING) + if the element to be added is already present
        +
        +
        Returns:
        +
        the transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        noOpIfPresent

        +
        T noOpIfPresent()
        +
        Do nothing, not add, not warn neither fail, (TOExecutionResult.Type.NO_OP) + if the element to be added is already present
        +
        +
        Returns:
        +
        the transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        overwriteIfPresent

        +
        T overwriteIfPresent()
        +
        Overwrite and not warn (TOExecutionResult.Type.SUCCESS) + if the element to be added is already present
        +
        +
        Returns:
        +
        the transformation operation instance
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/AddElementTO.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/AddElementTO.html new file mode 100644 index 00000000..3987aa58 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/AddElementTO.html @@ -0,0 +1,471 @@ + + + + + +AddElementTO (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api.operations
+

Class AddElementTO<T extends AddElementTO>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    AddElement<T>, java.lang.Cloneable
    +
    +
    +
    +
    public abstract class AddElementTO<T extends AddElementTO>
+extends TransformationOperation<T>
+implements AddElement<T>
    +
    Convenience class with 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.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/ChangeOrRemoveElement.IfNotPresent.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/ChangeOrRemoveElement.IfNotPresent.html new file mode 100644 index 00000000..3e6bf272 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/ChangeOrRemoveElement.IfNotPresent.html @@ -0,0 +1,367 @@ + + + + + +ChangeOrRemoveElement.IfNotPresent (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api.operations
+

Enum ChangeOrRemoveElement.IfNotPresent

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + +
      Enum Constants 
      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
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static ChangeOrRemoveElement.IfNotPresentvalueOf(java.lang.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.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static ChangeOrRemoveElement.IfNotPresent[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (ChangeOrRemoveElement.IfNotPresent c : ChangeOrRemoveElement.IfNotPresent.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static ChangeOrRemoveElement.IfNotPresent valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/ChangeOrRemoveElement.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/ChangeOrRemoveElement.html new file mode 100644 index 00000000..3f72fed4 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/ChangeOrRemoveElement.html @@ -0,0 +1,313 @@ + + + + + +ChangeOrRemoveElement (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.paypal.butterfly.extensions.api.operations
+

Interface ChangeOrRemoveElement<T extends TransformationOperation>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    ChangeOrRemoveElementTO
    +
    +
    +
    +
    public 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. +
    +
    + Examples: +
      +
    • files
      • +
    • folders
      • +
    • properties, in properties files
      • +
    • POM dependencies
      • +
    • POM managed dependencies
      • +
    • POM plugins
      • +
    • POM managed plugins
      • +
    • POM properties
      • +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        failIfNotPresent

        +
        T failIfNotPresent()
        +
        Fail (TOExecutionResult.Type.ERROR) + if the element to be changed or removed is not present
        +
        +
        Returns:
        +
        the transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        warnIfNotPresent

        +
        T warnIfNotPresent()
        +
        Warn (TOExecutionResult.Type.WARNING) + if the element to be changed or removed is not present
        +
        +
        Returns:
        +
        the transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        noOpIfNotPresent

        +
        T noOpIfNotPresent()
        +
        Do nothing, not warn neither fail, (TOExecutionResult.Type.NO_OP) + if the element to be changed or removed is not present
        +
        +
        Returns:
        +
        the transformation operation instance
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/ChangeOrRemoveElementTO.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/ChangeOrRemoveElementTO.html new file mode 100644 index 00000000..31408df7 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/ChangeOrRemoveElementTO.html @@ -0,0 +1,421 @@ + + + + + +ChangeOrRemoveElementTO (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api.operations
+

Class ChangeOrRemoveElementTO<T extends ChangeOrRemoveElementTO>

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/package-frame.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/package-frame.html new file mode 100644 index 00000000..84c313a9 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/package-frame.html @@ -0,0 +1,31 @@ + + + + + +com.paypal.butterfly.extensions.api.operations (butterfly-extensions-api 3.2.1 API) + + + + + +

com.paypal.butterfly.extensions.api.operations

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/package-summary.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/package-summary.html new file mode 100644 index 00000000..47a591da --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/package-summary.html @@ -0,0 +1,211 @@ + + + + + +com.paypal.butterfly.extensions.api.operations (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.paypal.butterfly.extensions.api.operations

+
+
Basic transformation operations.
+
+

See: Description

+
+
+ + + + +

Package com.paypal.butterfly.extensions.api.operations Description

+
Basic transformation operations.
+
+
Since:
+
1.0.0
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/package-tree.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/package-tree.html new file mode 100644 index 00000000..01ae0c12 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/operations/package-tree.html @@ -0,0 +1,162 @@ + + + + + +com.paypal.butterfly.extensions.api.operations Class Hierarchy (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.paypal.butterfly.extensions.api.operations

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/package-frame.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/package-frame.html new file mode 100644 index 00000000..bb731890 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/package-frame.html @@ -0,0 +1,47 @@ + + + + + +com.paypal.butterfly.extensions.api (butterfly-extensions-api 3.2.1 API) + + + + + +

com.paypal.butterfly.extensions.api

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/package-summary.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/package-summary.html new file mode 100644 index 00000000..40759dca --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/package-summary.html @@ -0,0 +1,317 @@ + + + + + +com.paypal.butterfly.extensions.api (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.paypal.butterfly.extensions.api

+
+
API component to be used by Butterfly extensions when providing their + transformation and upgrade templates.
+
+

See: Description

+
+
+ + + + +

Package com.paypal.butterfly.extensions.api Description

+
API component to be used by Butterfly extensions when providing their + transformation and upgrade templates.
+
+
Since:
+
1.0.0
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/package-tree.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/package-tree.html new file mode 100644 index 00000000..6cd72e71 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/package-tree.html @@ -0,0 +1,179 @@ + + + + + +com.paypal.butterfly.extensions.api Class Hierarchy (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.paypal.butterfly.extensions.api

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/UpgradeStep.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/UpgradeStep.html new file mode 100644 index 00000000..75e4f499 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/UpgradeStep.html @@ -0,0 +1,380 @@ + + + + + +UpgradeStep (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api.upgrade
+

Class UpgradeStep

+
+
+ +
+
    +
  • +
    +
    +
    public abstract class UpgradeStep
+extends TransformationTemplate
    +
    A special type of upgrade template that takes an application + from one minor version to the next subsequent available version.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        UpgradeStep

        +
        public UpgradeStep()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getNextVersion

        +
        public abstract java.lang.String getNextVersion()
        +
        Returns the version the application would be upgraded to
        +
        +
        Returns:
        +
        the version the application would be upgraded to
        +
        +
        • +
      + + + + + + + +
        +
      • +

        setBlank

        +
        public void setBlank(boolean blank)
        +
        Description copied from class: TransformationTemplate
        +
        Sets whether this is a blank transformation template or not. + Commonly transformations are done by first copying all files and folders the current application has, and then performing a set of ordered operations, + one by one, on top of those files, until the final result is reached. + However, a few times transformations might be so massive that it would make more sense to take a reverse approach, starting from a blank folder, + followed by a set of copies from the original application folder plus eventual operations. + This reverse approach is called "blank transformation". + By default transformation templates are not blank. Notice that UpgradeStep cannot be blank.
        +
        +
        Overrides:
        +
        setBlank in class TransformationTemplate
        +
        Parameters:
        +
        blank - whether this is a blank transformation template or not
        +
        +
        • +
      + + + +
        +
      • +

        getCurrentVersion

        +
        public abstract java.lang.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
        +
        +
        Returns:
        +
        the current version of the application
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/package-frame.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/package-frame.html new file mode 100644 index 00000000..1a2e850e --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/package-frame.html @@ -0,0 +1,20 @@ + + + + + +com.paypal.butterfly.extensions.api.upgrade (butterfly-extensions-api 3.2.1 API) + + + + + +

com.paypal.butterfly.extensions.api.upgrade

+
+

Classes

+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/package-summary.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/package-summary.html new file mode 100644 index 00000000..465bd4af --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/package-summary.html @@ -0,0 +1,156 @@ + + + + + +com.paypal.butterfly.extensions.api.upgrade (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.paypal.butterfly.extensions.api.upgrade

+
+
API to support defining upgrade transformation templates.
+
+

See: Description

+
+
+ + + + +

Package com.paypal.butterfly.extensions.api.upgrade Description

+
API to support defining upgrade transformation templates.
+
+
Since:
+
1.0.0
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/package-tree.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/package-tree.html new file mode 100644 index 00000000..1c7484ea --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/upgrade/package-tree.html @@ -0,0 +1,139 @@ + + + + + +com.paypal.butterfly.extensions.api.upgrade Class Hierarchy (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.paypal.butterfly.extensions.api.upgrade

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/Abort.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/Abort.html new file mode 100644 index 00000000..f8740e96 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/Abort.html @@ -0,0 +1,407 @@ + + + + + +Abort (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api.utilities
+

Class Abort

+
+
+ +
+ +
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setAbortionMessage

        +
        public Abort setAbortionMessage(java.lang.String abortionMessage)
        +
        Set the reason to abort the transformation
        +
        +
        Parameters:
        +
        abortionMessage - the reason to abort the transformation
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        Description copied from class: TransformationUtility
        +
        Returns a short one line, but SPECIFIC, description about the transformation + utility, including mentioning the files and/or folders + to be manipulated. This is supposed to be an one line statement about the + specific transformation utility that was executed. This would be used for example in + log statements or user interfaces.
        +
        +
        Specified by:
        +
        getDescription in class TransformationUtility<Abort>
        +
        Returns:
        +
        a short one line, but specific, description about the transformation + utility
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected ExecutionResult execution(java.io.File transformedAppFolder,
+                                    TransformationContext transformationContext)
        +
        Description copied from class: TransformationUtility
        +
        The implementation execution of this transformation utility. + The returned object is the result of the execution and is always + automatically saved in the transformation context as a new + attribute (whose key is the name of the transformation utility), unless + TransformationUtility.isSaveResult() returns false. +
        + Important: this method MUST NEVER return null, and it must catch its executions exceptions + and wrap them into a ExecutionResult error object.
        +
        +
        Specified by:
        +
        execution in class TransformationUtility<Abort>
        +
        Parameters:
        +
        transformedAppFolder - the folder where the transformed application code is
        +
        transformationContext - the transformation context object
        +
        Returns:
        +
        an object with the result of this execution, to be better defined + by the concrete utility class, since its type is generic
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/Log.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/Log.html new file mode 100644 index 00000000..42d62770 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/Log.html @@ -0,0 +1,497 @@ + + + + + +Log (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api.utilities
+

Class Log

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class Log
+extends TransformationUtility<Log>
    +
    Provides logging statements during transformation time. + Since all it does is logging, it always returns TUExecutionResult.Type.NULL as result of + execution. +
    + If no log level is defined, then it will be set to INFO, except + when there is only one attribute and it is null. In this case + it will be set to WARNING.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Log

        +
        public Log()
        +
        Utility to provide logging statements during transformation time. + Since all it does is logging, it returns as result of execution + the log message
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setLogLevel

        +
        public Log setLogLevel(org.slf4j.event.Level logLevel)
        +
        Sets the log level
        +
        +
        Parameters:
        +
        logLevel - log level
        +
        Returns:
        +
        this transformation utility object
        +
        +
        • +
      + + + +
        +
      • +

        setLogMessage

        +
        public Log setLogMessage(java.lang.String logMessage)
        +
        Sets the log message
        +
        +
        Parameters:
        +
        logMessage - log message
        +
        Returns:
        +
        this transformation utility object
        +
        +
        • +
      + + + +
        +
      • +

        getLogLevel

        +
        public org.slf4j.event.Level getLogLevel()
        +
        Returns the log level
        +
        +
        Returns:
        +
        the log level
        +
        +
        • +
      + + + +
        +
      • +

        getLogMessage

        +
        public java.lang.String getLogMessage()
        +
        Returns the log message
        +
        +
        Returns:
        +
        the log message
        +
        +
        • +
      + + + +
        +
      • +

        getAttributeNames

        +
        public java.lang.String[] getAttributeNames()
        +
        Returns a copy of the array containing + all attribute names used by this Log transformation utility. + Returns null if there are no attributes.
        +
        +
        Returns:
        +
        all attribute names used by this Log transformation utility
        +
        +
        • +
      + + + +
        +
      • +

        setAttributeNames

        +
        public Log setAttributeNames(java.lang.String... attributeNames)
        +
        Sets names of transformation context attributes to be used + as arguments for this log statement
        +
        +
        Parameters:
        +
        attributeNames - names of transformation context attributes to be + used as arguments for this log statement
        +
        Returns:
        +
        this transformation utility object
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        Description copied from class: TransformationUtility
        +
        Returns a short one line, but SPECIFIC, description about the transformation + utility, including mentioning the files and/or folders + to be manipulated. This is supposed to be an one line statement about the + specific transformation utility that was executed. This would be used for example in + log statements or user interfaces.
        +
        +
        Specified by:
        +
        getDescription in class TransformationUtility<Log>
        +
        Returns:
        +
        a short one line, but specific, description about the transformation + utility
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected TUExecutionResult execution(java.io.File transformedAppFolder,
+                                      TransformationContext transformationContext)
        +
        Description copied from class: TransformationUtility
        +
        The implementation execution of this transformation utility. + The returned object is the result of the execution and is always + automatically saved in the transformation context as a new + attribute (whose key is the name of the transformation utility), unless + TransformationUtility.isSaveResult() returns false. +
        + Important: this method MUST NEVER return null, and it must catch its executions exceptions + and wrap them into a ExecutionResult error object.
        +
        +
        Specified by:
        +
        execution in class TransformationUtility<Log>
        +
        Parameters:
        +
        transformedAppFolder - the folder where the transformed application code is
        +
        transformationContext - the transformation context object
        +
        Returns:
        +
        an object with the result of this execution, to be better defined + by the concrete utility class, since its type is generic
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/ManualInstruction.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/ManualInstruction.html new file mode 100644 index 00000000..8b6cd4c7 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/ManualInstruction.html @@ -0,0 +1,405 @@ + + + + + +ManualInstruction (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api.utilities
+

Class ManualInstruction

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class ManualInstruction
+extends TransformationUtility<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. +
    + In the end of the transformation, every manual instruction is reported in order of registration as Markdown (.md) files.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ManualInstruction

        +
        public ManualInstruction(java.lang.String description,
+                         java.lang.String resourceName)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setDescription

        +
        public ManualInstruction setDescription(java.lang.String description)
        +
        • +
      + + + +
        +
      • +

        setResourceName

        +
        public ManualInstruction setResourceName(java.lang.String resourceName)
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        Description copied from class: TransformationUtility
        +
        Returns a short one line, but SPECIFIC, description about the transformation + utility, including mentioning the files and/or folders + to be manipulated. This is supposed to be an one line statement about the + specific transformation utility that was executed. This would be used for example in + log statements or user interfaces.
        +
        +
        Specified by:
        +
        getDescription in class TransformationUtility<ManualInstruction>
        +
        Returns:
        +
        a short one line, but specific, description about the transformation + utility
        +
        +
        • +
      + + + +
        +
      • +

        getResourceName

        +
        public java.lang.String getResourceName()
        +
        Returns the instruction resource name
        +
        +
        Returns:
        +
        the instruction resource name
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected ExecutionResult execution(java.io.File transformedAppFolder,
+                                    TransformationContext transformationContext)
        +
        Description copied from class: TransformationUtility
        +
        The implementation execution of this transformation utility. + The returned object is the result of the execution and is always + automatically saved in the transformation context as a new + attribute (whose key is the name of the transformation utility), unless + TransformationUtility.isSaveResult() returns false. +
        + Important: this method MUST NEVER return null, and it must catch its executions exceptions + and wrap them into a ExecutionResult error object.
        +
        +
        Specified by:
        +
        execution in class TransformationUtility<ManualInstruction>
        +
        Parameters:
        +
        transformedAppFolder - the folder where the transformed application code is
        +
        transformationContext - the transformation context object
        +
        Returns:
        +
        an object with the result of this execution, to be better defined + by the concrete utility class, since its type is generic
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/MapValue.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/MapValue.html new file mode 100644 index 00000000..4f31ab0d --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/MapValue.html @@ -0,0 +1,480 @@ + + + + + +MapValue (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api.utilities
+

Class MapValue

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class MapValue
+extends TransformationUtility<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. 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. +
    + The new attribute saved into the transformation context is named based on the utility name, unless + TransformationUtility.setContextAttributeName(String) is called, as usual, nothing new here.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MapValue

        +
        public 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. 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. +
        + The new attribute saved into the transformation context is named based on the utility name, unless + TransformationUtility.setContextAttributeName(String) is called, as usual, nothing new here.
        +
        • +
      + + + +
        +
      • +

        MapValue

        +
        public MapValue(java.lang.String mapName,
+                java.lang.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. 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. +
        + The new attribute saved into the transformation context is named based on the utility name, unless + TransformationUtility.setContextAttributeName(String) is called, as usual, nothing new here.
        +
        +
        Parameters:
        +
        mapName - the name of the transformation context attribute that holds the map object
        +
        key - the key used to get the map entry
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setMapName

        +
        public MapValue setMapName(java.lang.String mapName)
        +
        Set the name of the transformation context attribute that holds the map object
        +
        +
        Parameters:
        +
        mapName - the name of the transformation context attribute that holds the map object
        +
        Returns:
        +
        this utility instance
        +
        +
        • +
      + + + +
        +
      • +

        setKey

        +
        public MapValue setKey(java.lang.Object key)
        +
        Set the key used to get the map entry
        +
        +
        Parameters:
        +
        key - the key used to get the map entry
        +
        Returns:
        +
        this utility instance
        +
        +
        • +
      + + + +
        +
      • +

        getMapName

        +
        public java.lang.String getMapName()
        +
        Return the name of the transformation context attribute that holds the map object
        +
        +
        Returns:
        +
        the name of the transformation context attribute that holds the map object
        +
        +
        • +
      + + + +
        +
      • +

        getKey

        +
        public java.lang.Object getKey()
        +
        Returns he key used to get the map entry
        +
        +
        Returns:
        +
        the key used to get the map entry
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        Description copied from class: TransformationUtility
        +
        Returns a short one line, but SPECIFIC, description about the transformation + utility, including mentioning the files and/or folders + to be manipulated. This is supposed to be an one line statement about the + specific transformation utility that was executed. This would be used for example in + log statements or user interfaces.
        +
        +
        Specified by:
        +
        getDescription in class TransformationUtility<MapValue>
        +
        Returns:
        +
        a short one line, but specific, description about the transformation + utility
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected ExecutionResult execution(java.io.File transformedAppFolder,
+                                    TransformationContext transformationContext)
        +
        Description copied from class: TransformationUtility
        +
        The implementation execution of this transformation utility. + The returned object is the result of the execution and is always + automatically saved in the transformation context as a new + attribute (whose key is the name of the transformation utility), unless + TransformationUtility.isSaveResult() returns false. +
        + Important: this method MUST NEVER return null, and it must catch its executions exceptions + and wrap them into a ExecutionResult error object.
        +
        +
        Specified by:
        +
        execution in class TransformationUtility<MapValue>
        +
        Parameters:
        +
        transformedAppFolder - the folder where the transformed application code is
        +
        transformationContext - the transformation context object
        +
        Returns:
        +
        an object with the result of this execution, to be better defined + by the concrete utility class, since its type is generic
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/ResultCondition.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/ResultCondition.html new file mode 100644 index 00000000..525b046a --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/ResultCondition.html @@ -0,0 +1,476 @@ + + + + + +ResultCondition (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.extensions.api.utilities
+

Class ResultCondition

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class ResultCondition
+extends UtilityCondition<ResultCondition>
    +
    Checks the perform result, and optionally execution result as well, of a TransformationUtility instance. + If a result for the specified utility name is not found, this condition returns false, but with a warning.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ResultCondition

        +
        public ResultCondition()
        +
        • +
      + + + +
        +
      • +

        ResultCondition

        +
        public ResultCondition(java.lang.String utilityName)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setUtilityName

        +
        public ResultCondition setUtilityName(java.lang.String utilityName)
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        getUtilityName

        +
        public java.lang.String getUtilityName()
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        Description copied from class: TransformationUtility
        +
        Returns a short one line, but SPECIFIC, description about the transformation + utility, including mentioning the files and/or folders + to be manipulated. This is supposed to be an one line statement about the + specific transformation utility that was executed. This would be used for example in + log statements or user interfaces.
        +
        +
        Specified by:
        +
        getDescription in class TransformationUtility<ResultCondition>
        +
        Returns:
        +
        a short one line, but specific, description about the transformation + utility
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected TUExecutionResult execution(java.io.File transformedAppFolder,
+                                      TransformationContext transformationContext)
        +
        Description copied from class: TransformationUtility
        +
        The implementation execution of this transformation utility. + The returned object is the result of the execution and is always + automatically saved in the transformation context as a new + attribute (whose key is the name of the transformation utility), unless + TransformationUtility.isSaveResult() returns false. +
        + Important: this method MUST NEVER return null, and it must catch its executions exceptions + and wrap them into a ExecutionResult error object.
        +
        +
        Specified by:
        +
        execution in class TransformationUtility<ResultCondition>
        +
        Parameters:
        +
        transformedAppFolder - the folder where the transformed application code is
        +
        transformationContext - the transformation context object
        +
        Returns:
        +
        an object with the result of this execution, to be better defined + by the concrete utility class, since its type is generic
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/package-frame.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/package-frame.html new file mode 100644 index 00000000..2f8ddbe1 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/package-frame.html @@ -0,0 +1,24 @@ + + + + + +com.paypal.butterfly.extensions.api.utilities (butterfly-extensions-api 3.2.1 API) + + + + + +

com.paypal.butterfly.extensions.api.utilities

+
+

Classes

+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/package-summary.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/package-summary.html new file mode 100644 index 00000000..fbe3a42b --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/package-summary.html @@ -0,0 +1,181 @@ + + + + + +com.paypal.butterfly.extensions.api.utilities (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.paypal.butterfly.extensions.api.utilities

+
+
Basic transformation utilities.
+
+

See: Description

+
+
+ + + + +

Package com.paypal.butterfly.extensions.api.utilities Description

+
Basic transformation utilities.
+
+
Since:
+
1.0.0
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/package-tree.html b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/package-tree.html new file mode 100644 index 00000000..b3654ff6 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/com/paypal/butterfly/extensions/api/utilities/package-tree.html @@ -0,0 +1,147 @@ + + + + + +com.paypal.butterfly.extensions.api.utilities Class Hierarchy (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.paypal.butterfly.extensions.api.utilities

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/constant-values.html b/docs/javadocs/3.2.1/butterfly-extensions-api/constant-values.html new file mode 100644 index 00000000..54ace299 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/constant-values.html @@ -0,0 +1,170 @@ + + + + + +Constant Field Values (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+ +
+
+ + +

com.paypal.*

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/deprecated-list.html b/docs/javadocs/3.2.1/butterfly-extensions-api/deprecated-list.html new file mode 100644 index 00000000..5e99ef3b --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/deprecated-list.html @@ -0,0 +1,153 @@ + + + + + +Deprecated List (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+ +
+
+ + + +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/help-doc.html b/docs/javadocs/3.2.1/butterfly-extensions-api/help-doc.html new file mode 100644 index 00000000..28000c75 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/help-doc.html @@ -0,0 +1,223 @@ + + + + + +API Help (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+ +This help file applies to API documentation generated using the standard doclet.
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/index-all.html b/docs/javadocs/3.2.1/butterfly-extensions-api/index-all.html new file mode 100644 index 00000000..ab1937f9 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/index-all.html @@ -0,0 +1,1469 @@ + + + + + +Index (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A B C D E F G H I L M N O P R S T U V W  + + +

A

+
+
Abort - Class in com.paypal.butterfly.extensions.api.utilities
+
+
Aborts the transformation immediately.
+
+
Abort() - Constructor for class com.paypal.butterfly.extensions.api.utilities.Abort
+
+
This transformation utility abort the transformation.
+
+
Abort(String) - Constructor for class com.paypal.butterfly.extensions.api.utilities.Abort
+
+
This transformation utility abort the transformation.
+
+
abortOnFailure(boolean) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
If set to true, abort the whole transformation if validation or execution fails.
+
+
abortOnFailure(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Abort the whole transformation if validation or execution fails.
+
+
absolute(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
There are two ways to specify the file, or folder, the transformation + utility is suppose to perform against.
+
+
absolute(String, String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Same as TransformationUtility.absolute(String, String), however, the absolute + file is set with an additional relative path, which is defined via parameter + additionalRelativePath.
+
+
add(Class<? extends TransformationTemplate>) - Method in class com.paypal.butterfly.extensions.api.Extension
+
+
Adds a new transformation template class to the set
+
+
add(TransformationUtility) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
+
Adds a new transformation utility to the end of the list.
+
+
add(TransformationUtility, String) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
+
Adds a new transformation utility to the end of the list.
+
+
add(TransformationUtility) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
+
 
+
add(TransformationUtility, String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
+
 
+
AddElement<T extends TransformationOperation> - Interface in com.paypal.butterfly.extensions.api.operations
+
+
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 - Enum in com.paypal.butterfly.extensions.api.operations
+
+
Possible behaviors in case the element to be added already exists.
+
+
AddElementTO<T extends AddElementTO> - Class in com.paypal.butterfly.extensions.api.operations
+
+
Convenience class with AddElement implementation ready for TransformationOperation subclasses.
+
+
AddElementTO() - Constructor for class com.paypal.butterfly.extensions.api.operations.AddElementTO
+
 
+
addMultiple(TransformationOperation, String...) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
+
Adds a special transformation utility to perform multiple transformation operations against + multiple files specified as a list, held as a transformation context attribute +
+
+
addMultiple(TransformationOperation, String...) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
+
 
+
ApplicationValidationException - Exception in com.paypal.butterfly.extensions.api.exception
+
+
Thrown whenever the application to be transformed is not in a valid state.
+
+
ApplicationValidationException(String) - Constructor for exception com.paypal.butterfly.extensions.api.exception.ApplicationValidationException
+
 
+
ApplicationValidationException(String, Throwable) - Constructor for exception com.paypal.butterfly.extensions.api.exception.ApplicationValidationException
+
 
+
applyPropertiesFromContext(TransformationContext) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Applies transformation utility properties during transformation time, but + prior to execution (right before it).
+
+
automaticResolution(File) - Method in class com.paypal.butterfly.extensions.api.Extension
+
+
Butterfly might be able to automatically identify the type of application + and which transformation template to be applied to it.
+
+
+ + + +

B

+
+
BASELINE - Static variable in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
 
+
ButterflyException - Exception in com.paypal.butterfly.extensions.api.exception
+
+
Butterfly generic checked exception.
+
+
ButterflyException(String) - Constructor for exception com.paypal.butterfly.extensions.api.exception.ButterflyException
+
 
+
ButterflyException(String, Throwable) - Constructor for exception com.paypal.butterfly.extensions.api.exception.ButterflyException
+
 
+
ButterflyRuntimeException - Exception in com.paypal.butterfly.extensions.api.exception
+
+
Butterfly generic runtime exception.
+
+
ButterflyRuntimeException(String) - Constructor for exception com.paypal.butterfly.extensions.api.exception.ButterflyRuntimeException
+
 
+
ButterflyRuntimeException(String, Throwable) - Constructor for exception com.paypal.butterfly.extensions.api.exception.ButterflyRuntimeException
+
 
+
+ + + +

C

+
+
ChangeOrRemoveElement<T extends TransformationOperation> - Interface in com.paypal.butterfly.extensions.api.operations
+
+
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 - Enum in com.paypal.butterfly.extensions.api.operations
+
+
Possible behaviors in case the element to be changed or removed is not present.
+
+
ChangeOrRemoveElementTO<T extends ChangeOrRemoveElementTO> - Class in com.paypal.butterfly.extensions.api.operations
+
+
Convenience class with ChangeOrRemoveElement implementation ready for TransformationOperation subclasses.
+
+
ChangeOrRemoveElementTO() - Constructor for class com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElementTO
+
 
+
changeTypeOnWarning() - Method in class com.paypal.butterfly.extensions.api.PerformResult
+
 
+
changeTypeOnWarning() - Method in class com.paypal.butterfly.extensions.api.TOExecutionResult
+
 
+
changeTypeOnWarning() - Method in class com.paypal.butterfly.extensions.api.TUExecutionResult
+
 
+
checkDependencies(TransformationContext) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Check if any of dependency of this TU failed.
+
+
checkForBlankString(String, String) - Static method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Check if value is a blank String, if it is, then a + TransformationDefinitionException is thrown.
+
+
checkForEmptyString(String, String) - Static method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Check if value is an empty String, if it is, then a + TransformationDefinitionException is thrown.
+
+
checkForNull(String, Object) - Static method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Check if value is null, if it is, then a + TransformationDefinitionException is thrown.
+
+
clone() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
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.
+
+
clone() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
+
 
+
com.paypal.butterfly.extensions.api - package 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 - package com.paypal.butterfly.extensions.api.exception
+
+
Butterfly exceptions.
+
+
com.paypal.butterfly.extensions.api.operations - package com.paypal.butterfly.extensions.api.operations
+
+
Basic transformation operations.
+
+
com.paypal.butterfly.extensions.api.upgrade - package com.paypal.butterfly.extensions.api.upgrade
+
+
API to support defining upgrade transformation templates.
+
+
com.paypal.butterfly.extensions.api.utilities - package com.paypal.butterfly.extensions.api.utilities
+
+
Basic transformation utilities.
+
+
compare(File, File) - Method in class com.paypal.butterfly.extensions.api.DoubleCondition
+
+
Returns true only if the compared files meet the comparison + criteria established and implemented by the subclass
+
+
contains(String) - Method in interface com.paypal.butterfly.extensions.api.TransformationContext
+
+
Return true if the transformation context has an attribute whose name is name
+
+
ContextAttributeRetriever<T> - Class in com.paypal.butterfly.extensions.api
+
+
Transformation utility to fetch transformation context attributes post + transformation time, since they are always set + during transformation time.
+
+
ContextAttributeRetriever() - Constructor for class com.paypal.butterfly.extensions.api.ContextAttributeRetriever
+
 
+
ContextAttributeRetriever(String) - Constructor for class com.paypal.butterfly.extensions.api.ContextAttributeRetriever
+
 
+
copy() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Creates and returns a copy object similar to the original object.
+
+
+ + + +

D

+
+
debug(String) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
 
+
debug(String, String...) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
 
+
debug(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
+
 
+
debug(String, String...) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
+
 
+
dependencyFailureCheck() - Method in class com.paypal.butterfly.extensions.api.PerformResult
+
 
+
dependencyFailureCheck() - Method in class com.paypal.butterfly.extensions.api.TOExecutionResult
+
 
+
dependencyFailureCheck() - Method in class com.paypal.butterfly.extensions.api.TUExecutionResult
+
 
+
dependsOn(String...) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Add all transformation utilities this utility depends on.
+
+
DoubleCondition<T extends DoubleCondition> - Class in com.paypal.butterfly.extensions.api
+
+
Transformation utility condition to determine if a transformation utility + should be executed or not, based on a two files criteria.
+
+
DoubleCondition() - Constructor for class com.paypal.butterfly.extensions.api.DoubleCondition
+
+
Condition to determine if a transformation utility + should be executed or not.
+
+
DoubleCondition(String) - Constructor for class com.paypal.butterfly.extensions.api.DoubleCondition
+
+
Condition to determine if a transformation utility + should be executed or not.
+
+
+ + + +

E

+
+
equals(Object) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Compare this instance against the specified object, and return + true only if they are equal.
+
+
error(TransformationUtility, Exception, String) - Static method in class com.paypal.butterfly.extensions.api.PerformResult
+
+
This means The TU failed, but not because of its utility execution itself, but because of an internal reason.
+
+
error(TransformationUtility, Exception) - Static method in class com.paypal.butterfly.extensions.api.PerformResult
+
+
This means The TU failed, but not because of its utility execution itself, but because of an internal reason.
+
+
error(TransformationOperation, Exception) - Static method in class com.paypal.butterfly.extensions.api.TOExecutionResult
+
+
Creates and returns a new TOExecutionResult.Type.ERROR result
+
+
error(TransformationOperation, Exception, String) - Static method in class com.paypal.butterfly.extensions.api.TOExecutionResult
+
+
Creates and returns a new TOExecutionResult.Type.ERROR result
+
+
error(TransformationUtility, Exception) - Static method in class com.paypal.butterfly.extensions.api.TUExecutionResult
+
 
+
error(TransformationUtility, Exception, Object) - Static method in class com.paypal.butterfly.extensions.api.TUExecutionResult
+
 
+
error(TransformationUtility, Object, Exception, String) - Static method in class com.paypal.butterfly.extensions.api.TUExecutionResult
+
 
+
executeIf(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
When set, this TU will only execute if this transformation context + attribute is existent and its value is set to true (as String or Boolean).
+
+
executeIf(UtilityCondition) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
When set, this TU will only execute if this utilityCondition object, + executed right before this TU, result in true.
+
+
executeUnless(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
When set, this TU will execute, unless this transformation context + attribute is existent and its value is set to true (as String or Boolean).
+
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.ContextAttributeRetriever
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.DoubleCondition
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.FilterFiles
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.MultipleConditions
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.MultipleOperations
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
The implementation execution of this transformation utility.
+
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
+
+
Returns, as its value, the condition to keep iterating over this loop
+
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.utilities.Abort
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.utilities.Log
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.utilities.ManualInstruction
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.utilities.MapValue
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.utilities.ResultCondition
+
 
+
ExecutionResult<S,R,T> - Class in com.paypal.butterfly.extensions.api
+
+
The meta-data object resulted after the TransformationUtility instance has been executed.
+
+
executionResult(TransformationUtility, ExecutionResult) - Static method in class com.paypal.butterfly.extensions.api.PerformResult
+
+
This means the utility has been executed, + and the result type is defined based on the utility execution result type.
+
+
Extension<E> - Class in com.paypal.butterfly.extensions.api
+
+
A Butterfly third-party extension.
+
+
Extension() - Constructor for class com.paypal.butterfly.extensions.api.Extension
+
 
+
+ + + +

F

+
+
failIfNotPresent() - Method in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement
+
+
Fail (TOExecutionResult.Type.ERROR) + if the element to be changed or removed is not present
+
+
failIfNotPresent() - Method in class com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElementTO
+
 
+
failIfPresent() - Method in interface com.paypal.butterfly.extensions.api.operations.AddElement
+
+
Fail (TOExecutionResult.Type.ERROR) + if the element to be added is already present
+
+
failIfPresent() - Method in class com.paypal.butterfly.extensions.api.operations.AddElementTO
+
 
+
FilterFiles - Class in com.paypal.butterfly.extensions.api
+
+
Transformation utility to filter a list of files based on a given + SingleCondition, + returning in a sub-list of files.
+
+
FilterFiles() - Constructor for class com.paypal.butterfly.extensions.api.FilterFiles
+
+
Utility to filter a list of files based on a given + SingleCondition, + returning in a sub-list of files
+
+
FilterFiles(SingleCondition) - Constructor for class com.paypal.butterfly.extensions.api.FilterFiles
+
+
Utility to filter a list of files based on a given + SingleCondition, + returning in a sub-list of files
+
+
+ + + +

G

+
+
get(String) - Method in interface com.paypal.butterfly.extensions.api.TransformationContext
+
+
Returns the attribute object associated with the key + (which is the attribute name), or null, if there is none
+
+
getAbortionMessage() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Returns a message to be logged if a fail happens and transformation has to be aborted
+
+
getAbsoluteFile(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Returns an absolute path to the file or folder the transformation + utility is supposed to perform against
+
+
getApplicationName() - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
+
Returns the name of the transformed application, + Returns null if the application name is unknown.
+
+
getApplicationType() - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
+
Returns the type of the transformed application, + Returns null if the application type is unknown.
+
+
getAttribute() - Method in class com.paypal.butterfly.extensions.api.DoubleCondition
+
+
Return the name of the transformation context attribute + that refers to the file to be compared against the + baseline file
+
+
getAttribute() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
+
 
+
getAttributeNames() - Method in class com.paypal.butterfly.extensions.api.utilities.Log
+
+
Returns a copy of the array containing + all attribute names used by this Log transformation utility.
+
+
getAttributeValue() - Method in class com.paypal.butterfly.extensions.api.ContextAttributeRetriever
+
+
Returns the value of the transformation context attribute + specified earlier.
+
+
getChildren() - Method in class com.paypal.butterfly.extensions.api.MultipleOperations
+
+
Returns all TransformationOperation instances generated out of the + transformation operation template.
+
+
getChildren() - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
 
+
getChildren() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
+
 
+
getChildren() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
+
 
+
getCondition() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
+
 
+
getConditionTemplate() - Method in class com.paypal.butterfly.extensions.api.FilterFiles
+
+
Return the single condition template to be evaluated against all files
+
+
getConditionTemplate() - Method in class com.paypal.butterfly.extensions.api.MultipleConditions
+
+
Return the condition template
+
+
getContextAttributeName() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Return the name to be used as key for the result of this utility + when saved into the transformation context.
+
+
getDependencies() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Returns an unmodifiable list of names of utilities this utility instance depends on.
+
+
getDescription() - Method in class com.paypal.butterfly.extensions.api.ContextAttributeRetriever
+
 
+
getDescription() - Method in class com.paypal.butterfly.extensions.api.Extension
+
+
Returns the extension description
+
+
getDescription() - Method in class com.paypal.butterfly.extensions.api.FilterFiles
+
 
+
getDescription() - Method in class com.paypal.butterfly.extensions.api.MultipleConditions
+
 
+
getDescription() - Method in class com.paypal.butterfly.extensions.api.MultipleOperations
+
 
+
getDescription() - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
+
Returns the transformation template description
+
+
getDescription() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Returns a short one line, but SPECIFIC, description about the transformation + utility, including mentioning the files and/or folders + to be manipulated.
+
+
getDescription() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
+
 
+
getDescription() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
+
 
+
getDescription() - Method in class com.paypal.butterfly.extensions.api.utilities.Abort
+
 
+
getDescription() - Method in class com.paypal.butterfly.extensions.api.utilities.Log
+
 
+
getDescription() - Method in class com.paypal.butterfly.extensions.api.utilities.ManualInstruction
+
 
+
getDescription() - Method in class com.paypal.butterfly.extensions.api.utilities.MapValue
+
 
+
getDescription() - Method in class com.paypal.butterfly.extensions.api.utilities.ResultCondition
+
 
+
getExecutionResult() - Method in class com.paypal.butterfly.extensions.api.PerformResult
+
+
Return the ExecutionResult object associated with this perform result
+
+
getExtensionClass() - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
+
Returns the class of the extension this transformation + template belongs to
+
+
getFilesAttributes() - Method in class com.paypal.butterfly.extensions.api.FilterFiles
+
+
Return an array containing the name of transformation context attributes + that hold the list of files to be filtered
+
+
getFilesAttributes() - Method in class com.paypal.butterfly.extensions.api.MultipleConditions
+
+
A copy of the array of transformation context attributes that hold list of Files + which the condition should perform against.
+
+
getFilesAttributes() - Method in class com.paypal.butterfly.extensions.api.MultipleOperations
+
+
Return an array containing the name of transformation context attributes + that hold the list of files the operations should be performed against
+
+
getIfConditionAttributeName() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Return the "if" condition attribute name associated with this transformation operation, + or null, if there is none
+
+
getIterations() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
+
 
+
getKey() - Method in class com.paypal.butterfly.extensions.api.utilities.MapValue
+
+
Returns he key used to get the map entry
+
+
getLogLevel() - Method in class com.paypal.butterfly.extensions.api.utilities.Log
+
+
Returns the log level
+
+
getLogMessage() - Method in class com.paypal.butterfly.extensions.api.utilities.Log
+
+
Returns the log message
+
+
getMapName() - Method in class com.paypal.butterfly.extensions.api.utilities.MapValue
+
+
Return the name of the transformation context attribute that holds the map object
+
+
getMode() - Method in class com.paypal.butterfly.extensions.api.MultipleConditions
+
+
Return the evaluation mode
+
+
getName() - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
 
+
getName() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
 
+
getNextIteration() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
+
 
+
getNextStep() - Method in class com.paypal.butterfly.extensions.api.upgrade.UpgradeStep
+
+
Returns the next UpgradeStep.
+
+
getNextVersion() - Method in class com.paypal.butterfly.extensions.api.upgrade.UpgradeStep
+
+
Returns the version the application would be upgraded to
+
+
getOrCreateReadFile(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.TransformationOperation
+
+
Creates and returns a temporary read-only copy of the file to be modified.
+
+
getOrder() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Returns the execution order for this utility on its parent.
+
+
getParent() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Returns the transformation utility parent
+
+
getPerformResultTypes() - Method in class com.paypal.butterfly.extensions.api.utilities.ResultCondition
+
 
+
getRelativePath() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Returns relative path (from the application root folder) to the + file or folder the transformation utility is suppose to perform against
+
+
getRelativePath(File, File) - Static method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Returns a relative path from baselineFile to targetFile.
+
+
getResourceName() - Method in class com.paypal.butterfly.extensions.api.utilities.ManualInstruction
+
+
Returns the instruction resource name
+
+
getResult(String) - Method in interface com.paypal.butterfly.extensions.api.TransformationContext
+
+
Returns the performing result of the TransformationUtility + identified by the specified name.
+
+
getRootPomFile(File) - Method in class com.paypal.butterfly.extensions.api.Extension
+
+
This is a convenience method in case the Extension subclass wants to implement its + Extension.automaticResolution(File) method based on one or more Maven pom files
+
+
getSimpleClassName() - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
+
Returns the transformation template class simple name + (see Class.getSimpleName()), or "AnonymousTransformationTemplate" + if that is an anonymous class
+
+
getSimpleClassName() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Returns the transformation utility class simple name + (see Class.getSimpleName()), or "AnonymousTransformationUtility" + if that is an anonymous class
+
+
getTemplate() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
+
 
+
getTemplateClasses() - Method in class com.paypal.butterfly.extensions.api.Extension
+
+
Returns a read-only set containing all transformation template classes
+
+
getTemplateOperation() - Method in class com.paypal.butterfly.extensions.api.MultipleOperations
+
 
+
getToExecutionResultTypes() - Method in class com.paypal.butterfly.extensions.api.utilities.ResultCondition
+
 
+
getTransformationTemplate() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Returns the transformation template this utility belongs to.
+
+
getTuExecutionResultTypes() - Method in class com.paypal.butterfly.extensions.api.utilities.ResultCondition
+
 
+
getUnlessConditionAttributeName() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Return the "unless" condition attribute name associated with this transformation operation, + or null, if there is none
+
+
getUtilities() - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
+
Returns a read-only ordered list of transformation utilities to be executed, + which defines the actual transformation offered by this template
+
+
getUtilities() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
+
 
+
getUtilityName() - Method in class com.paypal.butterfly.extensions.api.utilities.ResultCondition
+
 
+
getValue() - Method in class com.paypal.butterfly.extensions.api.TUExecutionResult
+
+
Returns the value returned by the transformation utility, which can be null
+
+
getVersion() - Method in class com.paypal.butterfly.extensions.api.Extension
+
+
Returns the extension version
+
+
+ + + +

H

+
+
hasBeenPerformed() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Returns true only if this utility has already been performed, even + if the execution was skipped.
+
+
hashCode() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
 
+
hashCode(int, Object...) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Calculates and return a hash code starting from the + hash code generated from superclass
+
+
+ + + +

I

+
+
ifNotPresent - Variable in class com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElementTO
+
 
+
ifPresent - Variable in class com.paypal.butterfly.extensions.api.operations.AddElementTO
+
 
+
info(String) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
 
+
info(String, String...) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
 
+
info(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
+
 
+
info(String, String...) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
+
 
+
isAbortOnFailure() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Returns whether this operation aborts the transformation or not in + case of an operation failure.
+
+
isBlank() - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
+
Returns true if this is a blank transformation template.
+
+
isExceptionType() - Method in class com.paypal.butterfly.extensions.api.PerformResult
+
 
+
isExceptionType() - Method in class com.paypal.butterfly.extensions.api.TOExecutionResult
+
 
+
isExceptionType() - Method in class com.paypal.butterfly.extensions.api.TUExecutionResult
+
 
+
isFileSet() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Return true only if a file has been set.
+
+
isSaveResult() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
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.
+
+
iterate() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
+
+
Returns a clone of this transformation utility loop ready for the next iteration
+
+
+ + + +

L

+
+
log(String) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
+
Deprecated.
+
+
log(Level, String) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
 
+
log(String, String...) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
+
Deprecated.
+
+
log(Level, String, String...) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
 
+
log(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
+
+
Deprecated.
+
+
log(Level, String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
+
 
+
log(String, String...) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
+
+
Deprecated.
+
+
log(Level, String, String...) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
+
 
+
Log - Class in com.paypal.butterfly.extensions.api.utilities
+
+
Provides logging statements during transformation time.
+
+
Log() - Constructor for class com.paypal.butterfly.extensions.api.utilities.Log
+
+
Utility to provide logging statements during transformation time.
+
+
loop(TransformationUtility, int) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
+
Execute an utility in a loop a number times specified in iterations
+
+
loop(TransformationUtility, String) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
+
Execute an utility in a loop while the value in TransformationContext attribute is true.
+
+
loop(TransformationUtility, UtilityCondition) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
+
Execute an utility in a loop while the execution value resulted by condition is true.
+
+
+ + + +

M

+
+
ManualInstruction - Class in com.paypal.butterfly.extensions.api.utilities
+
+
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.
+
+
ManualInstruction(String, String) - Constructor for class com.paypal.butterfly.extensions.api.utilities.ManualInstruction
+
 
+
MapValue - Class in com.paypal.butterfly.extensions.api.utilities
+
+
Obtains a specific entry from a Map object stored in the TransformationContext, + and store its value as a new attribute in the transformation context.
+
+
MapValue() - Constructor for class com.paypal.butterfly.extensions.api.utilities.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, Object) - Constructor for class com.paypal.butterfly.extensions.api.utilities.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.
+
+
MultipleConditions - Class in com.paypal.butterfly.extensions.api
+
+
Transformation utility condition to determine if a transformation utility should be executed or not, + based on a multiple files criteria.
+
+
MultipleConditions(SingleCondition) - Constructor for class com.paypal.butterfly.extensions.api.MultipleConditions
+
+
Perform one transformation utility condition against multiple files, + returning true if at least one file meets the condition (default mode).
+
+
MultipleConditions.Mode - Enum in com.paypal.butterfly.extensions.api
+
+
Execution mode for MultipleConditions.
+
+
MultipleOperations - Class in com.paypal.butterfly.extensions.api
+
+
Transformation utility to perform multiple transformation operations.
+
+
MultipleOperations() - Constructor for class com.paypal.butterfly.extensions.api.MultipleOperations
+
+
Utility to perform multiple transformation operations.
+
+
MultipleOperations(TransformationOperation) - Constructor for class com.paypal.butterfly.extensions.api.MultipleOperations
+
+
Utility to perform multiple transformation operations.
+
+
+ + + +

N

+
+
newConditionInstance(File) - Method in class com.paypal.butterfly.extensions.api.FilterFiles
+
+
Creates a new single condition instance copying from this current + object, but setting the file it should perform against based + on the input parameters
+
+
newConditionInstance(File) - Method in class com.paypal.butterfly.extensions.api.MultipleConditions
+
+
Creates a new condition instance copying from this current + object, but setting the file it should perform against based + on the input parameters
+
+
noOp(TransformationOperation, String) - Static method in class com.paypal.butterfly.extensions.api.TOExecutionResult
+
+
Creates and returns a new TOExecutionResult.Type.NO_OP result
+
+
noOpIfNotPresent() - Method in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement
+
+
Do nothing, not warn neither fail, (TOExecutionResult.Type.NO_OP) + if the element to be changed or removed is not present
+
+
noOpIfNotPresent() - Method in class com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElementTO
+
 
+
noOpIfPresent() - Method in interface com.paypal.butterfly.extensions.api.operations.AddElement
+
+
Do nothing, not add, not warn neither fail, (TOExecutionResult.Type.NO_OP) + if the element to be added is already present
+
+
noOpIfPresent() - Method in class com.paypal.butterfly.extensions.api.operations.AddElementTO
+
 
+
normalizeRelativePathSeparator(String) - Static method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
 
+
nullResult(TransformationUtility) - Static method in class com.paypal.butterfly.extensions.api.TUExecutionResult
+
 
+
nullResult(TransformationUtility, String) - Static method in class com.paypal.butterfly.extensions.api.TUExecutionResult
+
 
+
+ + + +

O

+
+
overwriteIfPresent() - Method in interface com.paypal.butterfly.extensions.api.operations.AddElement
+
+
Overwrite and not warn (TOExecutionResult.Type.SUCCESS) + if the element to be added is already present
+
+
overwriteIfPresent() - Method in class com.paypal.butterfly.extensions.api.operations.AddElementTO
+
 
+
+ + + +

P

+
+
perform(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.TransformationOperation
+
 
+
perform(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Performs the transformation utility against + the application to be transformed.
+
+
PerformResult - Class in com.paypal.butterfly.extensions.api
+
+
The meta-data object resulted after the TransformationUtility instance has been performed.
+
+
PerformResult.Type - Enum in com.paypal.butterfly.extensions.api
+
+
The type of result after the TransformationUtility instance has been performed.
+
+
+ + + +

R

+
+
relative(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Sets the relative path from the application root folder + to the file or folder the transformation utility should perform against.
+
+
ResultCondition - Class in com.paypal.butterfly.extensions.api.utilities
+
+
Checks the perform result, and optionally execution result as well, of a TransformationUtility instance.
+
+
ResultCondition() - Constructor for class com.paypal.butterfly.extensions.api.utilities.ResultCondition
+
 
+
ResultCondition(String) - Constructor for class com.paypal.butterfly.extensions.api.utilities.ResultCondition
+
 
+
run() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
+
+
Returns the TU instance to be run in the this iteration.
+
+
+ + + +

S

+
+
set(String, String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
This method allows setting properties in this transformation + utility during transformation time, right before its execution.
+
+
setAbortionMessage(String) - Method in class com.paypal.butterfly.extensions.api.utilities.Abort
+
+
Set the reason to abort the transformation
+
+
setAttribute(String) - Method in class com.paypal.butterfly.extensions.api.DoubleCondition
+
+
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)
+
+
setAttributeName(String) - Method in class com.paypal.butterfly.extensions.api.ContextAttributeRetriever
+
 
+
setAttributeNames(String...) - Method in class com.paypal.butterfly.extensions.api.utilities.Log
+
+
Sets names of transformation context attributes to be used + as arguments for this log statement
+
+
setBlank(boolean) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
+
Sets whether this is a blank transformation template or not.
+
+
setBlank(boolean) - Method in class com.paypal.butterfly.extensions.api.upgrade.UpgradeStep
+
 
+
setCondition(int) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
+
+
In this case the condition to execute the next iteration is based on + a pre-defined number of iterations to be executed.
+
+
setCondition(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
+
+
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.
+
+
setCondition(UtilityCondition) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
+
+
In this case the condition to execute the next iteration is based on + a UtilityCondition object whose result is true or false.
+
+
setConditionTemplate(SingleCondition) - Method in class com.paypal.butterfly.extensions.api.FilterFiles
+
+
Set the single condition template to be evaluated against all files
+
+
setConditionTemplate(SingleCondition) - Method in class com.paypal.butterfly.extensions.api.MultipleConditions
+
+
Set the utility condition template used to create conditions + to be evaluated against the list of files
+
+
setContextAttributeName(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Set the name to be used as key for the result of this utility + when saved into the transformation context.
+
+
setDescription(String) - Method in class com.paypal.butterfly.extensions.api.utilities.ManualInstruction
+
 
+
setFiles(String...) - Method in class com.paypal.butterfly.extensions.api.FilterFiles
+
+
Sets one or more transformation context attributes that hold list of Files + which the single condition should be evaluated against.
+
+
setFiles(String...) - Method in class com.paypal.butterfly.extensions.api.MultipleConditions
+
+
Sets one or more transformation context attributes that hold list of Files + which the condition should perform against.
+
+
setFiles(String...) - Method in class com.paypal.butterfly.extensions.api.MultipleOperations
+
+
Sets one or more transformation context attributes that hold list of Files + which the transformation operations should perform against.
+
+
setKey(Object) - Method in class com.paypal.butterfly.extensions.api.utilities.MapValue
+
+
Set the key used to get the map entry
+
+
setLogLevel(Level) - Method in class com.paypal.butterfly.extensions.api.utilities.Log
+
+
Sets the log level
+
+
setLogMessage(String) - Method in class com.paypal.butterfly.extensions.api.utilities.Log
+
+
Sets the log message
+
+
setMapName(String) - Method in class com.paypal.butterfly.extensions.api.utilities.MapValue
+
+
Set the name of the transformation context attribute that holds the map object
+
+
setMode(MultipleConditions.Mode) - Method in class com.paypal.butterfly.extensions.api.MultipleConditions
+
+
Set the evaluation mode.
+
+
setName(String) - Method in class com.paypal.butterfly.extensions.api.FilterFiles
+
 
+
setName(String) - Method in class com.paypal.butterfly.extensions.api.MultipleConditions
+
 
+
setName(String) - Method in class com.paypal.butterfly.extensions.api.MultipleOperations
+
 
+
setName(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Set this transformation utility instance name.
+
+
setName(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
+
 
+
setOperationTemplate(TransformationOperation) - Method in class com.paypal.butterfly.extensions.api.MultipleOperations
+
+
Sets the template of transformation operation to be performed against all specified files.
+
+
setParent(TransformationUtilityParent, int) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Register this utility to its parent, and also assign it a name + based on the parent name and order of execution.
+
+
setPerformResultTypes(PerformResult.Type...) - Method in class com.paypal.butterfly.extensions.api.utilities.ResultCondition
+
 
+
setProperties(String, String) - Method in class com.paypal.butterfly.extensions.api.MultipleOperations
+
+
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.
+
+
setPropertySetter() - Method in class com.paypal.butterfly.extensions.api.MultipleOperations
+
 
+
setResourceName(String) - Method in class com.paypal.butterfly.extensions.api.utilities.ManualInstruction
+
 
+
setSaveResult(boolean) - Method in class com.paypal.butterfly.extensions.api.TransformationOperation
+
 
+
setSaveResult(boolean) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
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.
+
+
setTemplate(TransformationUtility) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
+
+
Sets the transformation utility instance to be used as a template.
+
+
setToExecutionResultTypes(TOExecutionResult.Type...) - Method in class com.paypal.butterfly.extensions.api.utilities.ResultCondition
+
 
+
setTuExecutionResultTypes(TUExecutionResult.Type...) - Method in class com.paypal.butterfly.extensions.api.utilities.ResultCondition
+
 
+
setUtilityName(String) - Method in class com.paypal.butterfly.extensions.api.utilities.ResultCondition
+
 
+
SingleCondition<T extends SingleCondition> - Class in com.paypal.butterfly.extensions.api
+
+
Transformation utility condition to determine if a transformation utility + should be executed or not, based on an one file criteria.
+
+
SingleCondition() - Constructor for class com.paypal.butterfly.extensions.api.SingleCondition
+
 
+
skippedCondition(TransformationUtility, String) - Static method in class com.paypal.butterfly.extensions.api.PerformResult
+
+
This means the utility has not been executed + because its pre-requisite condition is not true
+
+
skippedDependency(TransformationUtility, String) - Static method in class com.paypal.butterfly.extensions.api.PerformResult
+
+
This means the utility has not been executed because one or more + of its dependencies "failed".
+
+
success(TransformationOperation, String) - Static method in class com.paypal.butterfly.extensions.api.TOExecutionResult
+
+
Creates and returns a new TOExecutionResult.Type.SUCCESS result
+
+
+ + + +

T

+
+
TemplateResolutionException - Exception in com.paypal.butterfly.extensions.api.exception
+
+
Thrown by Extension.automaticResolution(File) + whenever a transformation template cannot be resolved.
+
+
TemplateResolutionException(String) - Constructor for exception com.paypal.butterfly.extensions.api.exception.TemplateResolutionException
+
+
This exception is thrown by Extension.automaticResolution(File) + whenever transformation template cannot be resolved
+
+
TemplateResolutionException(String, Throwable) - Constructor for exception com.paypal.butterfly.extensions.api.exception.TemplateResolutionException
+
+
This exception is thrown by Extension.automaticResolution(File) + whenever transformation template cannot be resolved
+
+
TOExecutionResult - Class in com.paypal.butterfly.extensions.api
+
+
The meta-data object resulted after the TransformationOperation instance has been executed.
+
+
TOExecutionResult.Type - Enum in com.paypal.butterfly.extensions.api
+
+
The type of result after the TransformationOperation instance has been executed.
+
+
toString() - Method in class com.paypal.butterfly.extensions.api.Extension
+
 
+
toString() - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
+
 
+
toString() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
 
+
TransformationContext - Interface in com.paypal.butterfly.extensions.api
+
+
Holds meta-data information + to be shared among transformation utility objects, + allowing communication among them, and helping the + transformation process.
+
+
TransformationDefinitionException - Exception in com.paypal.butterfly.extensions.api.exception
+
+
Thrown whenever a transformation template definition is not well formed.
+
+
TransformationDefinitionException(String) - Constructor for exception com.paypal.butterfly.extensions.api.exception.TransformationDefinitionException
+
 
+
TransformationDefinitionException(String, Throwable) - Constructor for exception com.paypal.butterfly.extensions.api.exception.TransformationDefinitionException
+
 
+
TransformationOperation<T extends TransformationOperation> - Class in com.paypal.butterfly.extensions.api
+
+
Special type of TransformationUtility that applies a modification to the project.
+
+
TransformationOperation() - Constructor for class com.paypal.butterfly.extensions.api.TransformationOperation
+
 
+
TransformationOperationException - Exception in com.paypal.butterfly.extensions.api.exception
+
+
Thrown whenever an unexpected behavior or result + during execution of a TransformationOperation.
+
+
TransformationOperationException(String) - Constructor for exception com.paypal.butterfly.extensions.api.exception.TransformationOperationException
+
 
+
TransformationOperationException(String, Throwable) - Constructor for exception com.paypal.butterfly.extensions.api.exception.TransformationOperationException
+
 
+
TransformationTemplate - Class in com.paypal.butterfly.extensions.api
+
+
A template made of a set of transformation utilities to be applied against an application to be transformed.
+
+
TransformationTemplate() - Constructor for class com.paypal.butterfly.extensions.api.TransformationTemplate
+
 
+
TransformationUtility<T extends TransformationUtility> - Class in com.paypal.butterfly.extensions.api
+
+
Gathers information about the project to be transformed without applying any modification on it.
+
+
TransformationUtility() - Constructor for class com.paypal.butterfly.extensions.api.TransformationUtility
+
 
+
TransformationUtilityException - Exception in com.paypal.butterfly.extensions.api.exception
+
+
Thrown whenever an unexpected behavior or result + during execution of a TransformationUtility.
+
+
TransformationUtilityException(String) - Constructor for exception com.paypal.butterfly.extensions.api.exception.TransformationUtilityException
+
 
+
TransformationUtilityException(String, Throwable) - Constructor for exception com.paypal.butterfly.extensions.api.exception.TransformationUtilityException
+
 
+
TransformationUtilityGroup - Class in com.paypal.butterfly.extensions.api
+
+
Group of transformation utilities.
+
+
TransformationUtilityGroup() - Constructor for class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
+
 
+
TransformationUtilityLoop - Class in com.paypal.butterfly.extensions.api
+
+
Allows the execution of any transformation utility instance, + including a TransformationUtilityGroup, multiple times in a loop.
+
+
TransformationUtilityLoop() - Constructor for class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
+
+
Allows the execution of any transformation utility instance, + including a TransformationUtilityGroup, multiple times in a loop.
+
+
TransformationUtilityLoop(TransformationUtility) - Constructor for class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
+
+
Allows the execution of any transformation utility instance, + including a TransformationUtilityGroup, multiple times in a loop.
+
+
TUExecutionResult - Class in com.paypal.butterfly.extensions.api
+
+
The meta-data object resulted after the TransformationUtility instance has been executed.
+
+
TUExecutionResult.Type - Enum in com.paypal.butterfly.extensions.api
+
+
The type of result after the TransformationUtility instance has been executed.
+
+
+ + + +

U

+
+
UpgradeStep - Class in com.paypal.butterfly.extensions.api.upgrade
+
+
A special type of upgrade template that takes an application + from one minor version to the next subsequent available version.
+
+
UpgradeStep() - Constructor for class com.paypal.butterfly.extensions.api.upgrade.UpgradeStep
+
 
+
UTILITY_NAME_SYNTAX - Static variable in class com.paypal.butterfly.extensions.api.TransformationUtility
+
 
+
UtilityCondition<U extends UtilityCondition> - Class in com.paypal.butterfly.extensions.api
+
+
Condition to determine if a transformation utility + should be executed or not.
+
+
UtilityCondition() - Constructor for class com.paypal.butterfly.extensions.api.UtilityCondition
+
 
+
+ + + +

V

+
+
value(TransformationUtility, Object) - Static method in class com.paypal.butterfly.extensions.api.TUExecutionResult
+
 
+
value(TransformationUtility, String, Object) - Static method in class com.paypal.butterfly.extensions.api.TUExecutionResult
+
 
+
valueOf(String) - Static method in enum com.paypal.butterfly.extensions.api.MultipleConditions.Mode
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.paypal.butterfly.extensions.api.operations.AddElement.IfPresent
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresent
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.paypal.butterfly.extensions.api.PerformResult.Type
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.paypal.butterfly.extensions.api.TOExecutionResult.Type
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.paypal.butterfly.extensions.api.TUExecutionResult.Type
+
+
Returns the enum constant of this type with the specified name.
+
+
values() - Static method in enum com.paypal.butterfly.extensions.api.MultipleConditions.Mode
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.paypal.butterfly.extensions.api.operations.AddElement.IfPresent
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresent
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.paypal.butterfly.extensions.api.PerformResult.Type
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.paypal.butterfly.extensions.api.TOExecutionResult.Type
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.paypal.butterfly.extensions.api.TUExecutionResult.Type
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
+ + + +

W

+
+
warnButAddIfPresent() - Method in interface com.paypal.butterfly.extensions.api.operations.AddElement
+
+
Warn, but add, (TOExecutionResult.Type.WARNING) + if the element to be added is already present
+
+
warnButAddIfPresent() - Method in class com.paypal.butterfly.extensions.api.operations.AddElementTO
+
 
+
warnIfNotPresent() - Method in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement
+
+
Warn (TOExecutionResult.Type.WARNING) + if the element to be changed or removed is not present
+
+
warnIfNotPresent() - Method in class com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElementTO
+
 
+
warning(TransformationOperation) - Static method in class com.paypal.butterfly.extensions.api.TOExecutionResult
+
+
Creates and returns a new TOExecutionResult.Type.WARNING result
+
+
warning(TransformationOperation, String) - Static method in class com.paypal.butterfly.extensions.api.TOExecutionResult
+
+
Creates and returns a new TOExecutionResult.Type.WARNING result
+
+
warning(TransformationOperation, Exception) - Static method in class com.paypal.butterfly.extensions.api.TOExecutionResult
+
+
Creates and returns a new TOExecutionResult.Type.WARNING result
+
+
warning(TransformationOperation, Exception, String) - Static method in class com.paypal.butterfly.extensions.api.TOExecutionResult
+
+
Creates and returns a new TOExecutionResult.Type.WARNING result
+
+
warning(TransformationUtility, String, Object) - Static method in class com.paypal.butterfly.extensions.api.TUExecutionResult
+
 
+
warning(TransformationUtility, Exception, Object) - Static method in class com.paypal.butterfly.extensions.api.TUExecutionResult
+
 
+
warning(TransformationUtility, Exception, String, Object) - Static method in class com.paypal.butterfly.extensions.api.TUExecutionResult
+
 
+
warnNotAddIfPresent() - Method in interface com.paypal.butterfly.extensions.api.operations.AddElement
+
+
Warn and do not add (TOExecutionResult.Type.WARNING) + if the element to be added is already present
+
+
warnNotAddIfPresent() - Method in class com.paypal.butterfly.extensions.api.operations.AddElementTO
+
 
+
wasFileExplicitlySet() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
+
+
Return true only if a file has been set explicitly either via TransformationUtility.relative(String), TransformationUtility.absolute(String) or TransformationUtility.absolute(String, String).
+
+
+A B C D E F G H I L M N O P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/index.html b/docs/javadocs/3.2.1/butterfly-extensions-api/index.html new file mode 100644 index 00000000..d7181e2e --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/index.html @@ -0,0 +1,75 @@ + + + + + +butterfly-extensions-api 3.2.1 API + + + + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> + + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/overview-frame.html b/docs/javadocs/3.2.1/butterfly-extensions-api/overview-frame.html new file mode 100644 index 00000000..dd14a8f3 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/overview-frame.html @@ -0,0 +1,25 @@ + + + + + +Overview List (butterfly-extensions-api 3.2.1 API) + + + + + +
All Classes
+
+

Packages

+ +
+

 

+ + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/overview-summary.html b/docs/javadocs/3.2.1/butterfly-extensions-api/overview-summary.html new file mode 100644 index 00000000..a32141f2 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/overview-summary.html @@ -0,0 +1,163 @@ + + + + + +Overview (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

butterfly-extensions-api 3.2.1 API

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Packages 
PackageDescription
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.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.
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/overview-tree.html b/docs/javadocs/3.2.1/butterfly-extensions-api/overview-tree.html new file mode 100644 index 00000000..e5923373 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/overview-tree.html @@ -0,0 +1,229 @@ + + + + + +Class Hierarchy (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/package-list b/docs/javadocs/3.2.1/butterfly-extensions-api/package-list new file mode 100644 index 00000000..87abeaa1 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/package-list @@ -0,0 +1,5 @@ +com.paypal.butterfly.extensions.api +com.paypal.butterfly.extensions.api.exception +com.paypal.butterfly.extensions.api.operations +com.paypal.butterfly.extensions.api.upgrade +com.paypal.butterfly.extensions.api.utilities diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/script.js b/docs/javadocs/3.2.1/butterfly-extensions-api/script.js new file mode 100644 index 00000000..b3463569 --- /dev/null +++ b/docs/javadocs/3.2.1/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/3.2.1/butterfly-extensions-api/serialized-form.html b/docs/javadocs/3.2.1/butterfly-extensions-api/serialized-form.html new file mode 100644 index 00000000..9592cf55 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/serialized-form.html @@ -0,0 +1,165 @@ + + + + + +Serialized Form (butterfly-extensions-api 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Serialized Form

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-extensions-api/stylesheet.css b/docs/javadocs/3.2.1/butterfly-extensions-api/stylesheet.css new file mode 100644 index 00000000..98055b22 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-extensions-api/stylesheet.css @@ -0,0 +1,574 @@ +/* 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:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + 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:#4D7A97; + 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-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + 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:#4D7A97; + 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:#4D7A97; + 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/3.2.1/butterfly-utilities/allclasses-frame.html b/docs/javadocs/3.2.1/butterfly-utilities/allclasses-frame.html new file mode 100644 index 00000000..1c39a078 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/allclasses-frame.html @@ -0,0 +1,95 @@ + + + + + +All Classes (butterfly-utilities 3.2.1 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/allclasses-noframe.html b/docs/javadocs/3.2.1/butterfly-utilities/allclasses-noframe.html new file mode 100644 index 00000000..04d73372 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/allclasses-noframe.html @@ -0,0 +1,95 @@ + + + + + +All Classes (butterfly-utilities 3.2.1 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/CompareFiles.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/CompareFiles.html new file mode 100644 index 00000000..9b983bf5 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/CompareFiles.html @@ -0,0 +1,394 @@ + + + + + +CompareFiles (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.conditions
+

Class CompareFiles

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class CompareFiles
+extends com.paypal.butterfly.extensions.api.DoubleCondition<CompareFiles>
    +
    Compares two files and returns true if the content of the files are equal, + or if they both don't exist. Returns false otherwise. +
    + See DoubleCondition to find out how to set the baseline and the comparison files
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      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(java.lang.String attribute) +
      Compares two files and returns true if the content of the files are equal, + or if they both don't exist.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected booleancompare(java.io.File baselineFile, + java.io.File comparisonFile) 
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.DoubleCondition

        +getAttribute, setAttribute
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CompareFiles

        +
        public CompareFiles()
        +
        Compares two files and returns true if the content of the files are equal, + or if they both don't exist. Returns false otherwise. +
        + See DoubleCondition to find out how to set the baseline and the comparison files
        +
        • +
      + + + +
        +
      • +

        CompareFiles

        +
        public CompareFiles(java.lang.String attribute)
        +
        Compares two files and returns true if the content of the files are equal, + or if they both don't exist. Returns false otherwise. +
        + See DoubleCondition to find out how to set the baseline and the comparison files
        +
        +
        Parameters:
        +
        attribute - the name of the transformation context attribute + that refers to the file to be compared against the baseline file
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compare

        +
        protected boolean compare(java.io.File baselineFile,
+                          java.io.File comparisonFile)
        +
        +
        Specified by:
        +
        compare in class com.paypal.butterfly.extensions.api.DoubleCondition<CompareFiles>
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<CompareFiles>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Overrides:
        +
        execution in class com.paypal.butterfly.extensions.api.DoubleCondition<CompareFiles>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/CompareXMLFiles.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/CompareXMLFiles.html new file mode 100644 index 00000000..808c74b0 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/CompareXMLFiles.html @@ -0,0 +1,403 @@ + + + + + +CompareXMLFiles (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.conditions
+

Class CompareXMLFiles

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class CompareXMLFiles
+extends com.paypal.butterfly.extensions.api.DoubleCondition<CompareXMLFiles>
    +
    Compares two XML files and returns true if their contents are equal, + or if both files don't exist. Returns false otherwise. + Attribute orders, comments and white spaces are ignored during the comparison. + It results in error if any of the two files is not a well formed XML file. +
    + See DoubleCondition + to find out how to set the baseline and the comparison files
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      CompareXMLFiles() +
      Compares two XML files and returns true if their contents are equal, + or if both files don't exist.
      +
      CompareXMLFiles(java.lang.String attribute) +
      Compares two XML files and returns true if their contents are equal, + or if both files don't exist.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected booleancompare(java.io.File baselineFile, + java.io.File comparisonFile) 
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.DoubleCondition

        +getAttribute, setAttribute
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CompareXMLFiles

        +
        public CompareXMLFiles()
        +
        Compares two XML files and returns true if their contents are equal, + or if both files don't exist. Returns false otherwise. + Attribute orders, comments and white spaces are ignored during the comparison. + It results in error if any of the two files is not a well formed XML file. +
        + See DoubleCondition + to find out how to set the baseline and the comparison files
        +
        • +
      + + + +
        +
      • +

        CompareXMLFiles

        +
        public CompareXMLFiles(java.lang.String attribute)
        +
        Compares two XML files and returns true if their contents are equal, + or if both files don't exist. Returns false otherwise. + Attribute orders, comments and white spaces are ignored during the comparison. + It results in error if any of the two files is not a well formed XML file. +
        + See DoubleCondition + to find out how to set the baseline and the comparison files
        +
        +
        Parameters:
        +
        attribute - the name of the transformation context attribute + that refers to the file to be compared against the baseline file
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compare

        +
        protected boolean compare(java.io.File baselineFile,
+                          java.io.File comparisonFile)
        +
        +
        Specified by:
        +
        compare in class com.paypal.butterfly.extensions.api.DoubleCondition<CompareXMLFiles>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Overrides:
        +
        execution in class com.paypal.butterfly.extensions.api.DoubleCondition<CompareXMLFiles>
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<CompareXMLFiles>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/FileExists.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/FileExists.html new file mode 100644 index 00000000..82507c79 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/FileExists.html @@ -0,0 +1,334 @@ + + + + + +FileExists (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.conditions
+

Class FileExists

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class FileExists
+extends com.paypal.butterfly.extensions.api.SingleCondition<FileExists>
    +
    Checks if a particular file or folder exists.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      FileExists() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FileExists

        +
        public FileExists()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<FileExists>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<FileExists>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/PropertyExists.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/PropertyExists.html new file mode 100644 index 00000000..b5f16d89 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/PropertyExists.html @@ -0,0 +1,417 @@ + + + + + +PropertyExists (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.conditions
+

Class PropertyExists

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class PropertyExists
+extends com.paypal.butterfly.extensions.api.SingleCondition<PropertyExists>
    +
    Checks if a particular property exists in a property file. + The property name can be defined explicitly, via setPropertyName(String), + or as a regular expression, via setPropertyNameRegex(String). + Returns an error if the file to be evaluated is not a well formed properties file.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PropertyExists() +
      Checks if a particular property exists in a property file.
      +
      PropertyExists(java.lang.String propertyName) +
      Checks if a particular property exists in a property file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      java.lang.StringgetPropertyName() 
      java.lang.StringgetPropertyNameRegex() 
      PropertyExistssetPropertyName(java.lang.String propertyName) 
      PropertyExistssetPropertyNameRegex(java.lang.String propertyNameRegex) 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PropertyExists

        +
        public PropertyExists()
        +
        Checks if a particular property exists in a property file. + The property name can be defined explicitly, via setPropertyName(String), + or as a regular expression, via setPropertyNameRegex(String). + Returns an error if the file to be evaluated is not a well formed properties file.
        +
        • +
      + + + +
        +
      • +

        PropertyExists

        +
        public PropertyExists(java.lang.String propertyName)
        +
        Checks if a particular property exists in a property file. + The property name can be defined explicitly, via setPropertyName(String), + or as a regular expression, via setPropertyNameRegex(String). + Returns an error if the file to be evaluated is not a well formed properties file.
        +
        +
        Parameters:
        +
        propertyName - the name of the property to be checked
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setPropertyName

        +
        public PropertyExists setPropertyName(java.lang.String propertyName)
        +
        • +
      + + + +
        +
      • +

        setPropertyNameRegex

        +
        public PropertyExists setPropertyNameRegex(java.lang.String propertyNameRegex)
        +
        • +
      + + + +
        +
      • +

        getPropertyName

        +
        public java.lang.String getPropertyName()
        +
        • +
      + + + +
        +
      • +

        getPropertyNameRegex

        +
        public java.lang.String getPropertyNameRegex()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PropertyExists>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<PropertyExists>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/RegexMatch.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/RegexMatch.html new file mode 100644 index 00000000..a5d3a264 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/RegexMatch.html @@ -0,0 +1,400 @@ + + + + + +RegexMatch (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.conditions
+

Class RegexMatch

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class RegexMatch
+extends com.paypal.butterfly.extensions.api.SingleCondition<RegexMatch>
    +
    Checks if a regular expression matches any line in the specified text file. + It returns true only if the specified text file has one or more lines that match + the given regular expression.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      RegexMatch() +
      Checks if a regular expression matches any line in the specified text file.
      +
      RegexMatch(java.lang.String regex) +
      Checks if a regular expression matches any line in the specified text file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      java.lang.StringgetRegex() +
      Returns the regular expression to be evaluated against the specified text file
      +
      RegexMatchsetRegex(java.lang.String regex) +
      Sets the regular expression to be evaluated against the specified text file
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RegexMatch

        +
        public RegexMatch()
        +
        Checks if a regular expression matches any line in the specified text file.
        +
        • +
      + + + +
        +
      • +

        RegexMatch

        +
        public RegexMatch(java.lang.String regex)
        +
        Checks if a regular expression matches any line in the specified text file.
        +
        +
        Parameters:
        +
        regex - the regular expression to be evaluated against the specified text file
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setRegex

        +
        public RegexMatch setRegex(java.lang.String regex)
        +
        Sets the regular expression to be evaluated against the specified text file
        +
        +
        Parameters:
        +
        regex - the regular expression to be evaluated against the specified text file
        +
        Returns:
        +
        this utility instance
        +
        +
        • +
      + + + +
        +
      • +

        getRegex

        +
        public java.lang.String getRegex()
        +
        Returns the regular expression to be evaluated against the specified text file
        +
        +
        Returns:
        +
        the regular expression to be evaluated against the specified text file
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<RegexMatch>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<RegexMatch>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/XmlXPathExists.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/XmlXPathExists.html new file mode 100644 index 00000000..3784c361 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/XmlXPathExists.html @@ -0,0 +1,412 @@ + + + + + +XmlXPathExists (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.conditions
+

Class XmlXPathExists

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class XmlXPathExists
+extends com.paypal.butterfly.extensions.api.SingleCondition<XmlXPathExists>
    +
    Checks if a particular xpath exists in an XML file. +
    + If the xpath expression won't compile, an error is returned. +
    + If the file is not a well formed XML file, an error is returned.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      XmlXPathExists() +
      Checks if a particular xpath exists in an XML file.
      +
      XmlXPathExists(java.lang.String xpathExpressionString) +
      Checks if a particular xpath exists in an XML file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      java.lang.StringgetXPathExpressionString() +
      Return the XPath expression
      +
      XmlXPathExistssetXPathExpression(java.lang.String xpathExpressionString) +
      The XPathExpression whose evaluation indicates + the result of this transformation utility.
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        XmlXPathExists

        +
        public XmlXPathExists()
        +
        Checks if a particular xpath exists in an XML file. +
        + If the xpath expression won't compile, an error is returned. +
        + If the file is not a well formed XML file, an error is returned.
        +
        • +
      + + + +
        +
      • +

        XmlXPathExists

        +
        public XmlXPathExists(java.lang.String xpathExpressionString)
        +
        Checks if a particular xpath exists in an XML file. +
        + If the xpath expression won't compile, an error is returned. +
        + If the file is not a well formed XML file, an error is returned.
        +
        +
        Parameters:
        +
        xpathExpressionString - a string that compiles into a XPathExpression
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setXPathExpression

        +
        public XmlXPathExists setXPathExpression(java.lang.String xpathExpressionString)
        +
        The XPathExpression whose evaluation indicates + the result of this transformation utility.
        +
        +
        Parameters:
        +
        xpathExpressionString - a string that compiles into a XPathExpression
        +
        Returns:
        +
        this utility instance
        +
        +
        • +
      + + + +
        +
      • +

        getXPathExpressionString

        +
        public java.lang.String getXPathExpressionString()
        +
        Return the XPath expression
        +
        +
        Returns:
        +
        the XPath expression
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<XmlXPathExists>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<XmlXPathExists>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/AbstractTypeCheck.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/AbstractTypeCheck.html new file mode 100644 index 00000000..424345c2 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/AbstractTypeCheck.html @@ -0,0 +1,347 @@ + + + + + +AbstractTypeCheck (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.paypal.butterfly.utilities.conditions.java
+

Class AbstractTypeCheck<T extends AbstractTypeCheck>

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    AnnotatedWith, Extends
    +
    +
    +
    +
    public abstract class AbstractTypeCheck<T extends AbstractTypeCheck>
+extends JavaCondition<T>
    +
    This abstract class is helpful in case the compilation unit has multiple types + and the condition has to be evaluated against every type. + That would be true for example when checking if types extend a particular class. + That is not the case though if checking for example if a compilation unit has + a particular import statement.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      AbstractTypeCheck(java.lang.Class specifiedType) 
      AbstractTypeCheck(java.lang.String specifiedTypeName) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleaneval(com.github.javaparser.ast.CompilationUnit compilationUnit) +
      Evaluates this condition against the specified compilation + unit and returns the evaluation result.
      +
      protected abstract intgetNumberOfTypes(com.github.javaparser.ast.CompilationUnit compilationUnit) 
      protected abstract java.lang.StringgetTypeName(com.github.javaparser.ast.CompilationUnit compilationUnit, + int index) 
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        AbstractTypeCheck

        +
        public AbstractTypeCheck(java.lang.Class specifiedType)
        +
        • +
      + + + +
        +
      • +

        AbstractTypeCheck

        +
        public AbstractTypeCheck(java.lang.String specifiedTypeName)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        eval

        +
        public boolean eval(com.github.javaparser.ast.CompilationUnit compilationUnit)
        +
        Description copied from class: JavaCondition
        +
        Evaluates this condition against the specified compilation + unit and returns the evaluation result. This implementation + must ignore the negate property during this evaluation. + The negation behavior will be considered in JavaCondition.evaluate(CompilationUnit)
        +
        +
        Specified by:
        +
        eval in class JavaCondition<T extends AbstractTypeCheck>
        +
        Parameters:
        +
        compilationUnit - the CompilationUnit that represents + the Java class to be evaluated
        +
        Returns:
        +
        the evaluation result ignoring negation
        +
        +
        • +
      + + + +
        +
      • +

        getTypeName

        +
        protected abstract java.lang.String getTypeName(com.github.javaparser.ast.CompilationUnit compilationUnit,
+                                                int index)
        +
        • +
      + + + +
        +
      • +

        getNumberOfTypes

        +
        protected abstract int getNumberOfTypes(com.github.javaparser.ast.CompilationUnit compilationUnit)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/AnnotatedWith.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/AnnotatedWith.html new file mode 100644 index 00000000..5f909274 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/AnnotatedWith.html @@ -0,0 +1,331 @@ + + + + + +AnnotatedWith (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.paypal.butterfly.utilities.conditions.java
+

Class AnnotatedWith

+
+
+ +
+
    +
  • +
    +
    +
    public class AnnotatedWith
+extends AbstractTypeCheck<AnnotatedWith>
    +
    Evaluates if the specified + Java class or interface is annotated with the + specified annotation.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      AnnotatedWith(java.lang.Class specifiedType) 
      AnnotatedWith(java.lang.String specifiedTypeName) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected intgetNumberOfTypes(com.github.javaparser.ast.CompilationUnit compilationUnit) 
      protected java.lang.StringgetTypeName(com.github.javaparser.ast.CompilationUnit compilationUnit, + int index) 
      + + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        AnnotatedWith

        +
        public AnnotatedWith(java.lang.Class specifiedType)
        +
        • +
      + + + +
        +
      • +

        AnnotatedWith

        +
        public AnnotatedWith(java.lang.String specifiedTypeName)
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/Extends.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/Extends.html new file mode 100644 index 00000000..78390fed --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/Extends.html @@ -0,0 +1,331 @@ + + + + + +Extends (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.paypal.butterfly.utilities.conditions.java
+

Class Extends

+
+
+ +
+
    +
  • +
    +
    +
    public class Extends
+extends AbstractTypeCheck<Extends>
    +
    Evaluates if the specified + compilation unit directly extends the + specified class.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      Extends(java.lang.Class specifiedType) 
      Extends(java.lang.String specifiedTypeName) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected intgetNumberOfTypes(com.github.javaparser.ast.CompilationUnit compilationUnit) 
      protected java.lang.StringgetTypeName(com.github.javaparser.ast.CompilationUnit compilationUnit, + int index) 
      + + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        Extends

        +
        public Extends(java.lang.Class specifiedType)
        +
        • +
      + + + +
        +
      • +

        Extends

        +
        public Extends(java.lang.String specifiedTypeName)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTypeName

        +
        protected java.lang.String getTypeName(com.github.javaparser.ast.CompilationUnit compilationUnit,
+                                       int index)
        +
        +
        Specified by:
        +
        getTypeName in class AbstractTypeCheck<Extends>
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/JavaCondition.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/JavaCondition.html new file mode 100644 index 00000000..3a02861c --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/JavaCondition.html @@ -0,0 +1,342 @@ + + + + + +JavaCondition (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.paypal.butterfly.utilities.conditions.java
+

Class JavaCondition<T extends JavaCondition>

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    AbstractTypeCheck
    +
    +
    +
    +
    public abstract class JavaCondition<T extends JavaCondition>
+extends java.lang.Object
    +
    Abstract class to specify a condition to be + evaluated against a Java class, which is + represented as a CompilationUnit.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      JavaCondition() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected abstract booleaneval(com.github.javaparser.ast.CompilationUnit compilationUnit) +
      Evaluates this condition against the specified compilation + unit and returns the evaluation result.
      +
      booleanisNegate() +
      Returns whether the evaluation result will be negated + or not.
      +
      TsetNegate(boolean negate) +
      Sets whether the result should be negated, meaning, + resulting true whenever its evaluation result would + normally results false, and vice-versa.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        JavaCondition

        +
        public JavaCondition()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        eval

        +
        protected abstract boolean eval(com.github.javaparser.ast.CompilationUnit compilationUnit)
        +
        Evaluates this condition against the specified compilation + unit and returns the evaluation result. This implementation + must ignore the negate property during this evaluation. + The negation behavior will be considered in evaluate(CompilationUnit)
        +
        +
        Parameters:
        +
        compilationUnit - the CompilationUnit that represents + the Java class to be evaluated
        +
        Returns:
        +
        the evaluation result ignoring negation
        +
        +
        • +
      + + + +
        +
      • +

        setNegate

        +
        public 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. The default + value is false.
        +
        +
        Parameters:
        +
        negate - the result should be negated or not
        +
        Returns:
        +
        this transformation utility condition instance
        +
        +
        • +
      + + + +
        +
      • +

        isNegate

        +
        public boolean isNegate()
        +
        Returns whether the evaluation result will be negated + or not.
        +
        +
        Returns:
        +
        whether the evaluation result will be negated + or not
        +
        See Also:
        +
        setNegate(boolean)
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/JavaMatch.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/JavaMatch.html new file mode 100644 index 00000000..a95deb4e --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/JavaMatch.html @@ -0,0 +1,491 @@ + + + + + +JavaMatch (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.conditions.java
+

Class JavaMatch

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class JavaMatch
+extends com.paypal.butterfly.extensions.api.SingleCondition<JavaMatch>
    +
    Parses and evaluates the specified Java class file + based on a set of 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. + If the Java class file is named package-info.java, the file content + will not be evaluated and false and a warning will be returned. + The boolean result for package-info.java file is configurable though.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      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.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      JavaMatchaddCondition(JavaCondition condition) +
      Add a new Java condition to be evaluated against the Java class.
      +
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.util.Set<JavaCondition>getConditions() +
      Returns the set of Java conditions to be used to + evaluate the specified class.
      +
      java.lang.StringgetDescription() 
      booleangetPackageInfo() +
      Returns the current boolean status of packageInfo.
      +
      JavaMatchsetConditions(java.util.Set<JavaCondition> conditions) +
      Sets the set of Java conditions to be used to + evaluate the specified class.
      +
      JavaMatchsetPackageInfo(boolean packageInfo) +
      Sets the result value for package info warning.
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        JavaMatch

        +
        public JavaMatch()
        +
        This utility parses and evaluates the specified Java class file + based on a set of 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.
        +
        • +
      + + + +
        +
      • +

        JavaMatch

        +
        public JavaMatch(JavaCondition condition)
        +
        This utility parses and evaluates the specified Java class file + based on a set of 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.
        +
        +
        Parameters:
        +
        condition - one condition to be evaluated. More can be added with + addCondition(JavaCondition)
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getConditions

        +
        public java.util.Set<JavaCondition> getConditions()
        +
        Returns the set of Java conditions to be used to + evaluate the specified class. The returned object + is not a copy and it is modifiable.
        +
        +
        Returns:
        +
        the set of Java conditions to be used to evaluate the specified class
        +
        +
        • +
      + + + +
        +
      • +

        setConditions

        +
        public JavaMatch setConditions(java.util.Set<JavaCondition> conditions)
        +
        Sets the set of Java conditions to be used to + evaluate the specified class. Any conditions + added previously will be discarded.
        +
        +
        Parameters:
        +
        conditions - the set of Java conditions to be used to evaluate the specified class
        +
        Returns:
        +
        this transformation utility condition instance
        +
        +
        • +
      + + + +
        +
      • +

        getPackageInfo

        +
        public boolean getPackageInfo()
        +
        Returns the current boolean status of packageInfo.
        +
        +
        Returns:
        +
        this packageInfo boolean status
        +
        +
        • +
      + + + +
        +
      • +

        setPackageInfo

        +
        public JavaMatch setPackageInfo(boolean packageInfo)
        +
        Sets the result value for package info warning. + By default the result for package-info.java + file will be false.
        +
        +
        Parameters:
        +
        packageInfo - boolean status of value for packageInfo warning
        +
        Returns:
        +
        this transformation utility condition instance
        +
        +
        • +
      + + + +
        +
      • +

        addCondition

        +
        public JavaMatch addCondition(JavaCondition condition)
        +
        Add a new Java condition to be evaluated against the Java class.
        +
        +
        Parameters:
        +
        condition - a Java condition to be used to evaluate the specified class
        +
        Returns:
        +
        this transformation utility condition instance
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<JavaMatch>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<JavaMatch>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/package-frame.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/package-frame.html new file mode 100644 index 00000000..27b94421 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/package-frame.html @@ -0,0 +1,24 @@ + + + + + +com.paypal.butterfly.utilities.conditions.java (butterfly-utilities 3.2.1 API) + + + + + +

com.paypal.butterfly.utilities.conditions.java

+
+

Classes

+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/package-summary.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/package-summary.html new file mode 100644 index 00000000..28962ce1 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/package-summary.html @@ -0,0 +1,187 @@ + + + + + +com.paypal.butterfly.utilities.conditions.java (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.paypal.butterfly.utilities.conditions.java

+
+
Transformation utility conditions to analyze and evaluate Java class files.
+
+

See: Description

+
+
+ + + + +

Package com.paypal.butterfly.utilities.conditions.java Description

+
Transformation utility conditions to analyze and evaluate Java class files.
+
+
Since:
+
1.0.0
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/package-tree.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/package-tree.html new file mode 100644 index 00000000..7f2489b4 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/java/package-tree.html @@ -0,0 +1,157 @@ + + + + + +com.paypal.butterfly.utilities.conditions.java Class Hierarchy (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.paypal.butterfly.utilities.conditions.java

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/package-frame.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/package-frame.html new file mode 100644 index 00000000..1e3345e5 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/package-frame.html @@ -0,0 +1,25 @@ + + + + + +com.paypal.butterfly.utilities.conditions (butterfly-utilities 3.2.1 API) + + + + + +

com.paypal.butterfly.utilities.conditions

+
+

Classes

+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/package-summary.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/package-summary.html new file mode 100644 index 00000000..5ee76c67 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/package-summary.html @@ -0,0 +1,194 @@ + + + + + +com.paypal.butterfly.utilities.conditions (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.paypal.butterfly.utilities.conditions

+
+
Multiple transformation utility conditions, organized by type, each one having its own subpackage.
+
+

See: Description

+
+
+ + + + +

Package com.paypal.butterfly.utilities.conditions Description

+
Multiple transformation utility conditions, organized by type, each one having its own subpackage. + Transformation utility conditions are used to determine if a specific transformation utility + should be executed or not. Transformation utility condition is a special type of transformation utility that + always result in a boolean. The criteria to its 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).
+
+
Since:
+
1.0.0
+
See Also:
+
SingleCondition, +DoubleCondition
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/package-tree.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/package-tree.html new file mode 100644 index 00000000..67b50705 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/package-tree.html @@ -0,0 +1,156 @@ + + + + + +com.paypal.butterfly.utilities.conditions Class Hierarchy (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.paypal.butterfly.utilities.conditions

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/PomDependencyExists.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/PomDependencyExists.html new file mode 100644 index 00000000..8a94e639 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/PomDependencyExists.html @@ -0,0 +1,462 @@ + + + + + +PomDependencyExists (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.conditions.pom
+

Class PomDependencyExists

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class PomDependencyExists
+extends com.paypal.butterfly.extensions.api.SingleCondition<PomDependencyExists>
    +
    Checks if a particular Maven dependency exists in a Maven pom file. + Returns an error if the file to be evaluated is not a well formed XML file.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomDependencyExists() 
      PomDependencyExists(java.lang.String groupId, + java.lang.String artifactId) +
      Condition to check if a particular Maven dependency exists in a Maven pom files.
      +
      PomDependencyExists(java.lang.String groupId, + java.lang.String artifactId, + java.lang.String version) +
      Condition to check if a particular Maven dependency exists in a Maven pom files.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetArtifactId() 
      java.lang.StringgetDescription() 
      java.lang.StringgetGroupId() 
      java.lang.StringgetVersion() 
      PomDependencyExistssetArtifactId(java.lang.String artifactId) 
      PomDependencyExistssetGroupId(java.lang.String groupId) 
      PomDependencyExistssetVersion(java.lang.String version) 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomDependencyExists

        +
        public PomDependencyExists()
        +
        • +
      + + + +
        +
      • +

        PomDependencyExists

        +
        public PomDependencyExists(java.lang.String groupId,
+                           java.lang.String artifactId)
        +
        Condition to check if a particular Maven dependency exists in a Maven pom files. + Returns an error if the file to be evaluated is not a well formed XML file.
        +
        +
        Parameters:
        +
        groupId - managed dependency group id
        +
        artifactId - managed dependency artifact id
        +
        +
        • +
      + + + +
        +
      • +

        PomDependencyExists

        +
        public PomDependencyExists(java.lang.String groupId,
+                           java.lang.String artifactId,
+                           java.lang.String version)
        +
        Condition to check if a particular Maven dependency exists in a Maven pom files. + Returns an error if the file to be evaluated is not a well formed XML file.
        +
        +
        Parameters:
        +
        groupId - managed dependency group id
        +
        artifactId - managed dependency artifact id
        +
        version - managed dependency version
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        setArtifactId

        +
        public PomDependencyExists setArtifactId(java.lang.String artifactId)
        +
        • +
      + + + + + + + +
        +
      • +

        getGroupId

        +
        public java.lang.String getGroupId()
        +
        • +
      + + + +
        +
      • +

        getArtifactId

        +
        public java.lang.String getArtifactId()
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        public java.lang.String getVersion()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomDependencyExists>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<PomDependencyExists>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/PomHasParent.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/PomHasParent.html new file mode 100644 index 00000000..116fe032 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/PomHasParent.html @@ -0,0 +1,338 @@ + + + + + +PomHasParent (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.conditions.pom
+

Class PomHasParent

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class PomHasParent
+extends com.paypal.butterfly.extensions.api.SingleCondition<PomHasParent>
    +
    Checks if a parent POM exists in a Maven POM file. + Returns an error if the file to be evaluated is not a well-formed XML file.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      PomHasParent() +
      Default Constructor
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomHasParent

        +
        public PomHasParent()
        +
        Default Constructor
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomHasParent>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<PomHasParent>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/PomJavaMatch.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/PomJavaMatch.html new file mode 100644 index 00000000..96f3f4b3 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/PomJavaMatch.html @@ -0,0 +1,449 @@ + + + + + +PomJavaMatch (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.conditions.pom
+

Class PomJavaMatch

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class PomJavaMatch
+extends com.paypal.butterfly.extensions.api.SingleCondition<PomJavaMatch>
    +
    Checks if a Maven module has at least one Java class + that matches a given regular expression.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomJavaMatch() +
      Checks if a Maven module has at least one Java class + that matches a given regular expression.
      +
      PomJavaMatch(java.lang.String regex) +
      Checks if a Maven module has at least one Java class + that matches a given regular expression.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      java.lang.StringgetRegex() +
      Returns the regular expression to be evaluated against Java classes under given Maven module
      +
      PomJavaMatchsetIncludeMain(boolean includeMain) +
      Sets whether Java classes under src/main/java should be evaluated or not.
      +
      PomJavaMatchsetIncludeTest(boolean includeTest) +
      Sets whether Java classes under src/test/java should be evaluated or not.
      +
      PomJavaMatchsetRegex(java.lang.String regex) +
      Sets the regular expression to be evaluated against Java classes under given Maven module
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomJavaMatch

        +
        public PomJavaMatch()
        +
        Checks if a Maven module has at least one Java class + that matches a given regular expression.
        +
        • +
      + + + +
        +
      • +

        PomJavaMatch

        +
        public PomJavaMatch(java.lang.String regex)
        +
        Checks if a Maven module has at least one Java class + that matches a given regular expression.
        +
        +
        Parameters:
        +
        regex - the regular expression to be evaluated against Java classes under given Maven module
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setRegex

        +
        public PomJavaMatch setRegex(java.lang.String regex)
        +
        Sets the regular expression to be evaluated against Java classes under given Maven module
        +
        +
        Parameters:
        +
        regex - the regular expression to be evaluated against Java classes under given Maven module
        +
        Returns:
        +
        this utility instance
        +
        +
        • +
      + + + +
        +
      • +

        setIncludeMain

        +
        public PomJavaMatch setIncludeMain(boolean includeMain)
        +
        Sets whether Java classes under src/main/java should be evaluated or not. + Default value is true.
        +
        +
        Parameters:
        +
        includeMain - whether Java classes under src/main/java should be evaluated or not
        +
        Returns:
        +
        this utility instance
        +
        +
        • +
      + + + +
        +
      • +

        setIncludeTest

        +
        public PomJavaMatch setIncludeTest(boolean includeTest)
        +
        Sets whether Java classes under src/test/java should be evaluated or not. + Default value is true.
        +
        +
        Parameters:
        +
        includeTest - whether Java classes under src/test/java should be evaluated or not
        +
        Returns:
        +
        this utility instance
        +
        +
        • +
      + + + +
        +
      • +

        getRegex

        +
        public java.lang.String getRegex()
        +
        Returns the regular expression to be evaluated against Java classes under given Maven module
        +
        +
        Returns:
        +
        the regular expression to be evaluated against Java classes under given Maven module
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomJavaMatch>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<PomJavaMatch>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/PomParentMatch.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/PomParentMatch.html new file mode 100644 index 00000000..31b12da0 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/PomParentMatch.html @@ -0,0 +1,462 @@ + + + + + +PomParentMatch (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.conditions.pom
+

Class PomParentMatch

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class PomParentMatch
+extends com.paypal.butterfly.extensions.api.SingleCondition<PomParentMatch>
    +
    Checks if a Maven POM file has a parent artifact and it matches the specified groupId, artifactId and version. + Returns an error if the file to be evaluated is not a well-formed XML file.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomParentMatch() 
      PomParentMatch(java.lang.String groupId, + java.lang.String artifactId) +
      Condition to check if a Maven POM file has a parent artifact and it matches the specified groupId, artifactId and version.
      +
      PomParentMatch(java.lang.String groupId, + java.lang.String artifactId, + java.lang.String version) +
      if a Maven POM file has a parent artifact and it matches the specified groupId, artifactId and version.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetArtifactId() 
      java.lang.StringgetDescription() 
      java.lang.StringgetGroupId() 
      java.lang.StringgetVersion() 
      PomParentMatchsetArtifactId(java.lang.String artifactId) 
      PomParentMatchsetGroupId(java.lang.String groupId) 
      PomParentMatchsetVersion(java.lang.String version) 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomParentMatch

        +
        public PomParentMatch()
        +
        • +
      + + + +
        +
      • +

        PomParentMatch

        +
        public PomParentMatch(java.lang.String groupId,
+                      java.lang.String artifactId)
        +
        Condition to check if a Maven POM file has a parent artifact and it matches the specified groupId, artifactId and version. + Returns an error if the file to be evaluated is not a well formed XML file.
        +
        +
        Parameters:
        +
        groupId - managed dependency group id
        +
        artifactId - managed dependency artifact id
        +
        +
        • +
      + + + +
        +
      • +

        PomParentMatch

        +
        public PomParentMatch(java.lang.String groupId,
+                      java.lang.String artifactId,
+                      java.lang.String version)
        +
        if a Maven POM file has a parent artifact and it matches the specified groupId, artifactId and version. + Returns an error if the file to be evaluated is not a well formed XML file.
        +
        +
        Parameters:
        +
        groupId - managed dependency group id
        +
        artifactId - managed dependency artifact id
        +
        version - managed dependency version
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setGroupId

        +
        public PomParentMatch setGroupId(java.lang.String groupId)
        +
        • +
      + + + +
        +
      • +

        setArtifactId

        +
        public PomParentMatch setArtifactId(java.lang.String artifactId)
        +
        • +
      + + + +
        +
      • +

        setVersion

        +
        public PomParentMatch setVersion(java.lang.String version)
        +
        • +
      + + + +
        +
      • +

        getGroupId

        +
        public java.lang.String getGroupId()
        +
        • +
      + + + +
        +
      • +

        getArtifactId

        +
        public java.lang.String getArtifactId()
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        public java.lang.String getVersion()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomParentMatch>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<PomParentMatch>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/package-frame.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/package-frame.html new file mode 100644 index 00000000..c91138f0 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/package-frame.html @@ -0,0 +1,23 @@ + + + + + +com.paypal.butterfly.utilities.conditions.pom (butterfly-utilities 3.2.1 API) + + + + + +

com.paypal.butterfly.utilities.conditions.pom

+
+

Classes

+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/package-summary.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/package-summary.html new file mode 100644 index 00000000..b6f5a4c9 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/package-summary.html @@ -0,0 +1,174 @@ + + + + + +com.paypal.butterfly.utilities.conditions.pom (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.paypal.butterfly.utilities.conditions.pom

+
+
Transformation utility conditions to analyze and evaluate Maven POM files and Maven modules.
+
+

See: Description

+
+
+ + + + +

Package com.paypal.butterfly.utilities.conditions.pom Description

+
Transformation utility conditions to analyze and evaluate Maven POM files and Maven modules.
+
+
Since:
+
1.0.0
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/package-tree.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/package-tree.html new file mode 100644 index 00000000..685aa48e --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/conditions/pom/package-tree.html @@ -0,0 +1,150 @@ + + + + + +com.paypal.butterfly.utilities.conditions.pom Class Hierarchy (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.paypal.butterfly.utilities.conditions.pom

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/FindFile.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/FindFile.html new file mode 100644 index 00000000..f028fd6f --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/FindFile.html @@ -0,0 +1,410 @@ + + + + + +FindFile (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.file
+

Class FindFile

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class FindFile
+extends com.paypal.butterfly.extensions.api.TransformationUtility<FindFile>
    +
    Finds a file based on its name. The search is + always recursive (includes sub-folders). If no file is + found, null is returned, unless failIfNotFound(boolean) is set to true. + If multiple files are found, an error is returned. +
    + The root directory from where the search should take place + can be defined by 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 "." +
    + If no file is found, a TUExecutionResult.Type.NULL + is returned, unless failIfNotFound(boolean) is set to true +
    + See FindFiles for a better refined search and to find multiple files.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      FindFile() 
      FindFile(java.lang.String fileName) +
      Utility to find a file based on its name
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      FindFilefailIfNotFound(boolean failIfNotFound) 
      java.lang.StringgetDescription() 
      java.lang.StringgetFileName() 
      booleanisFailIfNotFound() 
      FindFilesetFileName(java.lang.String fileName) 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FindFile

        +
        public FindFile()
        +
        • +
      + + + +
        +
      • +

        FindFile

        +
        public FindFile(java.lang.String fileName)
        +
        Utility to find a file based on its name
        +
        +
        Parameters:
        +
        fileName - name of the file to be found
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setFileName

        +
        public FindFile setFileName(java.lang.String fileName)
        +
        • +
      + + + +
        +
      • +

        failIfNotFound

        +
        public FindFile failIfNotFound(boolean failIfNotFound)
        +
        • +
      + + + +
        +
      • +

        isFailIfNotFound

        +
        public boolean isFailIfNotFound()
        +
        • +
      + + + +
        +
      • +

        getFileName

        +
        public java.lang.String getFileName()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<FindFile>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<FindFile>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/FindFiles.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/FindFiles.html new file mode 100644 index 00000000..d0eabeb8 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/FindFiles.html @@ -0,0 +1,754 @@ + + + + + +FindFiles (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.file
+

Class FindFiles

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class FindFiles
+extends com.paypal.butterfly.extensions.api.TransformationUtility<FindFiles>
    +
    Finds files based on a regular expression + against the file name and/or the file path. The search might be + recursive (searching also in sub-folders) or not. If a file path regular + expression is set, then the search will be automatically recursive. + If no file path regular expression is set, then the search + is not recursive by default, but it may be set to as well. +
    + The term "file" here might refer to folders as well, and + 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. +
    + The root directory from where the search should take place + can be defined by 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 "." +
    + If no files are found, an empty list is returned and the + result type is TUExecutionResult.Type#VALUE, unless + warnIfNoFilesFound() is called, then an empty list is still returned, + but the result type will be TUExecutionResult.Type#WARNING
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      FindFiles() 
      FindFiles(java.lang.String nameRegex, + boolean recursive) +
      Utility to find files based on a regular expression + against the file name.
      +
      FindFiles(java.lang.String nameRegex, + boolean recursive, + boolean includeFiles, + boolean includeFolders) +
      Utility to find files based on a regular expression + against the file name.
      +
      FindFiles(java.lang.String nameRegex, + java.lang.String pathRegex) +
      Utility to find files based on a regular expression + against the file name and the file path.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      FindFileserrorIfNoFilesFound() +
      By default, if no files are found, an empty list is returned + and the result type is TUExecutionResult.Type#VALUE.
      +
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      java.lang.StringgetNameRegex() +
      Returns the file name regular expression
      +
      java.lang.StringgetPathRegex() +
      Returns the file path regular expression
      +
      booleanisIncludeFiles() +
      Returns whether files should be included in the search or not
      +
      booleanisIncludeFolders() +
      Returns whether folders should be included in the search or not
      +
      booleanisRecursive() +
      Returns whether the file search is recursive or not
      +
      FindFilessetIncludeFiles(boolean includeFiles) +
      Set whether files should be included in the search or not.
      +
      FindFilessetIncludeFolders(boolean includeFolders) +
      Set whether folders should be included in the search or not.
      +
      FindFilessetNameRegex(java.lang.String nameRegex) +
      Set regular expression to be used to match the file name + during the search
      +
      FindFilessetPathRegex(java.lang.String pathRegex) +
      Set regular expression to be used to match the file path + during the search
      + Important notes: + + Use forward slash as file separator.
      +
      FindFilessetRecursive(boolean recursive) +
      Set whether the search should be recursive or not.
      +
      FindFileswarnIfNoFilesFound() +
      By default, if no files are found, an empty list is returned + and the result type is TUExecutionResult.Type#VALUE.
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FindFiles

        +
        public FindFiles()
        +
        • +
      + + + +
        +
      • +

        FindFiles

        +
        public FindFiles(java.lang.String nameRegex,
+                 boolean recursive)
        +
        Utility to find files based on a regular expression + against the file name. The search might be + recursive (searching also in sub-folders) or not. +
        + This search does not include folders, only files, unless + setIncludeFolders(boolean) is set to true. +
        + The root directory from where the search should take place + can be defined by 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 "."
        +
        +
        Parameters:
        +
        nameRegex - regular expression to be applied against file name during search
        +
        recursive - if true, sub-folders will also be searched
        +
        +
        • +
      + + + +
        +
      • +

        FindFiles

        +
        public FindFiles(java.lang.String nameRegex,
+                 boolean recursive,
+                 boolean includeFiles,
+                 boolean includeFolders)
        +
        Utility to find files based on a regular expression + against the file name. The search might be + recursive (searching also in sub-folders) or not. +
        + This search might include files only, folders only, or both, + depending on how includeFiles and includeFolders + are configured. +
        + The root directory from where the search should take place + can be defined by 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 "."
        +
        +
        Parameters:
        +
        nameRegex - regular expression to be applied against file name during search
        +
        recursive - if true, sub-folders will also be searched
        +
        includeFiles - whether files should be included in the search or not
        +
        includeFolders - whether folders should be included in the search or not
        +
        +
        • +
      + + + +
        +
      • +

        FindFiles

        +
        public FindFiles(java.lang.String nameRegex,
+                 java.lang.String pathRegex)
        +
        Utility to find files based on a regular expression + against the file name and the file path. Because a file path regular + expression is set, then the search will be automatically and + necessarily recursive. +
        + Important notes: +
          +
        • Use forward slash as file separator. If the OS + used during transformation execution uses another character + as file separator, that will be automatically converted + by this utility
          • +
        • The path regular expression will be evaluated starting from + the path defined by 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 "." +
        +
        +
        +
        Parameters:
        +
        nameRegex - regular expression to be applied against file name during search
        +
        pathRegex - regular expression to be applied against file path during search
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setNameRegex

        +
        public FindFiles setNameRegex(java.lang.String nameRegex)
        +
        Set regular expression to be used to match the file name + during the search
        +
        +
        Parameters:
        +
        nameRegex - regular expression to be used to match the file name + during the search
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        setPathRegex

        +
        public FindFiles setPathRegex(java.lang.String pathRegex)
        +
        Set regular expression to be used to match the file path + during the search
        + Important notes: +
          +
        • Use forward slash as file separator. If the OS + used during transformation execution uses another character + as file separator, that will be automatically converted + by this utility
          • +
        • Setting this to a non null value automatically sets + recursive property to true
          • +
        • This regular expression will be evaluated against + the file path starting from the search root + directory
          • +
        +
        +
        Parameters:
        +
        pathRegex - regular expression to be used to match the file path + during the search
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        setRecursive

        +
        public FindFiles setRecursive(boolean recursive)
        +
        Set whether the search should be recursive or not. + If a file path regular expression has been set, + then this property will be automatically set to + true.
        + Important: setting this to false automatically sets + the file path regular expression to null
        +
        +
        Parameters:
        +
        recursive - whether the search should be recursive
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        setIncludeFolders

        +
        public FindFiles setIncludeFolders(boolean includeFolders)
        +
        Set whether folders should be included in the search or not. + If not set, the default is false.
        +
        +
        Parameters:
        +
        includeFolders - whether folders should be included in the search or not
        +
        Returns:
        +
        this transformation utility instance
        +
        Since:
        +
        2.2.0
        +
        +
        • +
      + + + +
        +
      • +

        setIncludeFiles

        +
        public FindFiles setIncludeFiles(boolean includeFiles)
        +
        Set whether files should be included in the search or not. + If not set, the default is true.
        +
        +
        Parameters:
        +
        includeFiles - whether files should be included in the search or not
        +
        Returns:
        +
        this transformation utility instance
        +
        Since:
        +
        2.2.0
        +
        +
        • +
      + + + +
        +
      • +

        warnIfNoFilesFound

        +
        public FindFiles warnIfNoFilesFound()
        +
        By default, if no files are found, an empty list is returned + and the result type is TUExecutionResult.Type#VALUE. + However, if this method is called, then an empty list is still returned, + but the result type will be TUExecutionResult.Type#WARNING
        +
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        errorIfNoFilesFound

        +
        public FindFiles errorIfNoFilesFound()
        +
        By default, if no files are found, an empty list is returned + and the result type is TUExecutionResult.Type#VALUE. + However, if this method is called, then an empty list is still returned, + but the result type will be TUExecutionResult.Type#WARNING
        +
        +
        Returns:
        +
        this transformation utility instance
        +
        +
        • +
      + + + +
        +
      • +

        getNameRegex

        +
        public java.lang.String getNameRegex()
        +
        Returns the file name regular expression
        +
        +
        Returns:
        +
        the file name regular expression
        +
        +
        • +
      + + + +
        +
      • +

        getPathRegex

        +
        public java.lang.String getPathRegex()
        +
        Returns the file path regular expression
        +
        +
        Returns:
        +
        the file path regular expression
        +
        +
        • +
      + + + +
        +
      • +

        isRecursive

        +
        public boolean isRecursive()
        +
        Returns whether the file search is recursive or not
        +
        +
        Returns:
        +
        whether the file search is recursive or not
        +
        +
        • +
      + + + +
        +
      • +

        isIncludeFolders

        +
        public boolean isIncludeFolders()
        +
        Returns whether folders should be included in the search or not
        +
        +
        Returns:
        +
        whether folders should be included in the search or not
        +
        +
        • +
      + + + +
        +
      • +

        isIncludeFiles

        +
        public boolean isIncludeFiles()
        +
        Returns whether files should be included in the search or not
        +
        +
        Returns:
        +
        whether files should be included in the search or not
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<FindFiles>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<FindFiles>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/LoadFile.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/LoadFile.html new file mode 100644 index 00000000..0f4c1e54 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/LoadFile.html @@ -0,0 +1,402 @@ + + + + + +LoadFile (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.file
+

Class LoadFile

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class LoadFile
+extends com.paypal.butterfly.extensions.api.TransformationUtility<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. The file is written to a temporary folder to be defined by the OS. + If no resource file is found, an error is returned.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      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(java.lang.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.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      java.lang.StringgetResource() +
      Returns the name of the resource in the classpath
      +
      LoadFilesetResource(java.lang.String resource) +
      Sets the name of the resource in the classpath.
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LoadFile

        +
        public 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. The file is written to a temporary folder to be defined by the OS. + If no resource file is found, an error is returned.
        +
        • +
      + + + +
        +
      • +

        LoadFile

        +
        public LoadFile(java.lang.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. The file is written to a temporary folder to be defined by the OS. + If no resource file is found, an error is returned.
        +
        +
        Parameters:
        +
        resource - the name of the resource in the classpath
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setResource

        +
        public LoadFile setResource(java.lang.String resource)
        +
        Sets the name of the resource in the classpath. The syntax + here is the same as the one used in ClassLoader.getResource(String)
        +
        +
        Parameters:
        +
        resource - the name of the resource in the classpath
        +
        Returns:
        +
        this utility instance
        +
        +
        • +
      + + + +
        +
      • +

        getResource

        +
        public java.lang.String getResource()
        +
        Returns the name of the resource in the classpath
        +
        +
        Returns:
        +
        the name of the resource in the classpath
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<LoadFile>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<LoadFile>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/LocateFile.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/LocateFile.html new file mode 100644 index 00000000..2385aa1f --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/LocateFile.html @@ -0,0 +1,410 @@ + + + + + +LocateFile (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.file
+

Class LocateFile

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class LocateFile
+extends com.paypal.butterfly.extensions.api.TransformationUtility<LocateFile>
    +
    Locates a file based on the relative or absolute + location specified. It does not find files, it just results + to a 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. +
    + Note: the term "file" here might refer to a folder as well
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      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.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      intgetParentLevel() 
      LocateFilesetParentLevel(int parentLevel) +
      Set how many parent levels up the location process should + go through.
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LocateFile

        +
        public LocateFile()
        +
        Locates a file based on the relative or absolute + location specified. It does not find files, it just results + to a 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 +
        + Note: the term "file" here might refer to a folder as well
        +
        • +
      + + + +
        +
      • +

        LocateFile

        +
        public LocateFile(int parentLevel)
        +
        Locates a file based on the relative or absolute + location specified. It does not find files, it just results + to a 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 +
        + Note: the term "file" here might refer to a folder as well
        +
        +
        Parameters:
        +
        parentLevel - how many parent levels to be located
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setParentLevel

        +
        public LocateFile setParentLevel(int parentLevel)
        +
        Set how many parent levels up the location process should + go through. If not set, the actual specified file will be + the located one.
        +
        +
        Parameters:
        +
        parentLevel - how many parent levels to be located
        +
        Returns:
        +
        this instance
        +
        +
        • +
      + + + +
        +
      • +

        getParentLevel

        +
        public int getParentLevel()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<LocateFile>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<LocateFile>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/package-frame.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/package-frame.html new file mode 100644 index 00000000..267b03ed --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/package-frame.html @@ -0,0 +1,23 @@ + + + + + +com.paypal.butterfly.utilities.file (butterfly-utilities 3.2.1 API) + + + + + +

com.paypal.butterfly.utilities.file

+
+

Classes

+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/package-summary.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/package-summary.html new file mode 100644 index 00000000..3cca364b --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/package-summary.html @@ -0,0 +1,177 @@ + + + + + +com.paypal.butterfly.utilities.file (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.paypal.butterfly.utilities.file

+
+
Transformation utilities to gather meta-data, find and locate files.
+
+

See: Description

+
+
+ + + + +

Package com.paypal.butterfly.utilities.file Description

+
Transformation utilities to gather meta-data, find and locate files.
+
+
Since:
+
1.0.0
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/package-tree.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/package-tree.html new file mode 100644 index 00000000..9e172c60 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/file/package-tree.html @@ -0,0 +1,142 @@ + + + + + +com.paypal.butterfly.utilities.file Class Hierarchy (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.paypal.butterfly.utilities.file

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/java/JavaPackage.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/java/JavaPackage.html new file mode 100644 index 00000000..f14584fc --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/java/JavaPackage.html @@ -0,0 +1,325 @@ + + + + + +JavaPackage (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.java
+

Class JavaPackage

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class JavaPackage
+extends com.paypal.butterfly.extensions.api.TransformationUtility<JavaPackage>
    +
    Retrieves the package + of a given Java class.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      JavaPackage() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        JavaPackage

        +
        public JavaPackage()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<JavaPackage>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<JavaPackage>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/java/package-frame.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/java/package-frame.html new file mode 100644 index 00000000..8e68cf4e --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/java/package-frame.html @@ -0,0 +1,20 @@ + + + + + +com.paypal.butterfly.utilities.java (butterfly-utilities 3.2.1 API) + + + + + +

com.paypal.butterfly.utilities.java

+
+

Classes

+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/java/package-summary.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/java/package-summary.html new file mode 100644 index 00000000..9b686690 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/java/package-summary.html @@ -0,0 +1,156 @@ + + + + + +com.paypal.butterfly.utilities.java (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.paypal.butterfly.utilities.java

+
+
Transformation utilities to gather meta-data about Java class files.
+
+

See: Description

+
+
+ + + + +

Package com.paypal.butterfly.utilities.java Description

+
Transformation utilities to gather meta-data about Java class files.
+
+
Since:
+
1.0.0
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/java/package-tree.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/java/package-tree.html new file mode 100644 index 00000000..e6f23837 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/java/package-tree.html @@ -0,0 +1,139 @@ + + + + + +com.paypal.butterfly.utilities.java Class Hierarchy (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.paypal.butterfly.utilities.java

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/EnforcerErrorsOutputHandler.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/EnforcerErrorsOutputHandler.html new file mode 100644 index 00000000..4b87529c --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/EnforcerErrorsOutputHandler.html @@ -0,0 +1,327 @@ + + + + + +EnforcerErrorsOutputHandler (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.paypal.butterfly.utilities.maven
+

Class EnforcerErrorsOutputHandler

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidconsumeLine(java.lang.String line) 
      EnforcerErrorsOutputHandlercopy() +
      Returns a copy of this object, but with its internal state reset, + so it can be run in a brand new Maven invocation
      +
      java.util.Set<java.lang.String>getResult() +
      Returns the desired result from parsing the console output
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        EnforcerErrorsOutputHandler

        +
        public EnforcerErrorsOutputHandler()
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/GenericErrorsOutputHandler.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/GenericErrorsOutputHandler.html new file mode 100644 index 00000000..7376aa59 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/GenericErrorsOutputHandler.html @@ -0,0 +1,327 @@ + + + + + +GenericErrorsOutputHandler (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.paypal.butterfly.utilities.maven
+

Class GenericErrorsOutputHandler

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidconsumeLine(java.lang.String line) 
      GenericErrorsOutputHandlercopy() +
      Returns a copy of this object, but with its internal state reset, + so it can be run in a brand new Maven invocation
      +
      java.lang.StringgetResult() +
      Returns the desired result from parsing the console output
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/MavenGoal.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/MavenGoal.html new file mode 100644 index 00000000..d618a0d3 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/MavenGoal.html @@ -0,0 +1,551 @@ + + + + + +MavenGoal (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.maven
+

Class MavenGoal

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class MavenGoal
+extends com.paypal.butterfly.extensions.api.TransformationUtility<MavenGoal>
    +
    Runs one or more Maven goals against a specific Maven POM file or a directory. + It produces as result a map whose key is Class<? extends MavenInvocationOutputHandler> + and the value is Object, which is the result of each registered MavenInvocationOutputHandler. + If no output handler is registered, or no result is produced for any reason, and empty map is returned.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      MavenGoal() +
      Runs one or more Maven goals against a specific Maven POM file or a directory.
      +
      MavenGoal(java.lang.String... goals) +
      Runs one or more Maven goals against a specific Maven POM file or a directory.
      +
      MavenGoal(java.lang.String[] goals, + MavenInvocationOutputHandler[] outputHandlers) +
      Runs one or more Maven goals against a specific Maven POM file or a directory.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      MavenGoalclone() 
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      java.lang.String[]getGoals() +
      Return the Maven goals to be executed
      +
      MavenInvocationOutputHandler[]getOutputHandlers() +
      Return the output handlers to be executed against the Maven goals execution result
      +
      java.util.PropertiesgetProperties() +
      Return the Maven properties for the goal
      +
      MavenGoalsetGoals(java.lang.String... goals) +
      Set the Maven goals to be executed
      +
      MavenGoalsetOutputHandlers(MavenInvocationOutputHandler... outputHandlers) +
      Set the output handlers to be executed against the Maven goals execution result
      +
      MavenGoalsetProperties(java.util.Properties properties) +
      Set the Maven properties for the goal
      +
      MavenGoalsetWarnOnError(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.
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MavenGoal

        +
        public MavenGoal()
        +
        Runs one or more Maven goals against a specific Maven POM file or a directory. + It produces as result a map whose key is Class<? extends MavenInvocationOutputHandler> + and the value is Object, which is the result of each registered MavenInvocationOutputHandler. + If no output handler is registered, or no result is produced for any reason, and empty map is returned.
        +
        • +
      + + + +
        +
      • +

        MavenGoal

        +
        public MavenGoal(java.lang.String... goals)
        +
        Runs one or more Maven goals against a specific Maven POM file or a directory. + It produces as result a map whose key is Class<? extends MavenInvocationOutputHandler> + and the value is Object, which is the result of each registered MavenInvocationOutputHandler. + If no output handler is registered, or no result is produced for any reason, and empty map is returned.
        +
        +
        Parameters:
        +
        goals - Maven goals to be executed
        +
        +
        • +
      + + + +
        +
      • +

        MavenGoal

        +
        public MavenGoal(java.lang.String[] goals,
+                 MavenInvocationOutputHandler[] outputHandlers)
        +
        Runs one or more Maven goals against a specific Maven POM file or a directory. + It produces as result a map whose key is Class<? extends MavenInvocationOutputHandler> + and the value is Object, which is the result of each registered MavenInvocationOutputHandler. + If no output handler is registered, or no result is produced for any reason, and empty map is returned.
        +
        +
        Parameters:
        +
        goals - Maven goals to be executed
        +
        outputHandlers - output handlers to be executed against the Maven goals execution result
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setGoals

        +
        public MavenGoal setGoals(java.lang.String... goals)
        +
        Set the Maven goals to be executed
        +
        +
        Parameters:
        +
        goals - Maven goals to be executed
        +
        Returns:
        +
        this utility instance
        +
        +
        • +
      + + + +
        +
      • +

        setOutputHandlers

        +
        public MavenGoal setOutputHandlers(MavenInvocationOutputHandler... outputHandlers)
        +
        Set the output handlers to be executed against the Maven goals execution result
        +
        +
        Parameters:
        +
        outputHandlers - output handlers to be executed against the Maven goals execution result
        +
        Returns:
        +
        this utility instance
        +
        +
        • +
      + + + +
        +
      • +

        setProperties

        +
        public MavenGoal setProperties(java.util.Properties properties)
        +
        Set the Maven properties for the goal
        +
        +
        Parameters:
        +
        properties - equivalent to '-D' options
        +
        Returns:
        +
        this utility instance
        +
        +
        • +
      + + + +
        +
      • +

        setWarnOnError

        +
        public 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. The default value is error.
        +
        +
        Parameters:
        +
        warnOnError - whether, in case the maven goal command + does not succeed, a warn result type should be returned, + instead of error
        +
        Returns:
        +
        this utility instance
        +
        +
        • +
      + + + +
        +
      • +

        getGoals

        +
        public java.lang.String[] getGoals()
        +
        Return the Maven goals to be executed
        +
        +
        Returns:
        +
        the Maven goals to be executed
        +
        +
        • +
      + + + +
        +
      • +

        getProperties

        +
        public java.util.Properties getProperties()
        +
        Return the Maven properties for the goal
        +
        +
        Returns:
        +
        properties for the Maven invocation
        +
        +
        • +
      + + + +
        +
      • +

        getOutputHandlers

        +
        public MavenInvocationOutputHandler[] getOutputHandlers()
        +
        Return the output handlers to be executed against the Maven goals execution result
        +
        +
        Returns:
        +
        the output handlers to be executed against the Maven goals execution result
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<MavenGoal>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<MavenGoal>
        +
        +
        • +
      + + + +
        +
      • +

        clone

        +
        public MavenGoal clone()
        +
        +
        Overrides:
        +
        clone in class com.paypal.butterfly.extensions.api.TransformationUtility<MavenGoal>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/MavenInvocationOutputHandler.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/MavenInvocationOutputHandler.html new file mode 100644 index 00000000..6dcc99bb --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/MavenInvocationOutputHandler.html @@ -0,0 +1,265 @@ + + + + + +MavenInvocationOutputHandler (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.paypal.butterfly.utilities.maven
+

Interface MavenInvocationOutputHandler<T,R>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    org.apache.maven.shared.invoker.InvocationOutputHandler, org.apache.maven.shared.utils.cli.StreamConsumer
    +
    +
    +
    All Known Implementing Classes:
    +
    EnforcerErrorsOutputHandler, GenericErrorsOutputHandler
    +
    +
    +
    +
    public interface MavenInvocationOutputHandler<T,R>
+extends org.apache.maven.shared.invoker.InvocationOutputHandler
    +
    Reads lines from the Maven execution console output and return data after evaluating it.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      Tcopy() +
      Returns a copy of this object, but with its internal state reset, + so it can be run in a brand new Maven invocation
      +
      RgetResult() +
      Returns the desired result from parsing the console output
      +
      +
        +
      • + + +

        Methods inherited from interface org.apache.maven.shared.utils.cli.StreamConsumer

        +consumeLine
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getResult

        +
        R getResult()
        +
        Returns the desired result from parsing the console output
        +
        +
        Returns:
        +
        the desired result from parsing the console output
        +
        +
        • +
      + + + +
        +
      • +

        copy

        +
        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
        +
        +
        Returns:
        +
        a copy of this object, but with its internal state reset
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/RelatedArtifacts.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/RelatedArtifacts.html new file mode 100644 index 00000000..dbb4a4a2 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/RelatedArtifacts.html @@ -0,0 +1,463 @@ + + + + + +RelatedArtifacts (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.maven
+

Class RelatedArtifacts

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class RelatedArtifacts
+extends com.paypal.butterfly.extensions.api.TransformationUtility<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.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      RelatedArtifacts() 
      RelatedArtifacts(java.lang.String parentGroupId, + java.lang.String parentArtifactId, + java.lang.String parentVersion, + java.lang.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.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      java.lang.StringgetParentArtifactId() 
      java.lang.StringgetParentGroupId() 
      java.lang.StringgetParentVersion() 
      java.lang.StringgetPomFilesAttribute() 
      RelatedArtifactssetParentArtifactId(java.lang.String parentArtifactId) 
      RelatedArtifactssetParentGroupId(java.lang.String parentGroupId) 
      RelatedArtifactssetParentVersion(java.lang.String parentVersion) 
      RelatedArtifactssetPomFilesAttribute(java.lang.String pomFilesAttribute) 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RelatedArtifacts

        +
        public RelatedArtifacts()
        +
        • +
      + + + +
        +
      • +

        RelatedArtifacts

        +
        public RelatedArtifacts(java.lang.String parentGroupId,
+                        java.lang.String parentArtifactId,
+                        java.lang.String parentVersion,
+                        java.lang.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.
        +
        +
        Parameters:
        +
        parentGroupId - parent group id
        +
        parentArtifactId - parent artifact id
        +
        parentVersion - parent version
        +
        pomFilesAttribute - the name of the transformation context attribute that contains + a list of pom.xml files to be analyzed
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setParentGroupId

        +
        public RelatedArtifacts setParentGroupId(java.lang.String parentGroupId)
        +
        • +
      + + + +
        +
      • +

        setParentArtifactId

        +
        public RelatedArtifacts setParentArtifactId(java.lang.String parentArtifactId)
        +
        • +
      + + + +
        +
      • +

        setParentVersion

        +
        public RelatedArtifacts setParentVersion(java.lang.String parentVersion)
        +
        • +
      + + + +
        +
      • +

        setPomFilesAttribute

        +
        public RelatedArtifacts setPomFilesAttribute(java.lang.String pomFilesAttribute)
        +
        • +
      + + + +
        +
      • +

        getParentGroupId

        +
        public java.lang.String getParentGroupId()
        +
        • +
      + + + +
        +
      • +

        getParentArtifactId

        +
        public java.lang.String getParentArtifactId()
        +
        • +
      + + + +
        +
      • +

        getParentVersion

        +
        public java.lang.String getParentVersion()
        +
        • +
      + + + +
        +
      • +

        getPomFilesAttribute

        +
        public java.lang.String getPomFilesAttribute()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<RelatedArtifacts>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<RelatedArtifacts>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/package-frame.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/package-frame.html new file mode 100644 index 00000000..fad00c52 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/package-frame.html @@ -0,0 +1,27 @@ + + + + + +com.paypal.butterfly.utilities.maven (butterfly-utilities 3.2.1 API) + + + + + +

com.paypal.butterfly.utilities.maven

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/package-summary.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/package-summary.html new file mode 100644 index 00000000..eeba4fb4 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/package-summary.html @@ -0,0 +1,192 @@ + + + + + +com.paypal.butterfly.utilities.maven (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.paypal.butterfly.utilities.maven

+
+
Transformation utilities to gather meta-data about Maven POM files.
+
+

See: Description

+
+
+ + + + +

Package com.paypal.butterfly.utilities.maven Description

+
Transformation utilities to gather meta-data about Maven POM files.
+
+
Since:
+
1.0.0
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/package-tree.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/package-tree.html new file mode 100644 index 00000000..bc75800f --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/maven/package-tree.html @@ -0,0 +1,154 @@ + + + + + +com.paypal.butterfly.utilities.maven Class Hierarchy (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.paypal.butterfly.utilities.maven

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/misc/RunScript.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/misc/RunScript.html new file mode 100644 index 00000000..b381abed --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/misc/RunScript.html @@ -0,0 +1,486 @@ + + + + + +RunScript (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.misc
+

Class RunScript

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class RunScript
+extends com.paypal.butterfly.extensions.api.TransformationUtility<RunScript>
    +
    Executes a script and saves the result after evaluating it. + The scripting language can be chosen, and "js" is the default one. + Additionally, one or more objects, and/or transformation context attributes, + can be used in the script during transformation time.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      RunScript() +
      Executes a script and saves the result after evaluating it.
      +
      RunScript(java.lang.String script) +
      Executes a script and saves the result after evaluating it.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      RunScriptaddAttribute(java.lang.String key, + java.lang.String attributeName) +
      Adds a new transformation context attribute to be used in the script.
      +
      RunScriptaddObject(java.lang.String key, + java.lang.Object object) 
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.util.Map<java.lang.String,java.lang.String>getAttributes() 
      java.lang.StringgetDescription() 
      java.lang.StringgetLanguage() 
      java.util.Map<java.lang.String,java.lang.Object>getObjects() 
      java.lang.StringgetScript() 
      RunScriptsetLanguage(java.lang.String language) 
      RunScriptsetScript(java.lang.String script) +
      Sets the script to be executed and evaluated
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RunScript

        +
        public RunScript()
        +
        Executes a script and saves the result after evaluating it. + The scripting language can be chosen, and "js" is the default one. + Additionally, one or more objects, and/or transformation context attributes, + can be used in the script during transformation time.
        +
        • +
      + + + +
        +
      • +

        RunScript

        +
        public RunScript(java.lang.String script)
        +
        Executes a script and saves the result after evaluating it. + The scripting language can be chosen, and "js" is the default one. + Additionally, one or more objects, and/or transformation context attributes, + can be used in the script during transformation time.
        +
        +
        Parameters:
        +
        script - the script to be executed and evaluated
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setScript

        +
        public RunScript setScript(java.lang.String script)
        +
        Sets the script to be executed and evaluated
        +
        +
        Parameters:
        +
        script - the script to be executed and evaluated
        +
        Returns:
        +
        this utility instance
        +
        +
        • +
      + + + +
        +
      • +

        setLanguage

        +
        public RunScript setLanguage(java.lang.String language)
        +
        • +
      + + + +
        +
      • +

        addAttribute

        +
        public RunScript addAttribute(java.lang.String key,
+                              java.lang.String attributeName)
        +
        Adds a new transformation context attribute to be used in the script. + It has to be referred in the script text by its key, which acts as + a placeholder. If the transformation context attribute does not exist, + then null will be inserted in the script on its place.
        +
        +
        Parameters:
        +
        key - the attribute key name, to be used as placeholder in the script text
        +
        attributeName - the name of the transformation context attribute name whose value + should be inserted in the script, replacing the key
        +
        Returns:
        +
        this utility instance
        +
        +
        • +
      + + + +
        +
      • +

        addObject

        +
        public RunScript addObject(java.lang.String key,
+                           java.lang.Object object)
        +
        • +
      + + + +
        +
      • +

        getScript

        +
        public java.lang.String getScript()
        +
        • +
      + + + +
        +
      • +

        getLanguage

        +
        public java.lang.String getLanguage()
        +
        • +
      + + + +
        +
      • +

        getAttributes

        +
        public java.util.Map<java.lang.String,java.lang.String> getAttributes()
        +
        • +
      + + + +
        +
      • +

        getObjects

        +
        public java.util.Map<java.lang.String,java.lang.Object> getObjects()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<RunScript>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<RunScript>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/misc/WebXmlContextParams.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/misc/WebXmlContextParams.html new file mode 100644 index 00000000..1202e5b0 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/misc/WebXmlContextParams.html @@ -0,0 +1,330 @@ + + + + + +WebXmlContextParams (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.misc
+

Class WebXmlContextParams

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class WebXmlContextParams
+extends com.paypal.butterfly.extensions.api.TransformationUtility<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. +
    + Note: this utility does not validate the file's schema and content, + other than what it takes to identify all context-param elements at the document + element, and also their respective param-name and param-value elements
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        WebXmlContextParams

        +
        public WebXmlContextParams()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<WebXmlContextParams>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<WebXmlContextParams>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/misc/package-frame.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/misc/package-frame.html new file mode 100644 index 00000000..d3c5f9c9 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/misc/package-frame.html @@ -0,0 +1,21 @@ + + + + + +com.paypal.butterfly.utilities.misc (butterfly-utilities 3.2.1 API) + + + + + +

com.paypal.butterfly.utilities.misc

+
+

Classes

+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/misc/package-summary.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/misc/package-summary.html new file mode 100644 index 00000000..22c352f2 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/misc/package-summary.html @@ -0,0 +1,163 @@ + + + + + +com.paypal.butterfly.utilities.misc (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.paypal.butterfly.utilities.misc

+
+
Miscellaneous collection of transformation utilities.
+
+

See: Description

+
+
+ + + + +

Package com.paypal.butterfly.utilities.misc Description

+
Miscellaneous collection of transformation utilities.
+
+
Since:
+
1.0.0
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/misc/package-tree.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/misc/package-tree.html new file mode 100644 index 00000000..7a3c1964 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/misc/package-tree.html @@ -0,0 +1,140 @@ + + + + + +com.paypal.butterfly.utilities.misc Class Hierarchy (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.paypal.butterfly.utilities.misc

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/AbstractToOperation.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/AbstractToOperation.html new file mode 100644 index 00000000..b208ac78 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/AbstractToOperation.html @@ -0,0 +1,563 @@ + + + + + +AbstractToOperation (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations
+

Class AbstractToOperation<A extends AbstractToOperation>

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      protected java.lang.StringadditionalRelativePath 
      protected java.lang.Stringdescription 
      protected java.lang.StringtoAbsoluteAttribute 
      protected java.lang.StringtoRelative 
      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected AbstractToOperation(java.lang.String description) +
      Abstract "to" operation whenever a destination file path needs to be set.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetDescription() 
      protected java.io.FilegetFileTo(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetToAbsoluteAttribute() 
      java.lang.StringgetToRelative() 
      AsetDescription(java.lang.String description) 
      AsetToAbsolute(java.lang.String attributeName) +
      The name of the transformation context attribute that holds + the absolute destination location.
      +
      AsetToAbsolute(java.lang.String attributeName, + java.lang.String additionalRelativePath) +
      The name of the transformation context attribute that holds + the absolute destination location.
      +
      AsetToRelative(java.lang.String toRelative) +
      Set relative destination location.
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, execution, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        description

        +
        protected java.lang.String description
        +
        • +
      + + + +
        +
      • +

        toRelative

        +
        protected java.lang.String toRelative
        +
        • +
      + + + +
        +
      • +

        toAbsoluteAttribute

        +
        protected java.lang.String toAbsoluteAttribute
        +
        • +
      + + + +
        +
      • +

        additionalRelativePath

        +
        protected java.lang.String additionalRelativePath
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AbstractToOperation

        +
        protected AbstractToOperation(java.lang.String description)
        +
        Abstract "to" operation whenever a destination file path needs to be set. + To be specialized for more specific purposes, such as single + file copy, file move, directory copy or directory move.
        +
        +
        Parameters:
        +
        description - the operation description
        +
        See Also:
        +
        CopyFile, +CopyDirectory, +MoveFile, +MoveDirectory
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setDescription

        +
        public A setDescription(java.lang.String description)
        +
        • +
      + + + +
        +
      • +

        setToRelative

        +
        public A setToRelative(java.lang.String toRelative)
        +
        Set relative destination location. +
        + If the relative destination location is NOT known during transformation definition time, + then don't set it (leaving as null) and use setToAbsolute(String) + based on a transformation context attribute set by a + LocateFile + transformation utility. +
        + By setting this relative location, the absolute location attribute name is automatically set to null
        +
        +
        Parameters:
        +
        toRelative - relative destination location
        +
        Returns:
        +
        this transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        setToAbsolute

        +
        public A setToAbsolute(java.lang.String attributeName)
        +
        The name of the transformation context attribute that holds + the absolute destination location. +
        + If the relative destination location is known during transformation definition time, + then don't use this setter, use setToRelative(String) instead. +
        + By setting this attribute name, the relative destination location is automatically set to null
        +
        +
        Parameters:
        +
        attributeName - name of the transformation context attribute that holds + the absolute destination location
        +
        Returns:
        +
        this transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        setToAbsolute

        +
        public A setToAbsolute(java.lang.String attributeName,
+                       java.lang.String additionalRelativePath)
        +
        The name of the transformation context attribute that holds + the absolute destination location. +
        + If the relative destination location is known during transformation definition time, + then don't use this setter, use setToRelative(String) instead. +
        + By setting this attribute name, the relative destination location is automatically set to null
        +
        +
        Parameters:
        +
        attributeName - name of the transformation context attribute that holds + the absolute destination location
        +
        additionalRelativePath - 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)
        +
        Returns:
        +
        this transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        getToRelative

        +
        public java.lang.String getToRelative()
        +
        • +
      + + + +
        +
      • +

        getToAbsoluteAttribute

        +
        public java.lang.String getToAbsoluteAttribute()
        +
        • +
      + + + +
        +
      • +

        getFileTo

        +
        protected java.io.File getFileTo(java.io.File transformedAppFolder,
+                                 com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<A extends AbstractToOperation>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/ApplyFile.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/ApplyFile.html new file mode 100644 index 00000000..29e2cdad --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/ApplyFile.html @@ -0,0 +1,436 @@ + + + + + +ApplyFile (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.file
+

Class ApplyFile

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class ApplyFile
+extends com.paypal.butterfly.extensions.api.TransformationOperation<ApplyFile>
    +
    Applies a file, whose location is set as a URL, + into the transformed application. + The file is placed at the folder specified using + relative or absolute methods.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      ApplyFile() +
      Applies a file, whose location is set as a URL, + into the transformed application.
      +
      ApplyFile(java.lang.String fileUrl) +
      Applies a file, whose location is set as a URL, + into the transformed application.
      +
      ApplyFile(java.net.URL fileUrl) +
      /** + Applies a file, whose location is set as a URL, + into the transformed application.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      java.net.URLgetFileUrl() +
      Returns the URL to locate the file to be applied
      +
      ApplyFilesetFileUrl(java.net.URL fileUrl) +
      Set the URL to locate the file to be applied
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ApplyFile

        +
        public ApplyFile()
        +
        Applies a file, whose location is set as a URL, + into the transformed application. + The file is placed at the folder specified using + relative or absolute methods.
        +
        • +
      + + + +
        +
      • +

        ApplyFile

        +
        public ApplyFile(java.lang.String fileUrl)
        +
        Applies a file, whose location is set as a URL, + into the transformed application. + The file is placed at the folder specified using + relative or absolute methods.
        +
        +
        Parameters:
        +
        fileUrl - URL string to locate the file to be applied
        +
        +
        • +
      + + + +
        +
      • +

        ApplyFile

        +
        public ApplyFile(java.net.URL fileUrl)
        +
        /** + Applies a file, whose location is set as a URL, + into the transformed application. + The file is placed at the folder specified using + relative or absolute methods.
        +
        +
        Parameters:
        +
        fileUrl - URL to locate the file to be applied
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setFileUrl

        +
        public ApplyFile setFileUrl(java.net.URL fileUrl)
        +
        Set the URL to locate the file to be applied
        +
        +
        Parameters:
        +
        fileUrl - URL to locate the file to be applied
        +
        Returns:
        +
        this transformation utility
        +
        +
        • +
      + + + +
        +
      • +

        getFileUrl

        +
        public java.net.URL getFileUrl()
        +
        Returns the URL to locate the file to be applied
        +
        +
        Returns:
        +
        the URL to locate the file to be applied
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<ApplyFile>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<ApplyFile>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/ApplyZip.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/ApplyZip.html new file mode 100644 index 00000000..ea85e1b8 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/ApplyZip.html @@ -0,0 +1,410 @@ + + + + + +ApplyZip (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.file
+

Class ApplyZip

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class ApplyZip
+extends com.paypal.butterfly.extensions.api.TransformationOperation<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.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      ApplyZip() 
      ApplyZip(java.lang.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(java.net.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.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      java.net.URLgetZipFileUrl() 
      ApplyZipsetZipFileUrl(java.net.URL zipFileUrl) 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ApplyZip

        +
        public ApplyZip()
        +
        • +
      + + + +
        +
      • +

        ApplyZip

        +
        public ApplyZip(java.lang.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.
        +
        +
        Parameters:
        +
        zipFileUrl - URL string to locate the zip file to be applied
        +
        +
        • +
      + + + +
        +
      • +

        ApplyZip

        +
        public ApplyZip(java.net.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.
        +
        +
        Parameters:
        +
        zipFileUrl - URL to locate the zip file to be applied
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setZipFileUrl

        +
        public ApplyZip setZipFileUrl(java.net.URL zipFileUrl)
        +
        • +
      + + + +
        +
      • +

        getZipFileUrl

        +
        public java.net.URL getZipFileUrl()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<ApplyZip>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<ApplyZip>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/CopyDirectory.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/CopyDirectory.html new file mode 100644 index 00000000..f3206a4c --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/CopyDirectory.html @@ -0,0 +1,361 @@ + + + + + +CopyDirectory (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.file
+

Class CopyDirectory

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class CopyDirectory
+extends AbstractToOperation<CopyDirectory>
    +
    Copies the content of a directory from one location to another. + The files to be copied include sub-folders and their files, coming from relative + or absolute location. The path to the files to be copied are preserved, and those + folders are also copied to the destination location. If the destination directory + does not exist, it is created. But, if it does, then the content to be copied is + merged with the destination content, with the source taking precedence. +
    + Note: if all you want is to copy a set of specific files from one + location to another, then use a multiple transformation operation + (see TransformationTemplate.addMultiple()) with CopyFile
    +
    +
    See Also:
    +
    CopyFile, +MoveFile, +MoveDirectory
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      CopyDirectory() +
      Operation to copy the content of a directory from one location to another.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      + +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CopyDirectory

        +
        public CopyDirectory()
        +
        Operation to copy the content of a directory from one location to another. + The files to be copied include sub-folders and their files, coming rom relative + or absolute location. The path to the files to be copied are preserved, and those + folders are also copied to the destination location. If the destination directory + does not exist, it is created. But, if it does, then the content to be copied is + merged with the destination content, with the source taking precedence.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<CopyDirectory>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/CopyFile.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/CopyFile.html new file mode 100644 index 00000000..4933f8bb --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/CopyFile.html @@ -0,0 +1,368 @@ + + + + + +CopyFile (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.file
+

Class CopyFile

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class CopyFile
+extends AbstractToOperation<CopyFile>
    +
    Copies a file. The relative or absolute file is the + "from" file, while the "to" location is specified via AbstractToOperation.setToRelative(String) + or AbstractToOperation.setToAbsolute(String) +
    + Notes: +
      +
    1. If destinationDirectory does not exist, it (and any parent directories) will be created.
      2. +
    2. If a file source in destinationDirectory exists, it will be overwritten.
      3. +
    3. If you want to copy a set of specific files from one location to another, use a multiple transformation operation (see TransformationTemplate.addMultiple()) with CopyFile.
      4. +
    4. If you want to copy a directory and its content from one location to another, then use CopyDirectory instead.
      5. +
    5. If source file is actually a directory, an operation results in error.
      6. +
    +
    +
    See Also:
    +
    MoveFile, +CopyDirectory, +MoveDirectory
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      CopyFile() +
      Copies a file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      + +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CopyFile

        +
        public CopyFile()
        +
        Copies a file. The relative or absolute file is the + "from" file, while the "to" location is specified via AbstractToOperation.setToRelative(String) + or AbstractToOperation.setToAbsolute(String) +
        + Notes: +
          +
        1. If destinationDirectory does not exist, it (and any parent directories) will be created.
          2. +
        2. If a file source in destinationDirectory exists, it will be overwritten.
          3. +
        3. If you want to copy a set of specific files from one location to another, use a multiple transformation operation (see TransformationTemplate.addMultiple()) with CopyFile.
          4. +
        4. If you want to copy a directory and its content from one location to another, then use CopyDirectory instead.
          5. +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<CopyFile>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/DeleteFile.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/DeleteFile.html new file mode 100644 index 00000000..3cde5aab --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/DeleteFile.html @@ -0,0 +1,337 @@ + + + + + +DeleteFile (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.file
+

Class DeleteFile

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class DeleteFile
+extends com.paypal.butterfly.extensions.api.TransformationOperation<DeleteFile>
    +
    Deletes a single file or folder (empty or not). + If the specified file does not exist, the result will be a TOExecutionResult.Type#NO_OP.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      DeleteFile() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DeleteFile

        +
        public DeleteFile()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<DeleteFile>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<DeleteFile>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/MoveDirectory.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/MoveDirectory.html new file mode 100644 index 00000000..d1f7bf93 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/MoveDirectory.html @@ -0,0 +1,359 @@ + + + + + +MoveDirectory (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.file
+

Class MoveDirectory

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MoveDirectory() +
      Moves a directory and its content from one location to another.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      + +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MoveDirectory

        +
        public MoveDirectory()
        +
        Moves a directory and its content from one location to another. + The directory to be moved is specified from relative + or absolute location. The name of the destination + directory will not be the same as the original one, but the one + specified via AbstractToOperation.setToRelative(String) + or AbstractToOperation.setToAbsolute(String). If the destination directory + already exists, an error is returned.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<MoveDirectory>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/MoveFile.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/MoveFile.html new file mode 100644 index 00000000..c5f706ec --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/MoveFile.html @@ -0,0 +1,360 @@ + + + + + +MoveFile (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.file
+

Class MoveFile

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class MoveFile
+extends AbstractToOperation<MoveFile>
    +
    Moves a file. The relative or absolute file is the + "from" file, while the "to" location is specified via AbstractToOperation.setToRelative(String) + or AbstractToOperation.setToAbsolute(String) +
    + Notes: +
      +
    1. If destinationDirectory does not exist, it (and any parent directories) will be created.
      2. +
    2. If a file source in destinationDirectory exists, it will be overwritten.
      3. +
    3. If you want to move a set of specific files from one location to another, then use a multiple transformation operation (see TransformationTemplate.addMultiple()) with MoveFile.
      4. +
    4. If you want to move a directory and its content from one location to another, then use MoveDirectory instead.
      5. +
    5. If source file is actually a directory, an operation results in error.
      6. +
    +
    +
    See Also:
    +
    CopyFile, +CopyDirectory, +MoveDirectory
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MoveFile() +
      Moves a file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      + +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<MoveFile>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/RenameFile.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/RenameFile.html new file mode 100644 index 00000000..7f4194ac --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/RenameFile.html @@ -0,0 +1,384 @@ + + + + + +RenameFile (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.file
+

Class RenameFile

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class RenameFile
+extends com.paypal.butterfly.extensions.api.TransformationOperation<RenameFile>
    +
    Renames a single file.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      RenameFile() +
      Renames a single file.
      +
      RenameFile(java.lang.String newName) +
      Renames a single file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      java.lang.StringgetNewName() 
      RenameFilesetNewName(java.lang.String newName) 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RenameFile

        +
        public RenameFile()
        +
        Renames a single file.
        +
        • +
      + + + +
        +
      • +

        RenameFile

        +
        public RenameFile(java.lang.String newName)
        +
        Renames a single file.
        +
        +
        Parameters:
        +
        newName - new name for the file
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setNewName

        +
        public RenameFile setNewName(java.lang.String newName)
        +
        • +
      + + + +
        +
      • +

        getNewName

        +
        public java.lang.String getNewName()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<RenameFile>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<RenameFile>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/package-frame.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/package-frame.html new file mode 100644 index 00000000..24eb8682 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/package-frame.html @@ -0,0 +1,27 @@ + + + + + +com.paypal.butterfly.utilities.operations.file (butterfly-utilities 3.2.1 API) + + + + + +

com.paypal.butterfly.utilities.operations.file

+
+

Classes

+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/package-summary.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/package-summary.html new file mode 100644 index 00000000..a4ed2a63 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/package-summary.html @@ -0,0 +1,200 @@ + + + + + +com.paypal.butterfly.utilities.operations.file (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.paypal.butterfly.utilities.operations.file

+
+
Transformation operations to manipulate files.
+
+

See: Description

+
+
+ + + + +

Package com.paypal.butterfly.utilities.operations.file Description

+
Transformation operations to manipulate files.
+
+
Since:
+
1.0.0
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/package-tree.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/package-tree.html new file mode 100644 index 00000000..10c76ae8 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/file/package-tree.html @@ -0,0 +1,154 @@ + + + + + +com.paypal.butterfly.utilities.operations.file Class Hierarchy (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.paypal.butterfly.utilities.operations.file

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/package-frame.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/package-frame.html new file mode 100644 index 00000000..cb58250c --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/package-frame.html @@ -0,0 +1,20 @@ + + + + + +com.paypal.butterfly.utilities.operations (butterfly-utilities 3.2.1 API) + + + + + +

com.paypal.butterfly.utilities.operations

+
+

Classes

+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/package-summary.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/package-summary.html new file mode 100644 index 00000000..af3fbd18 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/package-summary.html @@ -0,0 +1,165 @@ + + + + + +com.paypal.butterfly.utilities.operations (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.paypal.butterfly.utilities.operations

+
+
Multiple transformation operations, organized by type, each one having its own subpackage.
+
+

See: Description

+
+
+ + + + +

Package com.paypal.butterfly.utilities.operations Description

+
Multiple transformation operations, organized by type, each one having its own subpackage. + Transformation operation is a special type of transformation utility, which DOES apply modifications + to the project folder. +
+ Differences between transformation utilities and transformation operations: +
    +
  • Utilities never modify the application. Operations always do.
    • +
  • Utilities usually return a value, but not necessarily. Operations never do.
    • +
  • Utilities usually save its result meta-data object in the transformation context, but not necessarily. Operations always do.
    • +
  • Operations allow multiple operations.
    • +
+
+
Since:
+
1.0.0
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/package-tree.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/package-tree.html new file mode 100644 index 00000000..72c48da0 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/package-tree.html @@ -0,0 +1,143 @@ + + + + + +com.paypal.butterfly.utilities.operations Class Hierarchy (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.paypal.butterfly.utilities.operations

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/AbstractStaxArtifactPomOperation.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/AbstractStaxArtifactPomOperation.html new file mode 100644 index 00000000..03ae71aa --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/AbstractStaxArtifactPomOperation.html @@ -0,0 +1,565 @@ + + + + + +AbstractStaxArtifactPomOperation (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.pom
+

Class AbstractStaxArtifactPomOperation<T extends AbstractStaxArtifactPomOperation>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    +
    PomAddParent
    +
    +
    +
    +
    public abstract class AbstractStaxArtifactPomOperation<T extends AbstractStaxArtifactPomOperation>
+extends com.paypal.butterfly.utilities.operations.pom.stax.AbstractStaxOperation<T>
    +
    Abstract Artifact POM operation.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      protected java.lang.StringartifactId 
      protected java.lang.StringgroupId 
      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.utilities.operations.pom.stax.AbstractStaxOperation

        +eventFactory, LINE_FEED
        • +
      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object obj) 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetArtifactId() 
      java.lang.StringgetGroupId() 
      protected org.apache.maven.model.ModelgetModel(java.io.File pomFile) 
      inthashCode() 
      protected abstract com.paypal.butterfly.extensions.api.TOExecutionResultpomExecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      TsetArtifact(java.lang.String artifact) +
      Set dependency group id and artifact id based on a String + whose format is "groupId:artifactId".
      +
      TsetArtifactId(java.lang.String artifactId) 
      TsetGroupId(java.lang.String groupId) 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultxmlExecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.utilities.operations.pom.stax.AbstractStaxOperation

        +clone, copyUntil, getIndentation, getReader, getWriter, skipUntil, writeMultiple
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        groupId

        +
        protected java.lang.String groupId
        +
        • +
      + + + +
        +
      • +

        artifactId

        +
        protected java.lang.String artifactId
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AbstractStaxArtifactPomOperation

        +
        public AbstractStaxArtifactPomOperation()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setGroupId

        +
        public T setGroupId(java.lang.String groupId)
        +
        • +
      + + + +
        +
      • +

        setArtifactId

        +
        public T setArtifactId(java.lang.String artifactId)
        +
        • +
      + + + +
        +
      • +

        setArtifact

        +
        public T setArtifact(java.lang.String artifact)
        +
        Set dependency group id and artifact id based on a String + whose format is "groupId:artifactId". It throws a + TransformationDefinitionException if the specified + artifact String is invalid
        +
        +
        Parameters:
        +
        artifact - the artifact formatted String
        +
        Returns:
        +
        this operation instance
        +
        +
        • +
      + + + +
        +
      • +

        getGroupId

        +
        public java.lang.String getGroupId()
        +
        • +
      + + + +
        +
      • +

        getArtifactId

        +
        public java.lang.String getArtifactId()
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends AbstractStaxArtifactPomOperation>
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends AbstractStaxArtifactPomOperation>
        +
        +
        • +
      + + + +
        +
      • +

        getModel

        +
        protected org.apache.maven.model.Model getModel(java.io.File pomFile)
+                                         throws java.io.IOException,
+                                                org.codehaus.plexus.util.xml.pull.XmlPullParserException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        org.codehaus.plexus.util.xml.pull.XmlPullParserException
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Overrides:
        +
        execution in class com.paypal.butterfly.utilities.operations.pom.stax.AbstractStaxOperation<T extends com.paypal.butterfly.utilities.operations.pom.AbstractStaxPomOperation>
        +
        +
        • +
      + + + +
        +
      • +

        xmlExecution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult xmlExecution(java.io.File transformedAppFolder,
+                                                                             com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
+                                                                      throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
+                                                                             javax.xml.stream.XMLStreamException,
+                                                                             java.io.IOException
        +
        +
        Specified by:
        +
        xmlExecution in class com.paypal.butterfly.utilities.operations.pom.stax.AbstractStaxOperation<T extends com.paypal.butterfly.utilities.operations.pom.AbstractStaxPomOperation>
        +
        Throws:
        +
        org.codehaus.plexus.util.xml.pull.XmlPullParserException
        +
        javax.xml.stream.XMLStreamException
        +
        java.io.IOException
        +
        +
        • +
      + + + +
        +
      • +

        pomExecution

        +
        protected abstract com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(java.io.File transformedAppFolder,
+                                                                                      com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
+                                                                               throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
+                                                                                      javax.xml.stream.XMLStreamException,
+                                                                                      java.io.IOException
        +
        +
        Throws:
        +
        org.codehaus.plexus.util.xml.pull.XmlPullParserException
        +
        javax.xml.stream.XMLStreamException
        +
        java.io.IOException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddDependency.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddDependency.html new file mode 100644 index 00000000..2d56b0c2 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddDependency.html @@ -0,0 +1,603 @@ + + + + + +PomAddDependency (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.pom
+

Class PomAddDependency

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.paypal.butterfly.extensions.api.operations.AddElement<PomAddDependency>, java.lang.Cloneable
    +
    +
    +
    +
    public class PomAddDependency
+extends com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomAddDependency>
+implements com.paypal.butterfly.extensions.api.operations.AddElement<PomAddDependency>
    +
    Adds a new dependency to a POM file. + If the POM file already has the specified dependency, the operation will return an error. + That behavior can be changed though, see AddElement for further details.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface com.paypal.butterfly.extensions.api.operations.AddElement

        +com.paypal.butterfly.extensions.api.operations.AddElement.IfPresent
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation

        +artifactId, groupId
        • +
      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomAddDependency() 
      PomAddDependency(java.lang.String groupId, + java.lang.String artifactId) +
      Operation to add a new dependency to a POM file.
      +
      PomAddDependency(java.lang.String groupId, + java.lang.String artifactId, + java.lang.String version) +
      Operation to add a new dependency to a POM file.
      +
      PomAddDependency(java.lang.String groupId, + java.lang.String artifactId, + java.lang.String version, + java.lang.String scope) +
      Operation to add a new dependency to a POM file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File arg0, + com.paypal.butterfly.extensions.api.TransformationContext arg1) 
      PomAddDependencyfailIfPresent() 
      java.lang.StringgetDescription() 
      java.lang.StringgetScope() 
      java.lang.StringgetVersion() 
      PomAddDependencynoOpIfPresent() 
      PomAddDependencyoverwriteIfPresent() 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultpomExecution(java.lang.String relativePomFile, + org.apache.maven.model.Model model) 
      PomAddDependencysetScope(java.lang.String scope) 
      PomAddDependencysetVersion(java.lang.String version) 
      PomAddDependencywarnButAddIfPresent() 
      PomAddDependencywarnNotAddIfPresent() 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation

        +equals, getArtifactId, getDependency, getDependency, getGroupId, getManagedDependency, getManagedDependency, getManagedPlugin, getManagedPlugin, getPlugin, getPlugin, hashCode, setArtifact, setArtifactId, setGroupId
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomAddDependency

        +
        public PomAddDependency()
        +
        • +
      + + + +
        +
      • +

        PomAddDependency

        +
        public PomAddDependency(java.lang.String groupId,
+                        java.lang.String artifactId)
        +
        Operation to add a new dependency to a POM file. + This constructor assumes this is a managed dependency, since the version + is not set. However, if that is not really the case, during transformation + this operation will fail pre-validation.
        +
        +
        Parameters:
        +
        groupId - new dependency group id
        +
        artifactId - new dependency artifact id
        +
        +
        • +
      + + + +
        +
      • +

        PomAddDependency

        +
        public PomAddDependency(java.lang.String groupId,
+                        java.lang.String artifactId,
+                        java.lang.String version)
        +
        Operation to add a new dependency to a POM file.
        +
        +
        Parameters:
        +
        groupId - new dependency group id
        +
        artifactId - new dependency artifact id
        +
        version - new dependency artifact version
        +
        +
        • +
      + + + +
        +
      • +

        PomAddDependency

        +
        public PomAddDependency(java.lang.String groupId,
+                        java.lang.String artifactId,
+                        java.lang.String version,
+                        java.lang.String scope)
        +
        Operation to add a new dependency to a POM file.
        +
        +
        Parameters:
        +
        groupId - new dependency group id
        +
        artifactId - new dependency artifact id
        +
        version - new dependency artifact version
        +
        scope - new dependency artifact scope
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setVersion

        +
        public PomAddDependency setVersion(java.lang.String version)
        +
        • +
      + + + + + + + +
        +
      • +

        failIfPresent

        +
        public PomAddDependency failIfPresent()
        +
        +
        Specified by:
        +
        failIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddDependency>
        +
        +
        • +
      + + + +
        +
      • +

        warnNotAddIfPresent

        +
        public PomAddDependency warnNotAddIfPresent()
        +
        +
        Specified by:
        +
        warnNotAddIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddDependency>
        +
        +
        • +
      + + + +
        +
      • +

        warnButAddIfPresent

        +
        public PomAddDependency warnButAddIfPresent()
        +
        +
        Specified by:
        +
        warnButAddIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddDependency>
        +
        +
        • +
      + + + +
        +
      • +

        noOpIfPresent

        +
        public PomAddDependency noOpIfPresent()
        +
        +
        Specified by:
        +
        noOpIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddDependency>
        +
        +
        • +
      + + + +
        +
      • +

        overwriteIfPresent

        +
        public PomAddDependency overwriteIfPresent()
        +
        +
        Specified by:
        +
        overwriteIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddDependency>
        +
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        public java.lang.String getVersion()
        +
        • +
      + + + +
        +
      • +

        getScope

        +
        public java.lang.String getScope()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomAddDependency>
        +
        +
        • +
      + + + +
        +
      • +

        pomExecution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(java.lang.String relativePomFile,
+                                                                             org.apache.maven.model.Model model)
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File arg0,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext arg1)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddManagedDependency.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddManagedDependency.html new file mode 100644 index 00000000..b337c088 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddManagedDependency.html @@ -0,0 +1,607 @@ + + + + + +PomAddManagedDependency (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.pom
+

Class PomAddManagedDependency

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.paypal.butterfly.extensions.api.operations.AddElement<PomAddManagedDependency>, java.lang.Cloneable
    +
    +
    +
    +
    public class PomAddManagedDependency
+extends com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomAddManagedDependency>
+implements com.paypal.butterfly.extensions.api.operations.AddElement<PomAddManagedDependency>
    +
    Adds a new managed dependency to a POM file. + If the POM file already has the specified managed dependency, the operation will return an error. + That behavior can be changed though, see AddElement for further details.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface com.paypal.butterfly.extensions.api.operations.AddElement

        +com.paypal.butterfly.extensions.api.operations.AddElement.IfPresent
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation

        +artifactId, groupId
        • +
      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomAddManagedDependency() +
      Operation to add a new managed dependency to a POM file.
      +
      PomAddManagedDependency(java.lang.String groupId, + java.lang.String artifactId, + java.lang.String version) +
      Operation to add a new managed dependency to a POM file.
      +
      PomAddManagedDependency(java.lang.String groupId, + java.lang.String artifactId, + java.lang.String version, + java.lang.String scope) +
      Operation to add a new managed dependency to a POM file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File arg0, + com.paypal.butterfly.extensions.api.TransformationContext arg1) 
      PomAddManagedDependencyfailIfPresent() 
      java.lang.StringgetDescription() 
      java.lang.StringgetScope() 
      java.lang.StringgetType() 
      java.lang.StringgetVersion() 
      PomAddManagedDependencynoOpIfPresent() 
      PomAddManagedDependencyoverwriteIfPresent() 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultpomExecution(java.lang.String relativePomFile, + org.apache.maven.model.Model model) 
      PomAddManagedDependencysetScope(java.lang.String scope) 
      PomAddManagedDependencysetType(java.lang.String type) 
      PomAddManagedDependencysetVersion(java.lang.String version) 
      PomAddManagedDependencywarnButAddIfPresent() 
      PomAddManagedDependencywarnNotAddIfPresent() 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation

        +equals, getArtifactId, getDependency, getDependency, getGroupId, getManagedDependency, getManagedDependency, getManagedPlugin, getManagedPlugin, getPlugin, getPlugin, hashCode, setArtifact, setArtifactId, setGroupId
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomAddManagedDependency

        +
        public PomAddManagedDependency()
        +
        Operation to add a new managed dependency to a POM file.
        +
        • +
      + + + +
        +
      • +

        PomAddManagedDependency

        +
        public PomAddManagedDependency(java.lang.String groupId,
+                               java.lang.String artifactId,
+                               java.lang.String version)
        +
        Operation to add a new managed dependency to a POM file.
        +
        +
        Parameters:
        +
        groupId - new managed dependency group id
        +
        artifactId - new managed dependency artifact id
        +
        version - new managed dependency artifact version
        +
        +
        • +
      + + + +
        +
      • +

        PomAddManagedDependency

        +
        public PomAddManagedDependency(java.lang.String groupId,
+                               java.lang.String artifactId,
+                               java.lang.String version,
+                               java.lang.String scope)
        +
        Operation to add a new managed dependency to a POM file.
        +
        +
        Parameters:
        +
        groupId - new managed dependency group id
        +
        artifactId - new managed dependency artifact id
        +
        version - new managed dependency artifact version
        +
        scope - new managed dependency artifact scope
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        getVersion

        +
        public java.lang.String getVersion()
        +
        • +
      + + + +
        +
      • +

        getScope

        +
        public java.lang.String getScope()
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public java.lang.String getType()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomAddManagedDependency>
        +
        +
        • +
      + + + +
        +
      • +

        pomExecution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(java.lang.String relativePomFile,
+                                                                             org.apache.maven.model.Model model)
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File arg0,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext arg1)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddModule.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddModule.html new file mode 100644 index 00000000..195c2ec7 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddModule.html @@ -0,0 +1,556 @@ + + + + + +PomAddModule (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.pom
+

Class PomAddModule

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.paypal.butterfly.extensions.api.operations.AddElement<PomAddModule>, java.lang.Cloneable
    +
    +
    +
    +
    public class PomAddModule
+extends com.paypal.butterfly.extensions.api.TransformationOperation<T>
+implements com.paypal.butterfly.extensions.api.operations.AddElement<PomAddModule>
    +
    Adds a new module to a POM file. + If the POM file already has a module with same name, the operation will return an error. + That behavior can be changed though, see AddElement for further details.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface com.paypal.butterfly.extensions.api.operations.AddElement

        +com.paypal.butterfly.extensions.api.operations.AddElement.IfPresent
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomAddModule() +
      Adds a new module to a POM file.
      +
      PomAddModule(java.lang.String moduleName) +
      Adds a new module to a POM file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object obj) 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File arg0, + com.paypal.butterfly.extensions.api.TransformationContext arg1) 
      PomAddModulefailIfPresent() 
      java.lang.StringgetDescription() 
      java.lang.StringgetModuleName() +
      Return the name of the module to be set by this operation
      +
      inthashCode() 
      PomAddModulenoOpIfPresent() 
      PomAddModuleoverwriteIfPresent() 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultpomExecution(java.lang.String relativePomFile, + org.apache.maven.model.Model model) 
      PomAddModulesetModuleName(java.lang.String moduleName) +
      Sets the name of the module to be set by this operation
      +
      PomAddModulewarnButAddIfPresent() 
      PomAddModulewarnNotAddIfPresent() 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomAddModule

        +
        public PomAddModule()
        +
        Adds a new module to a POM file. + If the POM file already has a module with same name, the operation will return an error. + That behavior can be changed though, see AddElement for further details.
        +
        • +
      + + + +
        +
      • +

        PomAddModule

        +
        public PomAddModule(java.lang.String moduleName)
        +
        Adds a new module to a POM file. + If the POM file already has a module with same name, the operation will return an error. + That behavior can be changed though, see AddElement for further details.
        +
        +
        Parameters:
        +
        moduleName - the name of the module to be set
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        failIfPresent

        +
        public PomAddModule failIfPresent()
        +
        +
        Specified by:
        +
        failIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddModule>
        +
        +
        • +
      + + + +
        +
      • +

        warnNotAddIfPresent

        +
        public PomAddModule warnNotAddIfPresent()
        +
        +
        Specified by:
        +
        warnNotAddIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddModule>
        +
        +
        • +
      + + + +
        +
      • +

        warnButAddIfPresent

        +
        public PomAddModule warnButAddIfPresent()
        +
        +
        Specified by:
        +
        warnButAddIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddModule>
        +
        +
        • +
      + + + +
        +
      • +

        noOpIfPresent

        +
        public PomAddModule noOpIfPresent()
        +
        +
        Specified by:
        +
        noOpIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddModule>
        +
        +
        • +
      + + + +
        +
      • +

        overwriteIfPresent

        +
        public PomAddModule overwriteIfPresent()
        +
        +
        Specified by:
        +
        overwriteIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddModule>
        +
        +
        • +
      + + + +
        +
      • +

        setModuleName

        +
        public PomAddModule setModuleName(java.lang.String moduleName)
        +
        Sets the name of the module to be set by this operation
        +
        +
        Parameters:
        +
        moduleName - the name of the module to be set
        +
        Returns:
        +
        this transformation operation
        +
        +
        • +
      + + + +
        +
      • +

        getModuleName

        +
        public java.lang.String getModuleName()
        +
        Return the name of the module to be set by this operation
        +
        +
        Returns:
        +
        the name of the module to be set
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomAddModule>
        +
        +
        • +
      + + + +
        +
      • +

        pomExecution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(java.lang.String relativePomFile,
+                                                                             org.apache.maven.model.Model model)
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class com.paypal.butterfly.extensions.api.TransformationUtility<PomAddModule>
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class com.paypal.butterfly.extensions.api.TransformationUtility<PomAddModule>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File arg0,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext arg1)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddParent.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddParent.html new file mode 100644 index 00000000..afd245a0 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddParent.html @@ -0,0 +1,603 @@ + + + + + +PomAddParent (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.pom
+

Class PomAddParent

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.paypal.butterfly.extensions.api.operations.AddElement<PomAddParent>, java.lang.Cloneable
    +
    +
    +
    +
    public class PomAddParent
+extends AbstractStaxArtifactPomOperation<PomAddParent>
+implements com.paypal.butterfly.extensions.api.operations.AddElement<PomAddParent>
    +
    Add a parent artifact in a Maven POM file. + If the POM file already has a parent, it will be overwritten. + That behavior can be changed though, see AddElement for further details.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface com.paypal.butterfly.extensions.api.operations.AddElement

        +com.paypal.butterfly.extensions.api.operations.AddElement.IfPresent
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.utilities.operations.pom.stax.AbstractStaxOperation

        +eventFactory, LINE_FEED
        • +
      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomAddParent() +
      Add a parent artifact in a Maven POM file.
      +
      PomAddParent(java.lang.String groupId, + java.lang.String artifactId, + java.lang.String version) +
      Operation to add a parent artifact in a Maven POM file
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      PomAddParentfailIfPresent() 
      java.lang.StringgetDescription() 
      protected org.apache.maven.model.ModelgetModel(java.io.File pomFile) 
      java.lang.StringgetVersion() 
      PomAddParentnoOpIfPresent() 
      PomAddParentoverwriteIfPresent() 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultpomExecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      PomAddParentsetVersion(java.lang.String version) 
      PomAddParentwarnButAddIfPresent() 
      PomAddParentwarnNotAddIfPresent() 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultxmlExecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      + +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.utilities.operations.pom.stax.AbstractStaxOperation

        +clone, copyUntil, getIndentation, getReader, getWriter, skipUntil, writeMultiple
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, copy, dependsOn, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomAddParent

        +
        public PomAddParent()
        +
        Add a parent artifact in a Maven POM file. + By default, if parent is already present, it is overwritten. + This behavior though can be changed.
        +
        • +
      + + + +
        +
      • +

        PomAddParent

        +
        public PomAddParent(java.lang.String groupId,
+                    java.lang.String artifactId,
+                    java.lang.String version)
        +
        Operation to add a parent artifact in a Maven POM file
        +
        +
        Parameters:
        +
        groupId - parent artifact group id to be set
        +
        artifactId - parent artifact id to be set
        +
        version - parent artifact version to be set
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setVersion

        +
        public PomAddParent setVersion(java.lang.String version)
        +
        • +
      + + + +
        +
      • +

        failIfPresent

        +
        public PomAddParent failIfPresent()
        +
        +
        Specified by:
        +
        failIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddParent>
        +
        +
        • +
      + + + +
        +
      • +

        warnNotAddIfPresent

        +
        public PomAddParent warnNotAddIfPresent()
        +
        +
        Specified by:
        +
        warnNotAddIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddParent>
        +
        +
        • +
      + + + +
        +
      • +

        warnButAddIfPresent

        +
        public PomAddParent warnButAddIfPresent()
        +
        +
        Specified by:
        +
        warnButAddIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddParent>
        +
        +
        • +
      + + + +
        +
      • +

        noOpIfPresent

        +
        public PomAddParent noOpIfPresent()
        +
        +
        Specified by:
        +
        noOpIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddParent>
        +
        +
        • +
      + + + +
        +
      • +

        overwriteIfPresent

        +
        public PomAddParent overwriteIfPresent()
        +
        +
        Specified by:
        +
        overwriteIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddParent>
        +
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        public java.lang.String getVersion()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomAddParent>
        +
        +
        • +
      + + + +
        +
      • +

        pomExecution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(java.io.File transformedAppFolder,
+                                                                             com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
+                                                                      throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
+                                                                             javax.xml.stream.XMLStreamException,
+                                                                             java.io.IOException
        +
        +
        Throws:
        +
        org.codehaus.plexus.util.xml.pull.XmlPullParserException
        +
        javax.xml.stream.XMLStreamException
        +
        java.io.IOException
        +
        +
        • +
      + + + +
        +
      • +

        getModel

        +
        protected org.apache.maven.model.Model getModel(java.io.File pomFile)
+                                         throws java.io.IOException,
+                                                org.codehaus.plexus.util.xml.pull.XmlPullParserException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        org.codehaus.plexus.util.xml.pull.XmlPullParserException
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Overrides:
        +
        execution in class com.paypal.butterfly.utilities.operations.pom.stax.AbstractStaxOperation<T extends com.paypal.butterfly.utilities.operations.pom.AbstractStaxPomOperation>
        +
        +
        • +
      + + + +
        +
      • +

        xmlExecution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult xmlExecution(java.io.File transformedAppFolder,
+                                                                             com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
+                                                                      throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
+                                                                             javax.xml.stream.XMLStreamException,
+                                                                             java.io.IOException
        +
        +
        Specified by:
        +
        xmlExecution in class com.paypal.butterfly.utilities.operations.pom.stax.AbstractStaxOperation<T extends com.paypal.butterfly.utilities.operations.pom.AbstractStaxPomOperation>
        +
        Throws:
        +
        org.codehaus.plexus.util.xml.pull.XmlPullParserException
        +
        javax.xml.stream.XMLStreamException
        +
        java.io.IOException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddPlugin.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddPlugin.html new file mode 100644 index 00000000..59426010 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddPlugin.html @@ -0,0 +1,583 @@ + + + + + +PomAddPlugin (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.pom
+

Class PomAddPlugin

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.paypal.butterfly.extensions.api.operations.AddElement<PomAddPlugin>, java.lang.Cloneable
    +
    +
    +
    +
    public class PomAddPlugin
+extends com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomAddPlugin>
+implements com.paypal.butterfly.extensions.api.operations.AddElement<PomAddPlugin>
    +
    Adds a new plugin to a POM file. + If the POM file already has the specified plugin, the operation will return an error. + That behavior can be changed though, see AddElement for further details.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface com.paypal.butterfly.extensions.api.operations.AddElement

        +com.paypal.butterfly.extensions.api.operations.AddElement.IfPresent
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation

        +artifactId, groupId
        • +
      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomAddPlugin() 
      PomAddPlugin(java.lang.String groupId, + java.lang.String artifactId) +
      Operation to add a new plugin to a POM file.
      +
      PomAddPlugin(java.lang.String groupId, + java.lang.String artifactId, + java.lang.String version) +
      Operation to add a new plugin to a POM file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object obj) 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File arg0, + com.paypal.butterfly.extensions.api.TransformationContext arg1) 
      PomAddPluginfailIfPresent() 
      java.lang.StringgetDescription() 
      java.lang.StringgetVersion() 
      inthashCode() 
      PomAddPluginnoOpIfPresent() 
      PomAddPluginoverwriteIfPresent() 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultpomExecution(java.lang.String relativePomFile, + org.apache.maven.model.Model model) 
      PomAddPluginsetVersion(java.lang.String version) 
      PomAddPluginwarnButAddIfPresent() 
      PomAddPluginwarnNotAddIfPresent() 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation

        +getArtifactId, getDependency, getDependency, getGroupId, getManagedDependency, getManagedDependency, getManagedPlugin, getManagedPlugin, getPlugin, getPlugin, setArtifact, setArtifactId, setGroupId
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomAddPlugin

        +
        public PomAddPlugin()
        +
        • +
      + + + +
        +
      • +

        PomAddPlugin

        +
        public PomAddPlugin(java.lang.String groupId,
+                    java.lang.String artifactId)
        +
        Operation to add a new plugin to a POM file. + This constructor assumes this is a managed plugin, since the version + is not set. However, if that is not really the case, during transformation + this operation will fail pre-validation.
        +
        +
        Parameters:
        +
        groupId - new plugin group id
        +
        artifactId - new plugin artifact id
        +
        +
        • +
      + + + +
        +
      • +

        PomAddPlugin

        +
        public PomAddPlugin(java.lang.String groupId,
+                    java.lang.String artifactId,
+                    java.lang.String version)
        +
        Operation to add a new plugin to a POM file.
        +
        +
        Parameters:
        +
        groupId - new plugin group id
        +
        artifactId - new plugin artifact id
        +
        version - new plugin artifact version
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setVersion

        +
        public PomAddPlugin setVersion(java.lang.String version)
        +
        • +
      + + + +
        +
      • +

        failIfPresent

        +
        public PomAddPlugin failIfPresent()
        +
        +
        Specified by:
        +
        failIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddPlugin>
        +
        +
        • +
      + + + +
        +
      • +

        warnNotAddIfPresent

        +
        public PomAddPlugin warnNotAddIfPresent()
        +
        +
        Specified by:
        +
        warnNotAddIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddPlugin>
        +
        +
        • +
      + + + +
        +
      • +

        warnButAddIfPresent

        +
        public PomAddPlugin warnButAddIfPresent()
        +
        +
        Specified by:
        +
        warnButAddIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddPlugin>
        +
        +
        • +
      + + + +
        +
      • +

        noOpIfPresent

        +
        public PomAddPlugin noOpIfPresent()
        +
        +
        Specified by:
        +
        noOpIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddPlugin>
        +
        +
        • +
      + + + +
        +
      • +

        overwriteIfPresent

        +
        public PomAddPlugin overwriteIfPresent()
        +
        +
        Specified by:
        +
        overwriteIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddPlugin>
        +
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        public java.lang.String getVersion()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomAddPlugin>
        +
        +
        • +
      + + + +
        +
      • +

        pomExecution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(java.lang.String relativePomFile,
+                                                                             org.apache.maven.model.Model model)
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomAddPlugin>
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomAddPlugin>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File arg0,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext arg1)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddProperty.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddProperty.html new file mode 100644 index 00000000..2abe7f9b --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomAddProperty.html @@ -0,0 +1,601 @@ + + + + + +PomAddProperty (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.pom
+

Class PomAddProperty

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.paypal.butterfly.extensions.api.operations.AddElement<PomAddProperty>, java.lang.Cloneable
    +
    +
    +
    +
    public class PomAddProperty
+extends com.paypal.butterfly.extensions.api.TransformationOperation<T>
+implements com.paypal.butterfly.extensions.api.operations.AddElement<PomAddProperty>
    +
    Adds a new property to a POM file. + If the POM file already has a property with same name, the operation will return an error. + That behavior can be changed though, see AddElement for further details.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface com.paypal.butterfly.extensions.api.operations.AddElement

        +com.paypal.butterfly.extensions.api.operations.AddElement.IfPresent
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomAddProperty() +
      Adds a new property to a POM file.
      +
      PomAddProperty(java.lang.String propertyName, + java.lang.String propertyValue) +
      Adds a new property to a POM file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object obj) 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File arg0, + com.paypal.butterfly.extensions.api.TransformationContext arg1) 
      PomAddPropertyfailIfPresent() 
      java.lang.StringgetDescription() 
      java.lang.StringgetPropertyName() +
      Return the name of the property to be set by this operation
      +
      java.lang.StringgetPropertyValue() +
      Returns the value of the property to be set by this operation
      +
      inthashCode() 
      PomAddPropertynoOpIfPresent() 
      PomAddPropertyoverwriteIfPresent() 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultpomExecution(java.lang.String relativePomFile, + org.apache.maven.model.Model model) 
      PomAddPropertysetPropertyName(java.lang.String propertyName) +
      Sets the name of the property to be set by this operation
      +
      PomAddPropertysetPropertyValue(java.lang.String propertyValue) +
      Sets the value of the property to be set by this operation
      +
      PomAddPropertywarnButAddIfPresent() 
      PomAddPropertywarnNotAddIfPresent() 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomAddProperty

        +
        public PomAddProperty()
        +
        Adds a new property to a POM file. + If the POM file already has a property with same name, the operation will return an error. + That behavior can be changed though, see AddElement for further details.
        +
        • +
      + + + +
        +
      • +

        PomAddProperty

        +
        public PomAddProperty(java.lang.String propertyName,
+                      java.lang.String propertyValue)
        +
        Adds a new property to a POM file. + If the POM file already has a property with same name, the operation will return an error. + That behavior can be changed though, see AddElement for further details.
        +
        +
        Parameters:
        +
        propertyName - the name of the property to be set
        +
        propertyValue - the value to be set to the property
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        failIfPresent

        +
        public PomAddProperty failIfPresent()
        +
        +
        Specified by:
        +
        failIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddProperty>
        +
        +
        • +
      + + + +
        +
      • +

        warnNotAddIfPresent

        +
        public PomAddProperty warnNotAddIfPresent()
        +
        +
        Specified by:
        +
        warnNotAddIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddProperty>
        +
        +
        • +
      + + + +
        +
      • +

        warnButAddIfPresent

        +
        public PomAddProperty warnButAddIfPresent()
        +
        +
        Specified by:
        +
        warnButAddIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddProperty>
        +
        +
        • +
      + + + +
        +
      • +

        noOpIfPresent

        +
        public PomAddProperty noOpIfPresent()
        +
        +
        Specified by:
        +
        noOpIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddProperty>
        +
        +
        • +
      + + + +
        +
      • +

        overwriteIfPresent

        +
        public PomAddProperty overwriteIfPresent()
        +
        +
        Specified by:
        +
        overwriteIfPresent in interface com.paypal.butterfly.extensions.api.operations.AddElement<PomAddProperty>
        +
        +
        • +
      + + + +
        +
      • +

        setPropertyName

        +
        public PomAddProperty setPropertyName(java.lang.String propertyName)
        +
        Sets the name of the property to be set by this operation
        +
        +
        Parameters:
        +
        propertyName - the name of the property to be set
        +
        Returns:
        +
        this transformation operation
        +
        +
        • +
      + + + +
        +
      • +

        setPropertyValue

        +
        public PomAddProperty setPropertyValue(java.lang.String propertyValue)
        +
        Sets the value of the property to be set by this operation
        +
        +
        Parameters:
        +
        propertyValue - the value to be set to the property
        +
        Returns:
        +
        this transformation operation
        +
        +
        • +
      + + + +
        +
      • +

        getPropertyName

        +
        public java.lang.String getPropertyName()
        +
        Return the name of the property to be set by this operation
        +
        +
        Returns:
        +
        the name of the property to be set
        +
        +
        • +
      + + + +
        +
      • +

        getPropertyValue

        +
        public java.lang.String getPropertyValue()
        +
        Returns the value of the property to be set by this operation
        +
        +
        Returns:
        +
        the value to be set to the property
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomAddProperty>
        +
        +
        • +
      + + + +
        +
      • +

        pomExecution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(java.lang.String relativePomFile,
+                                                                             org.apache.maven.model.Model model)
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class com.paypal.butterfly.extensions.api.TransformationUtility<PomAddProperty>
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class com.paypal.butterfly.extensions.api.TransformationUtility<PomAddProperty>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File arg0,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext arg1)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangeDependency.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangeDependency.html new file mode 100644 index 00000000..15799f1b --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangeDependency.html @@ -0,0 +1,685 @@ + + + + + +PomChangeDependency (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.pom
+

Class PomChangeDependency

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeDependency>, java.lang.Cloneable
    +
    +
    +
    +
    public class PomChangeDependency
+extends com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomChangeDependency>
+implements com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeDependency>
    +
    Changes a dependency in a Maven POM file. + It allows changing anything but group id and artifact id. + It also allows removing specific configuration, letting them + to have default values, or be managed when applicable. +
    + If the POM file does not have the specified dependency, the operation will return an error. + That behavior can be changed though, see ChangeOrRemoveElement for further details. +
    + Important: no check will be done here for possible reasons to break + the build, like the lack of version when the dependency is not managed
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement

        +com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresent
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation

        +artifactId, groupId
        • +
      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomChangeDependency() 
      PomChangeDependency(java.lang.String groupId, + java.lang.String artifactId) +
      Operation to change a dependency in a Maven POM file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File arg0, + com.paypal.butterfly.extensions.api.TransformationContext arg1) 
      PomChangeDependencyfailIfNotPresent() 
      java.lang.StringgetDescription() 
      java.lang.StringgetScope() 
      java.lang.StringgetType() 
      java.lang.StringgetVersion() 
      java.lang.BooleanisOptional() 
      booleanisRemoveOptional() 
      booleanisRemoveScope() 
      booleanisRemoveType() 
      booleanisRemoveVersion() 
      PomChangeDependencynoOpIfNotPresent() 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultpomExecution(java.lang.String relativePomFile, + org.apache.maven.model.Model model) 
      PomChangeDependencyremoveOptional() 
      PomChangeDependencyremoveScope() 
      PomChangeDependencyremoveType() 
      PomChangeDependencyremoveVersion() 
      PomChangeDependencysetOptional() 
      PomChangeDependencysetScope(java.lang.String scope) 
      PomChangeDependencysetType(java.lang.String type) 
      PomChangeDependencysetVersion(java.lang.String version) 
      PomChangeDependencywarnIfNotPresent() 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation

        +equals, getArtifactId, getDependency, getDependency, getGroupId, getManagedDependency, getManagedDependency, getManagedPlugin, getManagedPlugin, getPlugin, getPlugin, hashCode, setArtifact, setArtifactId, setGroupId
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomChangeDependency

        +
        public PomChangeDependency()
        +
        • +
      + + + +
        +
      • +

        PomChangeDependency

        +
        public PomChangeDependency(java.lang.String groupId,
+                           java.lang.String artifactId)
        +
        Operation to change a dependency in a Maven POM file. + It allows changing anything but group id and artifact id. + It also allows removing specific configuration, letting them + to have default values, or be managed when applicable. +
        + If the dependency to be changed doesn't actually exist, it will result + in error +
        + Important: no check will be done here for possible reasons to break + the build, like the lack of version when the dependency is not managed
        +
        +
        Parameters:
        +
        groupId - dependency group id
        +
        artifactId - dependency artifact id
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        failIfNotPresent

        +
        public PomChangeDependency failIfNotPresent()
        +
        +
        Specified by:
        +
        failIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeDependency>
        +
        +
        • +
      + + + +
        +
      • +

        warnIfNotPresent

        +
        public PomChangeDependency warnIfNotPresent()
        +
        +
        Specified by:
        +
        warnIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeDependency>
        +
        +
        • +
      + + + +
        +
      • +

        noOpIfNotPresent

        +
        public PomChangeDependency noOpIfNotPresent()
        +
        +
        Specified by:
        +
        noOpIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeDependency>
        +
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        public java.lang.String getVersion()
        +
        • +
      + + + +
        +
      • +

        getScope

        +
        public java.lang.String getScope()
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public java.lang.String getType()
        +
        • +
      + + + +
        +
      • +

        isOptional

        +
        public java.lang.Boolean isOptional()
        +
        • +
      + + + +
        +
      • +

        isRemoveVersion

        +
        public boolean isRemoveVersion()
        +
        • +
      + + + +
        +
      • +

        isRemoveScope

        +
        public boolean isRemoveScope()
        +
        • +
      + + + +
        +
      • +

        isRemoveType

        +
        public boolean isRemoveType()
        +
        • +
      + + + +
        +
      • +

        isRemoveOptional

        +
        public boolean isRemoveOptional()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomChangeDependency>
        +
        +
        • +
      + + + +
        +
      • +

        pomExecution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(java.lang.String relativePomFile,
+                                                                             org.apache.maven.model.Model model)
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File arg0,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext arg1)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangePackaging.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangePackaging.html new file mode 100644 index 00000000..415e31b8 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangePackaging.html @@ -0,0 +1,430 @@ + + + + + +PomChangePackaging (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.pom
+

Class PomChangePackaging

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class PomChangePackaging
+extends com.paypal.butterfly.extensions.api.TransformationOperation<T>
    +
    Changes the packaging of a Maven artifact, by changing its POM file.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomChangePackaging() 
      PomChangePackaging(java.lang.String packagingType) +
      Operation to change the packaging of a Maven artifact, by changing its POM file
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object obj) 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File arg0, + com.paypal.butterfly.extensions.api.TransformationContext arg1) 
      java.lang.StringgetDescription() 
      java.lang.StringgetPackagingType() 
      inthashCode() 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultpomExecution(java.lang.String relativePomFile, + org.apache.maven.model.Model model) 
      PomChangePackagingsetPackagingType(java.lang.String packagingType) 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomChangePackaging

        +
        public PomChangePackaging()
        +
        • +
      + + + +
        +
      • +

        PomChangePackaging

        +
        public PomChangePackaging(java.lang.String packagingType)
        +
        Operation to change the packaging of a Maven artifact, by changing its POM file
        +
        +
        Parameters:
        +
        packagingType - packaging type
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setPackagingType

        +
        public PomChangePackaging setPackagingType(java.lang.String packagingType)
        +
        • +
      + + + +
        +
      • +

        getPackagingType

        +
        public java.lang.String getPackagingType()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomChangePackaging>
        +
        +
        • +
      + + + +
        +
      • +

        pomExecution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(java.lang.String relativePomFile,
+                                                                             org.apache.maven.model.Model model)
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class com.paypal.butterfly.extensions.api.TransformationUtility<PomChangePackaging>
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class com.paypal.butterfly.extensions.api.TransformationUtility<PomChangePackaging>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File arg0,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext arg1)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangeParent.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangeParent.html new file mode 100644 index 00000000..75ebf9fe --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangeParent.html @@ -0,0 +1,578 @@ + + + + + +PomChangeParent (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.pom
+

Class PomChangeParent

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeParent>, java.lang.Cloneable
    +
    +
    +
    Deprecated.
    +
    +
    @Deprecated
+public class PomChangeParent
+extends com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomChangeParent>
+implements com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeParent>
    +
    This transformation utility is deprecated. + Please use PomAddParent or PomChangeParentVersion instead.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement

        +com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresent
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation

        +artifactId, groupId
        • +
      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomChangeParent() +
      Deprecated. 
      + 
      PomChangeParent(java.lang.String version) +
      Deprecated. 
      +
      Operation to change the parent, or its version, in a Maven POM file
      +
      PomChangeParent(java.lang.String groupId, + java.lang.String artifactId, + java.lang.String version) +
      Deprecated. 
      +
      Operation to change the parent, or its version, in a Maven POM file
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File arg0, + com.paypal.butterfly.extensions.api.TransformationContext arg1) 
      PomChangeParentfailIfNotPresent() +
      Deprecated. 
      + 
      java.lang.StringgetDescription() +
      Deprecated. 
      + 
      java.lang.StringgetVersion() +
      Deprecated. 
      + 
      PomChangeParentnoOpIfNotPresent() +
      Deprecated. 
      + 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultpomExecution(java.lang.String relativePomFile, + org.apache.maven.model.Model model) +
      Deprecated. 
      + 
      PomChangeParentsetArtifactId(java.lang.String artifactId) +
      Deprecated. 
      + 
      PomChangeParentsetGroupId(java.lang.String groupId) +
      Deprecated. 
      + 
      PomChangeParentsetVersion(java.lang.String version) +
      Deprecated. 
      + 
      PomChangeParentwarnIfNotPresent() +
      Deprecated. 
      + 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation

        +equals, getArtifactId, getDependency, getDependency, getGroupId, getManagedDependency, getManagedDependency, getManagedPlugin, getManagedPlugin, getPlugin, getPlugin, hashCode, setArtifact
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomChangeParent

        +
        public PomChangeParent()
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        PomChangeParent

        +
        public PomChangeParent(java.lang.String version)
        +
        Deprecated. 
        +
        Operation to change the parent, or its version, in a Maven POM file
        +
        +
        Parameters:
        +
        version - parent artifact version to be set
        +
        +
        • +
      + + + +
        +
      • +

        PomChangeParent

        +
        public PomChangeParent(java.lang.String groupId,
+                       java.lang.String artifactId,
+                       java.lang.String version)
        +
        Deprecated. 
        +
        Operation to change the parent, or its version, in a Maven POM file
        +
        +
        Parameters:
        +
        groupId - parent artifact group id to be set
        +
        artifactId - parent artifact id to be set
        +
        version - parent artifact version to be set
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setGroupId

        +
        public PomChangeParent setGroupId(java.lang.String groupId)
        +
        Deprecated. 
        +
        +
        Overrides:
        +
        setGroupId in class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomChangeParent>
        +
        +
        • +
      + + + +
        +
      • +

        setArtifactId

        +
        public PomChangeParent setArtifactId(java.lang.String artifactId)
        +
        Deprecated. 
        +
        +
        Overrides:
        +
        setArtifactId in class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomChangeParent>
        +
        +
        • +
      + + + +
        +
      • +

        setVersion

        +
        public PomChangeParent setVersion(java.lang.String version)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        failIfNotPresent

        +
        public PomChangeParent failIfNotPresent()
        +
        Deprecated. 
        +
        +
        Specified by:
        +
        failIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeParent>
        +
        +
        • +
      + + + +
        +
      • +

        warnIfNotPresent

        +
        public PomChangeParent warnIfNotPresent()
        +
        Deprecated. 
        +
        +
        Specified by:
        +
        warnIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeParent>
        +
        +
        • +
      + + + +
        +
      • +

        noOpIfNotPresent

        +
        public PomChangeParent noOpIfNotPresent()
        +
        Deprecated. 
        +
        +
        Specified by:
        +
        noOpIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeParent>
        +
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        public java.lang.String getVersion()
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        Deprecated. 
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomChangeParent>
        +
        +
        • +
      + + + +
        +
      • +

        pomExecution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(java.lang.String relativePomFile,
+                                                                             org.apache.maven.model.Model model)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File arg0,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext arg1)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangeParentVersion.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangeParentVersion.html new file mode 100644 index 00000000..72f5809c --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangeParentVersion.html @@ -0,0 +1,539 @@ + + + + + +PomChangeParentVersion (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.pom
+

Class PomChangeParentVersion

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeParentVersion>, java.lang.Cloneable
    +
    +
    +
    +
    public class PomChangeParentVersion
+extends com.paypal.butterfly.utilities.operations.pom.stax.AbstractStaxOperation<T>
+implements com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeParentVersion>
    +
    Changes the parent's version in a Maven POM file. + If the POM file does not have a parent, the operation will return an error. + That behavior can be changed though, see ChangeOrRemoveElement for further details.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement

        +com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresent
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.utilities.operations.pom.stax.AbstractStaxOperation

        +eventFactory, LINE_FEED
        • +
      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomChangeParentVersion() 
      PomChangeParentVersion(java.lang.String version) +
      Operation to change the parent, or its version, in a Maven POM file
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      PomChangeParentVersionfailIfNotPresent() 
      java.lang.StringgetDescription() 
      protected org.apache.maven.model.ModelgetModel(java.io.File pomFile) 
      java.lang.StringgetVersion() 
      PomChangeParentVersionnoOpIfNotPresent() 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultpomExecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      PomChangeParentVersionsetVersion(java.lang.String version) 
      PomChangeParentVersionwarnIfNotPresent() 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultxmlExecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.utilities.operations.pom.stax.AbstractStaxOperation

        +clone, copyUntil, getIndentation, getReader, getWriter, skipUntil, writeMultiple
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomChangeParentVersion

        +
        public PomChangeParentVersion()
        +
        • +
      + + + +
        +
      • +

        PomChangeParentVersion

        +
        public PomChangeParentVersion(java.lang.String version)
        +
        Operation to change the parent, or its version, in a Maven POM file
        +
        +
        Parameters:
        +
        version - parent artifact version to be set
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        failIfNotPresent

        +
        public PomChangeParentVersion failIfNotPresent()
        +
        +
        Specified by:
        +
        failIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeParentVersion>
        +
        +
        • +
      + + + +
        +
      • +

        warnIfNotPresent

        +
        public PomChangeParentVersion warnIfNotPresent()
        +
        +
        Specified by:
        +
        warnIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeParentVersion>
        +
        +
        • +
      + + + +
        +
      • +

        noOpIfNotPresent

        +
        public PomChangeParentVersion noOpIfNotPresent()
        +
        +
        Specified by:
        +
        noOpIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangeParentVersion>
        +
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        public java.lang.String getVersion()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomChangeParentVersion>
        +
        +
        • +
      + + + +
        +
      • +

        pomExecution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(java.io.File transformedAppFolder,
+                                                                             com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
+                                                                      throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
+                                                                             javax.xml.stream.XMLStreamException,
+                                                                             java.io.IOException
        +
        +
        Throws:
        +
        org.codehaus.plexus.util.xml.pull.XmlPullParserException
        +
        javax.xml.stream.XMLStreamException
        +
        java.io.IOException
        +
        +
        • +
      + + + +
        +
      • +

        getModel

        +
        protected org.apache.maven.model.Model getModel(java.io.File pomFile)
+                                         throws java.io.IOException,
+                                                org.codehaus.plexus.util.xml.pull.XmlPullParserException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        org.codehaus.plexus.util.xml.pull.XmlPullParserException
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Overrides:
        +
        execution in class com.paypal.butterfly.utilities.operations.pom.stax.AbstractStaxOperation<T extends com.paypal.butterfly.utilities.operations.pom.AbstractStaxPomOperation>
        +
        +
        • +
      + + + +
        +
      • +

        xmlExecution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult xmlExecution(java.io.File transformedAppFolder,
+                                                                             com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
+                                                                      throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
+                                                                             javax.xml.stream.XMLStreamException,
+                                                                             java.io.IOException
        +
        +
        Specified by:
        +
        xmlExecution in class com.paypal.butterfly.utilities.operations.pom.stax.AbstractStaxOperation<T extends com.paypal.butterfly.utilities.operations.pom.AbstractStaxPomOperation>
        +
        Throws:
        +
        org.codehaus.plexus.util.xml.pull.XmlPullParserException
        +
        javax.xml.stream.XMLStreamException
        +
        java.io.IOException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangePlugin.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangePlugin.html new file mode 100644 index 00000000..8166df88 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomChangePlugin.html @@ -0,0 +1,749 @@ + + + + + +PomChangePlugin (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.pom
+

Class PomChangePlugin

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangePlugin>, java.lang.Cloneable
    +
    +
    +
    +
    public class PomChangePlugin
+extends com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomChangePlugin>
+implements com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangePlugin>
    +
    Changes a Plugin in a Maven POM file. + It allows changing version, extensions, executions and dependencies but not group id and artifact id. + It also allows removing specific configuration, letting them + to have default values, or be managed by applicable. +
    + If the plugin to be changed doesn't actually exist, it will result + in error. The default behavior can be changed. See ChangeOrRemoveElement for further details. +
    + Important: no check will be done here for possible reasons to break + the build, like the lack of version when the plugin is not managed
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement

        +com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresent
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation

        +artifactId, groupId
        • +
      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomChangePlugin() 
      PomChangePlugin(java.lang.String groupId, + java.lang.String artifactId) +
      Operation to change a plugin in a Maven POM file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File arg0, + com.paypal.butterfly.extensions.api.TransformationContext arg1) 
      PomChangePluginfailIfNotPresent() 
      java.lang.StringgetDescription() 
      java.util.List<org.apache.maven.model.PluginExecution>getExecutions() 
      java.lang.StringgetExtensions() 
      java.util.List<org.apache.maven.model.Dependency>getPluginDependencies() 
      java.lang.StringgetVersion() 
      booleanisRemoveExecutions() 
      booleanisRemoveExtensions() 
      booleanisRemovePluginDependencies() 
      booleanisRemoveVersion() 
      PomChangePluginnoOpIfNotPresent() 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultpomExecution(java.lang.String relativePomFile, + org.apache.maven.model.Model model) 
      PomChangePluginremoveDependencies() +
      Operation to remove dependencies of the plugin.
      +
      PomChangePluginremoveExecutions() +
      Operation to remove executions of the plugin.
      +
      PomChangePluginremoveExtensions() +
      Operation to remove extensions of the plugin.
      +
      PomChangePluginremoveVersion() +
      Operation to remove version of the plugin.
      +
      PomChangePluginsetExecutions(java.util.List<org.apache.maven.model.PluginExecution> executions) +
      Operation to set the Executions that will add/update the existing plugin executions.
      +
      PomChangePluginsetExtensions(java.lang.String extensions) +
      Operation to set the extensions that will add/update the existing plugin extensions.
      +
      PomChangePluginsetPluginDependencies(java.util.List<org.apache.maven.model.Dependency> pluginDependencies) +
      Operation to set the Dependencies that will add/update the existing plugin dependencies.
      +
      PomChangePluginsetVersion(java.lang.String version) +
      Operation to set the version that will add/update the existing plugin version.
      +
      PomChangePluginwarnIfNotPresent() 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation

        +equals, getArtifactId, getDependency, getDependency, getGroupId, getManagedDependency, getManagedDependency, getManagedPlugin, getManagedPlugin, getPlugin, getPlugin, hashCode, setArtifact, setArtifactId, setGroupId
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomChangePlugin

        +
        public PomChangePlugin()
        +
        • +
      + + + +
        +
      • +

        PomChangePlugin

        +
        public PomChangePlugin(java.lang.String groupId,
+                       java.lang.String artifactId)
        +
        Operation to change a plugin in a Maven POM file. + It allows changing version, extensions, executions and dependencies but not group id and artifact id. + It also allows removing specific configuration, letting them + to have default values, or be managed by applicable. +
        + If the plugin to be changed doesn't actually exist, it will result + in error +
        + Important: no check will be done here for possible reasons to break + the build, like the lack of version when the plugin is not managed
        +
        +
        Parameters:
        +
        groupId - plugin group id
        +
        artifactId - plugin artifact id
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setVersion

        +
        public PomChangePlugin setVersion(java.lang.String version)
        +
        Operation to set the version that will add/update the existing plugin version.
        +
        +
        Parameters:
        +
        version - Version to be set in the transformed plugin
        +
        Returns:
        +
        this PomChangePlugin object
        +
        +
        • +
      + + + +
        +
      • +

        setExtensions

        +
        public PomChangePlugin setExtensions(java.lang.String extensions)
        +
        Operation to set the extensions that will add/update the existing plugin extensions.
        +
        +
        Parameters:
        +
        extensions - Extension that needs to be set in the transformed plugin
        +
        Returns:
        +
        this PomChangePlugin object
        +
        +
        • +
      + + + +
        +
      • +

        setExecutions

        +
        public PomChangePlugin setExecutions(java.util.List<org.apache.maven.model.PluginExecution> executions)
        +
        Operation to set the Executions that will add/update the existing plugin executions.
        +
        +
        Parameters:
        +
        executions - List of PluginExecution that needs to be set in the transformed plugin
        +
        Returns:
        +
        this PomChangePlugin object
        +
        +
        • +
      + + + +
        +
      • +

        setPluginDependencies

        +
        public PomChangePlugin setPluginDependencies(java.util.List<org.apache.maven.model.Dependency> pluginDependencies)
        +
        Operation to set the Dependencies that will add/update the existing plugin dependencies.
        +
        +
        Parameters:
        +
        pluginDependencies - List of Dependency that needs to be set in the transformed plugin
        +
        Returns:
        +
        this PomChangePlugin object
        +
        +
        • +
      + + + +
        +
      • +

        removeVersion

        +
        public PomChangePlugin removeVersion()
        +
        Operation to remove version of the plugin.
        +
        +
        Returns:
        +
        this PomChangePlugin object
        +
        +
        • +
      + + + +
        +
      • +

        removeExtensions

        +
        public PomChangePlugin removeExtensions()
        +
        Operation to remove extensions of the plugin.
        +
        +
        Returns:
        +
        this PomChangePlugin object
        +
        +
        • +
      + + + +
        +
      • +

        removeExecutions

        +
        public PomChangePlugin removeExecutions()
        +
        Operation to remove executions of the plugin.
        +
        +
        Returns:
        +
        this PomChangePlugin object
        +
        +
        • +
      + + + +
        +
      • +

        removeDependencies

        +
        public PomChangePlugin removeDependencies()
        +
        Operation to remove dependencies of the plugin.
        +
        +
        Returns:
        +
        this PomChangePlugin object
        +
        +
        • +
      + + + +
        +
      • +

        failIfNotPresent

        +
        public PomChangePlugin failIfNotPresent()
        +
        +
        Specified by:
        +
        failIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangePlugin>
        +
        +
        • +
      + + + +
        +
      • +

        warnIfNotPresent

        +
        public PomChangePlugin warnIfNotPresent()
        +
        +
        Specified by:
        +
        warnIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangePlugin>
        +
        +
        • +
      + + + +
        +
      • +

        noOpIfNotPresent

        +
        public PomChangePlugin noOpIfNotPresent()
        +
        +
        Specified by:
        +
        noOpIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomChangePlugin>
        +
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        public java.lang.String getVersion()
        +
        • +
      + + + +
        +
      • +

        getExtensions

        +
        public java.lang.String getExtensions()
        +
        • +
      + + + +
        +
      • +

        getExecutions

        +
        public java.util.List<org.apache.maven.model.PluginExecution> getExecutions()
        +
        • +
      + + + +
        +
      • +

        getPluginDependencies

        +
        public java.util.List<org.apache.maven.model.Dependency> getPluginDependencies()
        +
        • +
      + + + +
        +
      • +

        isRemoveVersion

        +
        public boolean isRemoveVersion()
        +
        • +
      + + + +
        +
      • +

        isRemoveExtensions

        +
        public boolean isRemoveExtensions()
        +
        • +
      + + + +
        +
      • +

        isRemoveExecutions

        +
        public boolean isRemoveExecutions()
        +
        • +
      + + + +
        +
      • +

        isRemovePluginDependencies

        +
        public boolean isRemovePluginDependencies()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomChangePlugin>
        +
        +
        • +
      + + + +
        +
      • +

        pomExecution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(java.lang.String relativePomFile,
+                                                                             org.apache.maven.model.Model model)
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File arg0,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext arg1)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomCopyDependencies.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomCopyDependencies.html new file mode 100644 index 00000000..976afa0c --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomCopyDependencies.html @@ -0,0 +1,431 @@ + + + + + +PomCopyDependencies (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.pom
+

Class PomCopyDependencies

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class PomCopyDependencies
+extends AbstractToOperation<T>
    +
    Copies dependencies from a POM file to another. + It also allows replacements plus filtering which dependencies to copy.
    +
    • +
+
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      Tfilter(java.lang.String dependency) +
      Registers a Maven dependency (in format groupId:artifactId) to be filtered out + when copying dependencies from original to POM file
      +
      TfilterAttribute(java.lang.String attributeName) +
      Registers a Maven dependency (in format groupId:artifactId) to be filtered out + when copying dependencies from original to POM file.
      +
      TfilterByGroupId(java.lang.String groupId) 
      Treplace(java.lang.String dependency, + java.lang.String replacementDependency) +
      Registers a Maven dependency (in format groupId:artifactId) to be replaced + when copying dependencies from original to POM file
      +
      + +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomCopyDependencies

        +
        public PomCopyDependencies()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        filter

        +
        public T filter(java.lang.String dependency)
        +
        Registers a Maven dependency (in format groupId:artifactId) to be filtered out + when copying dependencies from original to POM file
        +
        +
        Parameters:
        +
        dependency - a Maven dependency (in format groupId:artifactId) to be filtered out
        +
        Returns:
        +
        this transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        filterAttribute

        +
        public T filterAttribute(java.lang.String attributeName)
        +
        Registers a Maven dependency (in format groupId:artifactId) to be filtered out + when copying dependencies from original to POM file. The dependency is stored + in a transformation context attribute name and is resolved during transformation time. + If that transformation context attribute does not exist, has null value, or has an invalid + value, it will be silently ignored.
        +
        +
        Parameters:
        +
        attributeName - the name of the transformation context attribute name + that holds the Maven dependency (in format groupId:artifactId) to be filtered out
        +
        Returns:
        +
        this transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        filterByGroupId

        +
        public T filterByGroupId(java.lang.String groupId)
        +
        • +
      + + + +
        +
      • +

        replace

        +
        public T replace(java.lang.String dependency,
+                 java.lang.String replacementDependency)
        +
        Registers a Maven dependency (in format groupId:artifactId) to be replaced + when copying dependencies from original to POM file
        +
        +
        Parameters:
        +
        dependency - a Maven dependency (in format groupId:artifactId) to be replaced
        +
        replacementDependency - the replacement Maven dependency (in format groupId:artifactId)
        +
        Returns:
        +
        this transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomCopyDependencies>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomCopyManagedDependencies.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomCopyManagedDependencies.html new file mode 100644 index 00000000..7cc6babc --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomCopyManagedDependencies.html @@ -0,0 +1,431 @@ + + + + + +PomCopyManagedDependencies (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.pom
+

Class PomCopyManagedDependencies

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class PomCopyManagedDependencies
+extends AbstractToOperation<T>
    +
    Copies managed dependencies from a POM file to another. + It also allows replacements plus filtering which managed dependencies to copy.
    +
    • +
+
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      Tfilter(java.lang.String dependency) +
      Registers a Maven dependency (in format groupId:artifactId) to be filtered out + when copying dependencies from original to POM file
      +
      TfilterAttribute(java.lang.String attributeName) +
      Registers a Maven dependency (in format groupId:artifactId) to be filtered out + when copying dependencies from original to POM file.
      +
      TfilterByGroupId(java.lang.String groupId) 
      Treplace(java.lang.String dependency, + java.lang.String replacementDependency) +
      Registers a Maven dependency (in format groupId:artifactId) to be replaced + when copying dependencies from original to POM file
      +
      + +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomCopyManagedDependencies

        +
        public PomCopyManagedDependencies()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        filter

        +
        public T filter(java.lang.String dependency)
        +
        Registers a Maven dependency (in format groupId:artifactId) to be filtered out + when copying dependencies from original to POM file
        +
        +
        Parameters:
        +
        dependency - a Maven dependency (in format groupId:artifactId) to be filtered out
        +
        Returns:
        +
        this transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        filterAttribute

        +
        public T filterAttribute(java.lang.String attributeName)
        +
        Registers a Maven dependency (in format groupId:artifactId) to be filtered out + when copying dependencies from original to POM file. The dependency is stored + in a transformation context attribute name and is resolved during transformation time. + If that transformation context attribute does not exist, has null value, or has an invalid + value, it will be silently ignored.
        +
        +
        Parameters:
        +
        attributeName - the name of the transformation context attribute name + that holds the Maven dependency (in format groupId:artifactId) to be filtered out
        +
        Returns:
        +
        this transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        filterByGroupId

        +
        public T filterByGroupId(java.lang.String groupId)
        +
        • +
      + + + +
        +
      • +

        replace

        +
        public T replace(java.lang.String dependency,
+                 java.lang.String replacementDependency)
        +
        Registers a Maven dependency (in format groupId:artifactId) to be replaced + when copying dependencies from original to POM file
        +
        +
        Parameters:
        +
        dependency - a Maven dependency (in format groupId:artifactId) to be replaced
        +
        replacementDependency - the replacement Maven dependency (in format groupId:artifactId)
        +
        Returns:
        +
        this transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomCopyDependencies>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomFile.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomFile.html new file mode 100644 index 00000000..58b13888 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomFile.html @@ -0,0 +1,508 @@ + + + + + +PomFile (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.pom
+

Class PomFile

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.paypal.butterfly.extensions.api.operations.AddElement<PomFile>, java.lang.Cloneable
    +
    +
    +
    +
    public class PomFile
+extends com.paypal.butterfly.extensions.api.operations.AddElementTO<PomFile>
    +
    Creates, or overwrites, a pom.xml file given a Model object. + The Maven Model can be set as a transformation context attribute or as an object, available during definition time. + The path to the directory of the pom file is set using TransformationUtility.relative(String), TransformationUtility.absolute(String) or TransformationUtility.absolute(String, String). + If a pom file is already present, by default an error should be returned. However, that behavior can be configured, + according to AddElementTO.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface com.paypal.butterfly.extensions.api.operations.AddElement

        +com.paypal.butterfly.extensions.api.operations.AddElement.IfPresent
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.operations.AddElementTO

        +ifPresent
        • +
      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomFile() +
      Creates, or overwrites, a pom.xml file given a Model object.
      +
      PomFile(org.apache.maven.model.Model model) +
      Creates, or overwrites, a pom.xml file given a Model object.
      +
      PomFile(java.lang.String attribute) +
      Creates, or overwrites, a pom.xml file given a Model object.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetAttribute() +
      Returns the name of the transformation context attribute holding the Model object
      +
      java.lang.StringgetDescription() 
      org.apache.maven.model.ModelgetModel() +
      Returns the Model object used to write the pom.xml file
      +
      PomFilesetAttribute(java.lang.String attribute) +
      Sets the name of the transformation context attribute holding the Model object
      +
      PomFilesetModel(org.apache.maven.model.Model model) +
      Sets the Model object used to write the pom.xml file
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.operations.AddElementTO

        +failIfPresent, noOpIfPresent, overwriteIfPresent, warnButAddIfPresent, warnNotAddIfPresent
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomFile

        +
        public PomFile()
        +
        Creates, or overwrites, a pom.xml file given a Model object. + The Maven Model can be set as a transformation context attribute or as an object, available during definition time. + If a pom file is already present, by default an error should be returned. However, that behavior can be configured, + according to AddElementTO.
        +
        • +
      + + + +
        +
      • +

        PomFile

        +
        public PomFile(java.lang.String attribute)
        +
        Creates, or overwrites, a pom.xml file given a Model object. + The Maven Model can be set as a transformation context attribute or as an object, available during definition time. + If a pom file is already present, by default an error should be returned. However, that behavior can be configured, + according to AddElementTO.
        +
        +
        Parameters:
        +
        attribute - the name of the transformation context attribute holding the Model object
        +
        +
        • +
      + + + +
        +
      • +

        PomFile

        +
        public PomFile(org.apache.maven.model.Model model)
        +
        Creates, or overwrites, a pom.xml file given a Model object. + The Maven Model can be set as a transformation context attribute or as an object, available during definition time. + If a pom file is already present, by default an error should be returned. However, that behavior can be configured, + according to AddElementTO.
        +
        +
        Parameters:
        +
        model - the Model object used to write the pom.xml file
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setAttribute

        +
        public PomFile setAttribute(java.lang.String attribute)
        +
        Sets the name of the transformation context attribute holding the Model object
        +
        +
        Parameters:
        +
        attribute - the name of the transformation context attribute holding the Model object
        +
        Returns:
        +
        this transformation operation
        +
        +
        • +
      + + + +
        +
      • +

        setModel

        +
        public PomFile setModel(org.apache.maven.model.Model model)
        +
        Sets the Model object used to write the pom.xml file
        +
        +
        Parameters:
        +
        model - the Model object used to write the pom.xml file
        +
        Returns:
        +
        this transformation operation
        +
        +
        • +
      + + + +
        +
      • +

        getAttribute

        +
        public java.lang.String getAttribute()
        +
        Returns the name of the transformation context attribute holding the Model object
        +
        +
        Returns:
        +
        the name of the transformation context attribute holding the Model object
        +
        +
        • +
      + + + +
        +
      • +

        getModel

        +
        public org.apache.maven.model.Model getModel()
        +
        Returns the Model object used to write the pom.xml file
        +
        +
        Returns:
        +
        the Model object used to write the pom.xml file
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomFile>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<PomFile>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveDependency.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveDependency.html new file mode 100644 index 00000000..e316f1c3 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveDependency.html @@ -0,0 +1,495 @@ + + + + + +PomRemoveDependency (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.pom
+

Class PomRemoveDependency

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveDependency>, java.lang.Cloneable
    +
    +
    +
    +
    public class PomRemoveDependency
+extends com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomRemoveDependency>
+implements com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveDependency>
    +
    Removes a dependency entry from a POM file. + If the POM file does not have the specified dependency, the operation will return an error. + That behavior can be changed though, see ChangeOrRemoveElement for further details.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement

        +com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresent
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation

        +artifactId, groupId
        • +
      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomRemoveDependency() 
      PomRemoveDependency(java.lang.String groupId, + java.lang.String artifactId) +
      Operation to remove a dependency entry from a POM file
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object obj) 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File arg0, + com.paypal.butterfly.extensions.api.TransformationContext arg1) 
      PomRemoveDependencyfailIfNotPresent() 
      java.lang.StringgetDescription() 
      inthashCode() 
      PomRemoveDependencynoOpIfNotPresent() 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultpomExecution(java.lang.String relativePomFile, + org.apache.maven.model.Model model) 
      PomRemoveDependencywarnIfNotPresent() 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation

        +getArtifactId, getDependency, getDependency, getGroupId, getManagedDependency, getManagedDependency, getManagedPlugin, getManagedPlugin, getPlugin, getPlugin, setArtifact, setArtifactId, setGroupId
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomRemoveDependency

        +
        public PomRemoveDependency()
        +
        • +
      + + + +
        +
      • +

        PomRemoveDependency

        +
        public PomRemoveDependency(java.lang.String groupId,
+                           java.lang.String artifactId)
        +
        Operation to remove a dependency entry from a POM file
        +
        +
        Parameters:
        +
        groupId - dependency to be removed group id
        +
        artifactId - dependency to be removed artifact id
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        failIfNotPresent

        +
        public PomRemoveDependency failIfNotPresent()
        +
        +
        Specified by:
        +
        failIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveDependency>
        +
        +
        • +
      + + + +
        +
      • +

        warnIfNotPresent

        +
        public PomRemoveDependency warnIfNotPresent()
        +
        +
        Specified by:
        +
        warnIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveDependency>
        +
        +
        • +
      + + + +
        +
      • +

        noOpIfNotPresent

        +
        public PomRemoveDependency noOpIfNotPresent()
        +
        +
        Specified by:
        +
        noOpIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveDependency>
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomRemoveDependency>
        +
        +
        • +
      + + + +
        +
      • +

        pomExecution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(java.lang.String relativePomFile,
+                                                                             org.apache.maven.model.Model model)
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomRemoveDependency>
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomRemoveDependency>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File arg0,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext arg1)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveDependencyExclusion.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveDependencyExclusion.html new file mode 100644 index 00000000..6d2f8559 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveDependencyExclusion.html @@ -0,0 +1,493 @@ + + + + + +PomRemoveDependencyExclusion (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.pom
+

Class PomRemoveDependencyExclusion

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveDependencyExclusion>, java.lang.Cloneable
    +
    +
    +
    +
    public class PomRemoveDependencyExclusion
+extends com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomRemoveDependencyExclusion>
+implements com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveDependencyExclusion>
    +
    Removes an exclusion from a dependency in a POM file. + If the POM file does not have the specified dependency, the operation will return an error. + That behavior can be changed though, see ChangeOrRemoveElement for further details.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement

        +com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresent
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation

        +artifactId, groupId
        • +
      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomRemoveDependencyExclusion() 
      PomRemoveDependencyExclusion(java.lang.String groupId, + java.lang.String artifactId, + java.lang.String exclusionGroupId, + java.lang.String exclusionArtifactId) +
      Operation to remove an exclusion from a dependency in a POM file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File arg0, + com.paypal.butterfly.extensions.api.TransformationContext arg1) 
      PomRemoveDependencyExclusionfailIfNotPresent() 
      java.lang.StringgetDescription() 
      PomRemoveDependencyExclusionnoOpIfNotPresent() 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultpomExecution(java.lang.String relativePomFile, + org.apache.maven.model.Model model) 
      PomRemoveDependencyExclusionsetExclusionArtifactId(java.lang.String exclusionArtifactId) 
      PomRemoveDependencyExclusionsetExclusionGroupId(java.lang.String exclusionGroupId) 
      PomRemoveDependencyExclusionwarnIfNotPresent() 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation

        +equals, getArtifactId, getDependency, getDependency, getGroupId, getManagedDependency, getManagedDependency, getManagedPlugin, getManagedPlugin, getPlugin, getPlugin, hashCode, setArtifact, setArtifactId, setGroupId
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomRemoveDependencyExclusion

        +
        public PomRemoveDependencyExclusion()
        +
        • +
      + + + +
        +
      • +

        PomRemoveDependencyExclusion

        +
        public PomRemoveDependencyExclusion(java.lang.String groupId,
+                                    java.lang.String artifactId,
+                                    java.lang.String exclusionGroupId,
+                                    java.lang.String exclusionArtifactId)
        +
        Operation to remove an exclusion from a dependency in a POM file.
        +
        +
        Parameters:
        +
        groupId - group id of the dependency to be modified
        +
        artifactId - artifact id of the dependency to be modified
        +
        exclusionGroupId - group id of the exclusion to be removed
        +
        exclusionArtifactId - artifact id of the exclusion to be removed
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomRemoveDependencyExclusion>
        +
        +
        • +
      + + + +
        +
      • +

        pomExecution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(java.lang.String relativePomFile,
+                                                                             org.apache.maven.model.Model model)
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File arg0,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext arg1)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveManagedDependency.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveManagedDependency.html new file mode 100644 index 00000000..a6eaaef4 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveManagedDependency.html @@ -0,0 +1,461 @@ + + + + + +PomRemoveManagedDependency (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.pom
+

Class PomRemoveManagedDependency

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveManagedDependency>, java.lang.Cloneable
    +
    +
    +
    +
    public class PomRemoveManagedDependency
+extends com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomRemoveManagedDependency>
+implements com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveManagedDependency>
    +
    Removes a managed dependency entry from a POM file. + If the POM file does not have the specified managed dependency, the operation will return an error. + That behavior can be changed though, see ChangeOrRemoveElement for further details.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement

        +com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresent
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation

        +artifactId, groupId
        • +
      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File arg0, + com.paypal.butterfly.extensions.api.TransformationContext arg1) 
      PomRemoveManagedDependencyfailIfNotPresent() 
      java.lang.StringgetDescription() 
      PomRemoveManagedDependencynoOpIfNotPresent() 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultpomExecution(java.lang.String relativePomFile, + org.apache.maven.model.Model model) 
      PomRemoveManagedDependencywarnIfNotPresent() 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation

        +equals, getArtifactId, getDependency, getDependency, getGroupId, getManagedDependency, getManagedDependency, getManagedPlugin, getManagedPlugin, getPlugin, getPlugin, hashCode, setArtifact, setArtifactId, setGroupId
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomRemoveManagedDependency

        +
        public PomRemoveManagedDependency()
        +
        • +
      + + + +
        +
      • +

        PomRemoveManagedDependency

        +
        public PomRemoveManagedDependency(java.lang.String groupId,
+                                  java.lang.String artifactId)
        +
        Operation to remove a managed dependency entry from a POM file
        +
        +
        Parameters:
        +
        groupId - managed dependency to be removed group id
        +
        artifactId - managed dependency to be removed artifact id
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + + + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomRemoveManagedDependency>
        +
        +
        • +
      + + + +
        +
      • +

        pomExecution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(java.lang.String relativePomFile,
+                                                                             org.apache.maven.model.Model model)
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File arg0,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext arg1)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveModule.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveModule.html new file mode 100644 index 00000000..83fdb589 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveModule.html @@ -0,0 +1,472 @@ + + + + + +PomRemoveModule (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.pom
+

Class PomRemoveModule

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveModule>, java.lang.Cloneable
    +
    +
    +
    +
    public class PomRemoveModule
+extends com.paypal.butterfly.extensions.api.TransformationOperation<T>
+implements com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveModule>
    +
    Removes a module entry from a POM file. + If the POM file does not have the specified module, the operation will return an error. + That behavior can be changed though, see ChangeOrRemoveElement for further details.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement

        +com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresent
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomRemoveModule() +
      Removes a module entry from a POM file.
      +
      PomRemoveModule(java.lang.String moduleName) +
      Removes a module entry from a POM file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File arg0, + com.paypal.butterfly.extensions.api.TransformationContext arg1) 
      PomRemoveModulefailIfNotPresent() 
      java.lang.StringgetDescription() 
      java.lang.StringgetModuleName() 
      PomRemoveModulenoOpIfNotPresent() 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultpomExecution(java.lang.String relativePomFile, + org.apache.maven.model.Model model) 
      PomRemoveModulesetModuleName(java.lang.String moduleName) 
      PomRemoveModulewarnIfNotPresent() 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomRemoveModule

        +
        public PomRemoveModule()
        +
        Removes a module entry from a POM file. + If the POM file does not have the specified module, the operation will return an error. + That behavior can be changed though, see ChangeOrRemoveElement for further details.
        +
        • +
      + + + +
        +
      • +

        PomRemoveModule

        +
        public PomRemoveModule(java.lang.String moduleName)
        +
        Removes a module entry from a POM file. + If the POM file does not have the specified module, the operation will return an error. + That behavior can be changed though, see ChangeOrRemoveElement for further details.
        +
        +
        Parameters:
        +
        moduleName - module to be removed
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setModuleName

        +
        public PomRemoveModule setModuleName(java.lang.String moduleName)
        +
        • +
      + + + +
        +
      • +

        failIfNotPresent

        +
        public PomRemoveModule failIfNotPresent()
        +
        +
        Specified by:
        +
        failIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveModule>
        +
        +
        • +
      + + + +
        +
      • +

        warnIfNotPresent

        +
        public PomRemoveModule warnIfNotPresent()
        +
        +
        Specified by:
        +
        warnIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveModule>
        +
        +
        • +
      + + + +
        +
      • +

        noOpIfNotPresent

        +
        public PomRemoveModule noOpIfNotPresent()
        +
        +
        Specified by:
        +
        noOpIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveModule>
        +
        +
        • +
      + + + +
        +
      • +

        getModuleName

        +
        public java.lang.String getModuleName()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomRemoveModule>
        +
        +
        • +
      + + + +
        +
      • +

        pomExecution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(java.lang.String relativePomFile,
+                                                                             org.apache.maven.model.Model model)
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File arg0,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext arg1)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemovePlugin.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemovePlugin.html new file mode 100644 index 00000000..c3476639 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemovePlugin.html @@ -0,0 +1,495 @@ + + + + + +PomRemovePlugin (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.pom
+

Class PomRemovePlugin

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemovePlugin>, java.lang.Cloneable
    +
    +
    +
    +
    public class PomRemovePlugin
+extends com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomRemovePlugin>
+implements com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemovePlugin>
    +
    Removes a plugin entry from a POM file. + If the POM file does not have the specified plugin, the operation will return an error. + That behavior can be changed though, see ChangeOrRemoveElement for further details.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement

        +com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresent
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation

        +artifactId, groupId
        • +
      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomRemovePlugin() 
      PomRemovePlugin(java.lang.String groupId, + java.lang.String artifactId) +
      Operation to remove a plugin entry from a POM file
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object obj) 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File arg0, + com.paypal.butterfly.extensions.api.TransformationContext arg1) 
      PomRemovePluginfailIfNotPresent() 
      java.lang.StringgetDescription() 
      inthashCode() 
      PomRemovePluginnoOpIfNotPresent() 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultpomExecution(java.lang.String relativePomFile, + org.apache.maven.model.Model model) 
      PomRemovePluginwarnIfNotPresent() 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation

        +getArtifactId, getDependency, getDependency, getGroupId, getManagedDependency, getManagedDependency, getManagedPlugin, getManagedPlugin, getPlugin, getPlugin, setArtifact, setArtifactId, setGroupId
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomRemovePlugin

        +
        public PomRemovePlugin()
        +
        • +
      + + + +
        +
      • +

        PomRemovePlugin

        +
        public PomRemovePlugin(java.lang.String groupId,
+                       java.lang.String artifactId)
        +
        Operation to remove a plugin entry from a POM file
        +
        +
        Parameters:
        +
        groupId - plugin to be removed group id
        +
        artifactId - plugin to be removed artifact id
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        failIfNotPresent

        +
        public PomRemovePlugin failIfNotPresent()
        +
        +
        Specified by:
        +
        failIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemovePlugin>
        +
        +
        • +
      + + + +
        +
      • +

        warnIfNotPresent

        +
        public PomRemovePlugin warnIfNotPresent()
        +
        +
        Specified by:
        +
        warnIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemovePlugin>
        +
        +
        • +
      + + + +
        +
      • +

        noOpIfNotPresent

        +
        public PomRemovePlugin noOpIfNotPresent()
        +
        +
        Specified by:
        +
        noOpIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemovePlugin>
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomRemovePlugin>
        +
        +
        • +
      + + + +
        +
      • +

        pomExecution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(java.lang.String relativePomFile,
+                                                                             org.apache.maven.model.Model model)
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomRemovePlugin>
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomRemovePlugin>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File arg0,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext arg1)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveProperty.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveProperty.html new file mode 100644 index 00000000..843047e9 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomRemoveProperty.html @@ -0,0 +1,465 @@ + + + + + +PomRemoveProperty (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.pom
+

Class PomRemoveProperty

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveProperty>, java.lang.Cloneable
    +
    +
    +
    +
    public class PomRemoveProperty
+extends com.paypal.butterfly.extensions.api.TransformationOperation<T>
+implements com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveProperty>
    +
    Removes a property entry from a POM file. + If the POM file does not have the specified property, the operation will return an error. + That behavior can be changed though, see ChangeOrRemoveElement for further details.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement

        +com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresent
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomRemoveProperty() 
      PomRemoveProperty(java.lang.String propertyName) +
      Operation to remove a property entry from a properties file
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File arg0, + com.paypal.butterfly.extensions.api.TransformationContext arg1) 
      PomRemovePropertyfailIfNotPresent() 
      java.lang.StringgetDescription() 
      java.lang.StringgetPropertyName() 
      PomRemovePropertynoOpIfNotPresent() 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultpomExecution(java.lang.String relativePomFile, + org.apache.maven.model.Model model) 
      PomRemovePropertysetPropertyName(java.lang.String propertyName) 
      PomRemovePropertywarnIfNotPresent() 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomRemoveProperty

        +
        public PomRemoveProperty()
        +
        • +
      + + + +
        +
      • +

        PomRemoveProperty

        +
        public PomRemoveProperty(java.lang.String propertyName)
        +
        Operation to remove a property entry from a properties file
        +
        +
        Parameters:
        +
        propertyName - property to be removed
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setPropertyName

        +
        public PomRemoveProperty setPropertyName(java.lang.String propertyName)
        +
        • +
      + + + +
        +
      • +

        failIfNotPresent

        +
        public PomRemoveProperty failIfNotPresent()
        +
        +
        Specified by:
        +
        failIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveProperty>
        +
        +
        • +
      + + + +
        +
      • +

        warnIfNotPresent

        +
        public PomRemoveProperty warnIfNotPresent()
        +
        +
        Specified by:
        +
        warnIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveProperty>
        +
        +
        • +
      + + + +
        +
      • +

        noOpIfNotPresent

        +
        public PomRemoveProperty noOpIfNotPresent()
        +
        +
        Specified by:
        +
        noOpIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomRemoveProperty>
        +
        +
        • +
      + + + +
        +
      • +

        getPropertyName

        +
        public java.lang.String getPropertyName()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomRemoveProperty>
        +
        +
        • +
      + + + +
        +
      • +

        pomExecution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(java.lang.String relativePomFile,
+                                                                             org.apache.maven.model.Model model)
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File arg0,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext arg1)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomReplaceDependency.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomReplaceDependency.html new file mode 100644 index 00000000..fcba88b2 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/PomReplaceDependency.html @@ -0,0 +1,638 @@ + + + + + +PomReplaceDependency (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.pom
+

Class PomReplaceDependency

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomReplaceDependency>, java.lang.Cloneable
    +
    +
    +
    +
    public class PomReplaceDependency
+extends com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation<PomReplaceDependency>
+implements com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomReplaceDependency>
    +
    Replaces a dependency by another one in a POM file. + If no new scope is defined, the scope set in the replacement dependency + will be the same used in the dependency to be replaced. + If the POM file does not have the specified dependency to be replaced, the operation will return an error. + That behavior can be changed though, see ChangeOrRemoveElement for further details.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement

        +com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresent
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation

        +artifactId, groupId
        • +
      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomReplaceDependency() 
      PomReplaceDependency(java.lang.String groupId, + java.lang.String artifactId, + java.lang.String newGroupId, + java.lang.String newArtifactId) +
      Operation to replace a dependency by another one in a POM file
      +
      PomReplaceDependency(java.lang.String groupId, + java.lang.String artifactId, + java.lang.String newGroupId, + java.lang.String newArtifactId, + java.lang.String newVersion) +
      Operation to replace a dependency by another one in a POM file
      +
      PomReplaceDependency(java.lang.String groupId, + java.lang.String artifactId, + java.lang.String newGroupId, + java.lang.String newArtifactId, + java.lang.String newVersion, + java.lang.String newScope) +
      Operation to replace a dependency by another one in a POM file
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File arg0, + com.paypal.butterfly.extensions.api.TransformationContext arg1) 
      PomReplaceDependencyfailIfNotPresent() 
      java.lang.StringgetDescription() 
      java.lang.StringgetNewArtifactId() 
      java.lang.StringgetNewGroupId() 
      java.lang.StringgetNewScope() 
      java.lang.StringgetNewVersion() 
      PomReplaceDependencynoOpIfNotPresent() 
      protected com.paypal.butterfly.extensions.api.TOExecutionResultpomExecution(java.lang.String relativePomFile, + org.apache.maven.model.Model model) 
      PomReplaceDependencysetNewArtifactId(java.lang.String newArtifactId) 
      PomReplaceDependencysetNewGroupId(java.lang.String newGroupId) 
      PomReplaceDependencysetNewScope(java.lang.String newScope) 
      PomReplaceDependencysetNewVersion(java.lang.String newVersion) 
      PomReplaceDependencywarnIfNotPresent() 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.utilities.operations.pom.AbstractArtifactPomOperation

        +equals, getArtifactId, getDependency, getDependency, getGroupId, getManagedDependency, getManagedDependency, getManagedPlugin, getManagedPlugin, getPlugin, getPlugin, hashCode, setArtifact, setArtifactId, setGroupId
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomReplaceDependency

        +
        public PomReplaceDependency()
        +
        • +
      + + + +
        +
      • +

        PomReplaceDependency

        +
        public PomReplaceDependency(java.lang.String groupId,
+                            java.lang.String artifactId,
+                            java.lang.String newGroupId,
+                            java.lang.String newArtifactId)
        +
        Operation to replace a dependency by another one in a POM file
        +
        +
        Parameters:
        +
        groupId - group id of the dependency to be replaced
        +
        artifactId - artifact id of the dependency to be replaced
        +
        newGroupId - group id of the new dependency
        +
        newArtifactId - artifact id of the new dependency
        +
        +
        • +
      + + + +
        +
      • +

        PomReplaceDependency

        +
        public PomReplaceDependency(java.lang.String groupId,
+                            java.lang.String artifactId,
+                            java.lang.String newGroupId,
+                            java.lang.String newArtifactId,
+                            java.lang.String newVersion)
        +
        Operation to replace a dependency by another one in a POM file
        +
        +
        Parameters:
        +
        groupId - group id of the dependency to be replaced
        +
        artifactId - artifact id of the dependency to be replaced
        +
        newGroupId - group id of the new dependency
        +
        newArtifactId - artifact id of the new dependency
        +
        newVersion - version of the new dependency
        +
        +
        • +
      + + + +
        +
      • +

        PomReplaceDependency

        +
        public PomReplaceDependency(java.lang.String groupId,
+                            java.lang.String artifactId,
+                            java.lang.String newGroupId,
+                            java.lang.String newArtifactId,
+                            java.lang.String newVersion,
+                            java.lang.String newScope)
        +
        Operation to replace a dependency by another one in a POM file
        +
        +
        Parameters:
        +
        groupId - group id of the dependency to be replaced
        +
        artifactId - artifact id of the dependency to be replaced
        +
        newGroupId - group id of the new dependency
        +
        newArtifactId - artifact id of the new dependency
        +
        newVersion - version of the new dependency
        +
        newScope - version of the new dependency
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        setNewArtifactId

        +
        public PomReplaceDependency setNewArtifactId(java.lang.String newArtifactId)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        failIfNotPresent

        +
        public PomReplaceDependency failIfNotPresent()
        +
        +
        Specified by:
        +
        failIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomReplaceDependency>
        +
        +
        • +
      + + + +
        +
      • +

        warnIfNotPresent

        +
        public PomReplaceDependency warnIfNotPresent()
        +
        +
        Specified by:
        +
        warnIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomReplaceDependency>
        +
        +
        • +
      + + + +
        +
      • +

        noOpIfNotPresent

        +
        public PomReplaceDependency noOpIfNotPresent()
        +
        +
        Specified by:
        +
        noOpIfNotPresent in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement<PomReplaceDependency>
        +
        +
        • +
      + + + +
        +
      • +

        getNewGroupId

        +
        public java.lang.String getNewGroupId()
        +
        • +
      + + + +
        +
      • +

        getNewArtifactId

        +
        public java.lang.String getNewArtifactId()
        +
        • +
      + + + +
        +
      • +

        getNewVersion

        +
        public java.lang.String getNewVersion()
        +
        • +
      + + + +
        +
      • +

        getNewScope

        +
        public java.lang.String getNewScope()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomReplaceDependency>
        +
        +
        • +
      + + + +
        +
      • +

        pomExecution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult pomExecution(java.lang.String relativePomFile,
+                                                                             org.apache.maven.model.Model model)
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File arg0,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext arg1)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends com.paypal.butterfly.utilities.operations.pom.AbstractPomOperation>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/package-frame.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/package-frame.html new file mode 100644 index 00000000..66d9f448 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/package-frame.html @@ -0,0 +1,41 @@ + + + + + +com.paypal.butterfly.utilities.operations.pom (butterfly-utilities 3.2.1 API) + + + + + +

com.paypal.butterfly.utilities.operations.pom

+
+

Classes

+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/package-summary.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/package-summary.html new file mode 100644 index 00000000..40d97052 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/package-summary.html @@ -0,0 +1,279 @@ + + + + + +com.paypal.butterfly.utilities.operations.pom (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.paypal.butterfly.utilities.operations.pom

+
+
Transformation operations to manipulate Maven POM files.
+
+

See: Description

+
+
+ + + + +

Package com.paypal.butterfly.utilities.operations.pom Description

+
Transformation operations to manipulate Maven POM files.
+
+
Since:
+
1.0.0
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/package-tree.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/package-tree.html new file mode 100644 index 00000000..7a328ab1 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/pom/package-tree.html @@ -0,0 +1,183 @@ + + + + + +com.paypal.butterfly.utilities.operations.pom Class Hierarchy (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.paypal.butterfly.utilities.operations.pom

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/AddProperty.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/AddProperty.html new file mode 100644 index 00000000..f7c5ab49 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/AddProperty.html @@ -0,0 +1,412 @@ + + + + + +AddProperty (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.properties
+

Class AddProperty

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class AddProperty
+extends com.paypal.butterfly.extensions.api.TransformationOperation<AddProperty>
    +
    Adds a new property to a properties file. + If the property already exists, its value is overwritten.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      AddProperty() 
      AddProperty(java.lang.String propertyName, + java.lang.String propertyValue) +
      Operation to add a new property to a properties file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      java.lang.StringgetPropertyName() 
      java.lang.StringgetPropertyValue() 
      AddPropertysetPropertyName(java.lang.String propertyName) 
      AddPropertysetPropertyValue(java.lang.String propertyValue) 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AddProperty

        +
        public AddProperty()
        +
        • +
      + + + +
        +
      • +

        AddProperty

        +
        public AddProperty(java.lang.String propertyName,
+                   java.lang.String propertyValue)
        +
        Operation to add a new property to a properties file. + If the property already exists, its value is overwritten.
        +
        +
        Parameters:
        +
        propertyName - name to the property to be added
        +
        propertyValue - value to be set to the new property
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setPropertyName

        +
        public AddProperty setPropertyName(java.lang.String propertyName)
        +
        • +
      + + + +
        +
      • +

        setPropertyValue

        +
        public AddProperty setPropertyValue(java.lang.String propertyValue)
        +
        • +
      + + + +
        +
      • +

        getPropertyName

        +
        public java.lang.String getPropertyName()
        +
        • +
      + + + +
        +
      • +

        getPropertyValue

        +
        public java.lang.String getPropertyValue()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<AddProperty>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<AddProperty>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/RemoveProperty.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/RemoveProperty.html new file mode 100644 index 00000000..5a2ae4cb --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/RemoveProperty.html @@ -0,0 +1,387 @@ + + + + + +RemoveProperty (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.properties
+

Class RemoveProperty

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class RemoveProperty
+extends com.paypal.butterfly.extensions.api.TransformationOperation<RemoveProperty>
    +
    Removes a property from a properties file. + If the specified property is not present, a warning is produced.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      RemoveProperty() +
      Operation to remove a property from a properties file.
      +
      RemoveProperty(java.lang.String propertyName) +
      Operation to remove a property from a properties file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      java.lang.StringgetPropertyName() 
      RemovePropertysetPropertyName(java.lang.String propertyName) 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RemoveProperty

        +
        public RemoveProperty()
        +
        Operation to remove a property from a properties file. + If the specified property is not present, a warning is produced.
        +
        • +
      + + + +
        +
      • +

        RemoveProperty

        +
        public RemoveProperty(java.lang.String propertyName)
        +
        Operation to remove a property from a properties file. + If the specified property is not present, a warning is produced.
        +
        +
        Parameters:
        +
        propertyName - name to the property to be removed
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setPropertyName

        +
        public RemoveProperty setPropertyName(java.lang.String propertyName)
        +
        • +
      + + + +
        +
      • +

        getPropertyName

        +
        public java.lang.String getPropertyName()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<RemoveProperty>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<RemoveProperty>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/package-frame.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/package-frame.html new file mode 100644 index 00000000..93a9387b --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/package-frame.html @@ -0,0 +1,21 @@ + + + + + +com.paypal.butterfly.utilities.operations.properties (butterfly-utilities 3.2.1 API) + + + + + +

com.paypal.butterfly.utilities.operations.properties

+
+

Classes

+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/package-summary.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/package-summary.html new file mode 100644 index 00000000..9fce4d5d --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/package-summary.html @@ -0,0 +1,161 @@ + + + + + +com.paypal.butterfly.utilities.operations.properties (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.paypal.butterfly.utilities.operations.properties

+
+
Transformation operations to manipulate properties files.
+
+

See: Description

+
+
+ + + + +

Package com.paypal.butterfly.utilities.operations.properties Description

+
Transformation operations to manipulate properties files.
+
+
Since:
+
1.0.0
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/package-tree.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/package-tree.html new file mode 100644 index 00000000..30b717ba --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/properties/package-tree.html @@ -0,0 +1,144 @@ + + + + + +com.paypal.butterfly.utilities.operations.properties Class Hierarchy (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.paypal.butterfly.utilities.operations.properties

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/AddLine.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/AddLine.html new file mode 100644 index 00000000..fc1bfc88 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/AddLine.html @@ -0,0 +1,392 @@ + + + + + +AddLine (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.text
+

Class AddLine

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class AddLine
+extends com.paypal.butterfly.extensions.api.TransformationOperation<AddLine>
    +
    Adds a new line to the end of a file.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      AddLine() 
      AddLine(java.lang.String newLine) +
      Operation to add a new line to the end of a file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      java.lang.StringgetNewLine() 
      AddLinesetNewLine(java.lang.String newLine) +
      Sets the new line to be inserted.
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AddLine

        +
        public AddLine()
        +
        • +
      + + + +
        +
      • +

        AddLine

        +
        public AddLine(java.lang.String newLine)
        +
        Operation to add a new line to the end of a file. To add a new blank line, + just set newLine to an empty string ""
        +
        +
        Parameters:
        +
        newLine - the new line to be added
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setNewLine

        +
        public AddLine setNewLine(java.lang.String newLine)
        +
        Sets the new line to be inserted. To add a new blank line, + just set newLine to an empty string ""
        +
        +
        Parameters:
        +
        newLine - the new line to be inserted
        +
        Returns:
        +
        this transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        getNewLine

        +
        public java.lang.String getNewLine()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<AddLine>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<AddLine>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertLine.InsertionMode.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertLine.InsertionMode.html new file mode 100644 index 00000000..666e9906 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertLine.InsertionMode.html @@ -0,0 +1,400 @@ + + + + + +InsertLine.InsertionMode (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.text
+

Enum InsertLine.InsertionMode

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<InsertLine.InsertionMode>
    +
    +
    +
    Enclosing class:
    +
    InsertLine
    +
    +
    +
    +
    public static enum InsertLine.InsertionMode
+extends java.lang.Enum<InsertLine.InsertionMode>
    +
    The new line(s) can be inserted: +
      +
    1. InsertionMode.CONCAT: At the final of the file (default)
      2. +
    2. InsertionMode.LINE_NUMBER: At one particular specified line number (first line is number 1). If the specified number is greater than the number of lines, then a TOExecutionResult.Type.NO_OP will be returned
      3. +
    3. InsertionMode.REGEX_FIRST: Right after only the first line to match the specified regular expression
      4. +
    4. InsertionMode.REGEX_ALL: Right after any line to match the specified regular expression
      5. +
    5. InsertionMode.REGEX_BEFORE_FIRST: Right before only the first line to match the specified regular expression
      6. +
    6. InsertionMode.REGEX_BEFORE_ALL: Right before any line to match the specified regular expression
      7. +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static InsertLine.InsertionModevalueOf(java.lang.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.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static InsertLine.InsertionMode[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (InsertLine.InsertionMode c : InsertLine.InsertionMode.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static InsertLine.InsertionMode valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertLine.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertLine.html new file mode 100644 index 00000000..e8108bcc --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertLine.html @@ -0,0 +1,574 @@ + + + + + +InsertLine (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.text
+

Class InsertLine

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class InsertLine
+extends com.paypal.butterfly.extensions.api.TransformationOperation<InsertLine>
    +
    Inserts new line(s) into a text file. + The new line can be inserted: +
      +
    1. InsertionMode.CONCAT: At the final of the file (default)
      2. +
    2. InsertionMode.LINE_NUMBER: At one particular specified line number (first line is number 1). If the specified number is greater than the number of lines, then a TOExecutionResult.Type.NO_OP will be returned
      3. +
    3. InsertionMode.REGEX_FIRST: Right after only the first line to match the specified regular expression
      4. +
    4. InsertionMode.REGEX_ALL: Right after any line to match the specified regular expression
      5. +
    5. InsertionMode.REGEX_BEFORE_FIRST: Right before only the first line to match the specified regular expression
      6. +
    6. InsertionMode.REGEX_BEFORE_ALL: Right before any line to match the specified regular expression
      7. +
    + See setInsertionMode(InsertionMode).
    +
    +
    See Also:
    +
    InsertLine.InsertionMode
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass 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).
      +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      InsertLine() +
      Operation to insert new line(s) into a text file.
      +
      InsertLine(java.lang.String newLine) +
      Operation to insert a new line into a text file.
      +
      InsertLine(java.lang.String newLine, + java.lang.Integer lineNumber) +
      Operation to insert a new line into a text file.
      +
      InsertLine(java.lang.String newLine, + java.lang.String regex) +
      Operation to insert a new line into a text file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      InsertLinesetInsertionMode(InsertLine.InsertionMode insertionMode) +
      Sets the insertion mode
      +
      InsertLinesetLineNumber(java.lang.Integer lineNumber) +
      Sets the line number the new line should be added at.
      +
      InsertLinesetNewLine(java.lang.String newLine) +
      Sets the new line to be inserted.
      +
      InsertLinesetRegex(java.lang.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.
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        InsertLine

        +
        public InsertLine()
        +
        Operation to insert new line(s) into a text file. + The new line can be inserted: +
          +
        1. InsertionMode.CONCAT: At the final of the file (default)
          2. +
        2. InsertionMode.LINE_NUMBER: At one particular specified line number (first line is number 1). If the specified number is greater than the number of lines, then a TOExecutionResult.Type.NO_OP will be returned
          3. +
        3. InsertionMode.REGEX_FIRST: Right after only the first line to match the specified regular expression
          4. +
        4. InsertionMode.REGEX_ALL: Right after any line to match the specified regular expression
          5. +
        5. InsertionMode.REGEX_BEFORE_FIRST: Right before only the first line to match the specified regular expression
          6. +
        6. InsertionMode.REGEX_BEFORE_ALL: Right before any line to match the specified regular expression
          7. +
        + See setInsertionMode(InsertionMode).
        +
        +
        See Also:
        +
        InsertLine.InsertionMode
        +
        +
        • +
      + + + +
        +
      • +

        InsertLine

        +
        public InsertLine(java.lang.String newLine)
        +
        Operation to insert a new line into a text file. + The new line will be inserted at the end of the file, + unless another insertion method is specified + + See setInsertionMode(InsertionMode).
        +
        +
        Parameters:
        +
        newLine - the new line to be inserted
        +
        +
        • +
      + + + +
        +
      • +

        InsertLine

        +
        public InsertLine(java.lang.String newLine,
+                  java.lang.Integer lineNumber)
        +
        Operation to insert a new line into a text file. + The new line will be inserted at the specified line number +
        + Notice that the insertion mode is automatically set to + InsertLine.InsertionMode.LINE_NUMBER
        +
        +
        Parameters:
        +
        newLine - the new line to be inserted
        +
        lineNumber - the line number where the new line will be inserted
        +
        +
        • +
      + + + +
        +
      • +

        InsertLine

        +
        public InsertLine(java.lang.String newLine,
+                  java.lang.String regex)
        +
        Operation to insert a new line into a text file. + The new line will be inserted right after only the first + line to match the specified regular expression +
        + Notice that the insertion mode is automatically set to + InsertLine.InsertionMode.REGEX_FIRST
        +
        +
        Parameters:
        +
        newLine - the new line to be inserted
        +
        regex - the regular expression used to determine where + the new line should be inserted
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setInsertionMode

        +
        public InsertLine setInsertionMode(InsertLine.InsertionMode insertionMode)
        +
        Sets the insertion mode
        +
        +
        Parameters:
        +
        insertionMode - the insertion mode
        +
        Returns:
        +
        this transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        setNewLine

        +
        public InsertLine setNewLine(java.lang.String newLine)
        +
        Sets the new line to be inserted. To insert a new blank line, + just set newLine to an empty string ""
        +
        +
        Parameters:
        +
        newLine - the new line to be inserted
        +
        Returns:
        +
        this transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        setLineNumber

        +
        public InsertLine setLineNumber(java.lang.Integer lineNumber)
        +
        Sets the line number the new line should be added at. + Line number for first line is 1. + If the specified number is greater than the number of lines, + then a TOExecutionResult.Type.NO_OP will be returned. + Notice that the insertion mode is automatically set to + InsertLine.InsertionMode.LINE_NUMBER.
        +
        +
        Parameters:
        +
        lineNumber - the line number the new line should be added at
        +
        Returns:
        +
        this transformation operation instance
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<InsertLine>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<InsertLine>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertText.InsertionMode.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertText.InsertionMode.html new file mode 100644 index 00000000..682ae61f --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertText.InsertionMode.html @@ -0,0 +1,374 @@ + + + + + +InsertText.InsertionMode (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.text
+

Enum InsertText.InsertionMode

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<InsertText.InsertionMode>
    +
    +
    +
    Enclosing class:
    +
    InsertText
    +
    +
    +
    +
    public static enum InsertText.InsertionMode
+extends java.lang.Enum<InsertText.InsertionMode>
    +
    The text can be inserted: +
      +
    1. InsertionMode.CONCAT: At the final of the file (default)
      2. +
    2. InsertionMode.LINE_NUMBER: At one particular specified line number (first line is number 1)
      3. +
    3. InsertionMode.REGEX_FIRST: Right after only the first line to match the specified regular expression
      4. +
    4. InsertionMode.REGEX_ALL: Right after any line to match the specified regular expression
      5. +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static InsertText.InsertionModevalueOf(java.lang.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.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static InsertText.InsertionMode[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (InsertText.InsertionMode c : InsertText.InsertionMode.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static InsertText.InsertionMode valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertText.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertText.html new file mode 100644 index 00000000..73f75647 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/InsertText.html @@ -0,0 +1,566 @@ + + + + + +InsertText (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.text
+

Class InsertText

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class InsertText
+extends com.paypal.butterfly.extensions.api.TransformationOperation<InsertText>
    +
    Inserts text from one file into another text file. + The text can be inserted: +
      +
    1. InsertionMode.CONCAT: At the final of the file (default)
      2. +
    2. InsertionMode.LINE_NUMBER: At one particular specified line number (first line is number 1)
      3. +
    3. InsertionMode.REGEX_FIRST: Right after only the first line to match the specified regular expression
      4. +
    4. InsertionMode.REGEX_ALL: Right after any line to match the specified regular expression
      5. +
    + Notice concat is the default insertion mode. It is also important to state that the text to be inserted will + always start on a new line and, if not placed on the end of the file, the continuation of the original text + will follow in a new line, even if the inserted text does not end with a line break. +
    + See setInsertionMode(InsertionMode)
    +
    +
    See Also:
    +
    InsertText.InsertionMode
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass 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 +
      +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      InsertText() +
      Operation to insert text into another text file.
      +
      InsertText(java.net.URL textFileUrl) +
      Operation to insert text into another text file.
      +
      InsertText(java.net.URL textFileUrl, + java.lang.Integer lineNumber) +
      Operation to insert text into another text file.
      +
      InsertText(java.net.URL textFileUrl, + java.lang.String regex) +
      Operation to insert text into another text file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      InsertTextsetInsertionMode(InsertText.InsertionMode insertionMode) +
      Sets the insertion mode
      +
      InsertTextsetLineNumber(java.lang.Integer lineNumber) +
      Sets the line number the text should be added at.
      +
      InsertTextsetRegex(java.lang.String regex) +
      Sets the regular expression to find insertion points +
      + See setInsertionMode(InsertionMode)
      +
      InsertTextsetTextFileUrl(java.net.URL textFileUrl) +
      Sets the URL to the text to be inserted
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        InsertText

        +
        public InsertText()
        +
        Operation to insert text into another text file. + The text can be inserted: +
          +
        1. InsertionMode.CONCAT: At the final of the file (default)
          2. +
        2. InsertionMode.LINE_NUMBER: At one particular specified line number (first line is number 1)
          3. +
        3. InsertionMode.REGEX_FIRST: Right after only the first line to match the specified regular expression
          4. +
        4. InsertionMode.REGEX_ALL: Right after any line to match the specified regular expression
          5. +
        +
        + See setInsertionMode(InsertionMode)
        +
        +
        See Also:
        +
        InsertText.InsertionMode
        +
        +
        • +
      + + + +
        +
      • +

        InsertText

        +
        public InsertText(java.net.URL textFileUrl)
        +
        Operation to insert text into another text file. + The text will be inserted at the end of the file, + unless another insertion method is specified +
        + See setInsertionMode(InsertionMode)
        +
        +
        Parameters:
        +
        textFileUrl - the URL to the text to be inserted
        +
        +
        • +
      + + + +
        +
      • +

        InsertText

        +
        public InsertText(java.net.URL textFileUrl,
+                  java.lang.Integer lineNumber)
        +
        Operation to insert text into another text file. + The text will be inserted at the specified line number +
        + Notice that the insertion mode is automatically set to + InsertText.InsertionMode.LINE_NUMBER
        +
        +
        Parameters:
        +
        textFileUrl - the URL to the text to be inserted
        +
        lineNumber - the line number the text should be added at
        +
        +
        • +
      + + + +
        +
      • +

        InsertText

        +
        public InsertText(java.net.URL textFileUrl,
+                  java.lang.String regex)
        +
        Operation to insert text into another text file. + The text will be inserted right after only the first + line to match the specified regular expression +
        + Notice that the insertion mode is automatically set to + InsertText.InsertionMode.REGEX_FIRST
        +
        +
        Parameters:
        +
        textFileUrl - the URL to the text to be inserted
        +
        regex - the regular expression to find insertion points
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setInsertionMode

        +
        public InsertText setInsertionMode(InsertText.InsertionMode insertionMode)
        +
        Sets the insertion mode
        +
        +
        Parameters:
        +
        insertionMode - the insertion mode
        +
        Returns:
        +
        this transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        setTextFileUrl

        +
        public InsertText setTextFileUrl(java.net.URL textFileUrl)
        +
        Sets the URL to the text to be inserted
        +
        +
        Parameters:
        +
        textFileUrl - the URL to the text to be inserted
        +
        Returns:
        +
        this transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        setLineNumber

        +
        public InsertText setLineNumber(java.lang.Integer lineNumber)
        +
        Sets the line number the text should be added at. + Line number for first line is 1.
        +
        +
        Parameters:
        +
        lineNumber - the line number the text should be added at
        +
        Returns:
        +
        this transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        setRegex

        +
        public InsertText setRegex(java.lang.String regex)
        +
        Sets the regular expression to find insertion points +
        + See setInsertionMode(InsertionMode)
        +
        +
        Parameters:
        +
        regex - the regular expression to find insertion points
        +
        Returns:
        +
        this transformation operation instance
        +
        See Also:
        +
        InsertText.InsertionMode
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<InsertText>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<InsertText>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/RemoveLine.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/RemoveLine.html new file mode 100644 index 00000000..0aeedb91 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/RemoveLine.html @@ -0,0 +1,466 @@ + + + + + +RemoveLine (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.text
+

Class RemoveLine

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class RemoveLine
+extends com.paypal.butterfly.utilities.operations.text.AbstractLineOperation<RemoveLine>
    +
    Removes one, or more, lines from a text file. + The line to be removed is chosen either based on a regular + expression, or by the line number. +
    + If the regular expression + is set, only the first line found to match it will be removed, + unless AbstractLineOperation.setFirstOnly(boolean) is set to false, then + all lines that match it will be removed. +
    + If a regular expression and a line number are both set, + the line number will take precedence, and the regular expression + will be ignored
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.utilities.operations.text.AbstractLineOperation

        +manipulationWord
        • +
      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      RemoveLine() +
      Operation to remove one, or more, lines from a text file.
      +
      RemoveLine(java.lang.Integer lineNumber) +
      Operation to remove one line from a text file, based on a + line number.
      +
      RemoveLine(java.lang.String regex) +
      Operation to remove one, or more, lines from a text file.
      +
      RemoveLine(java.lang.String regex, + boolean firstOnly) +
      Operation to remove one, or more, lines from a text file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetDescription() 
      protected booleanmanipulateLine(java.lang.String lineToBeManipulated, + java.io.Writer writer) 
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.utilities.operations.text.AbstractLineOperation

        +execution, getLineNumber, getRegex, isFirstOnly, setFirstOnly, setLineNumber, setRegex
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RemoveLine

        +
        public RemoveLine()
        +
        Operation to remove one, or more, lines from a text file. + The line to be removed is chosen either based on a regular + expression, or by the line number. +
        + If the regular expression + is set, only the first found to match it will be removed, + unless AbstractLineOperation.setFirstOnly(boolean) is set to false, then + all lines that match it will be removed. +
        + If a regular expression and a line number are both set, + the line number will take precedence, and the regular expression + will be ignored
        +
        • +
      + + + +
        +
      • +

        RemoveLine

        +
        public RemoveLine(java.lang.String regex)
        +
        Operation to remove one, or more, lines from a text file. + The line to be removed is chosen either based on a regular + expression, or by the line number. +
        + If the regular expression + is set, only the first found to match it will be removed, + unless AbstractLineOperation.setFirstOnly(boolean) is set to false, then + all lines that match it will be removed. +
        + If a regular expression and a line number are both set, + the line number will take precedence, and the regular expression + will be ignored
        +
        +
        Parameters:
        +
        regex - the regular expression to identify the line(s) to be removed
        +
        +
        • +
      + + + +
        +
      • +

        RemoveLine

        +
        public RemoveLine(java.lang.String regex,
+                  boolean firstOnly)
        +
        Operation to remove one, or more, lines from a text file. + The line to be removed is chosen either based on a regular + expression, or by the line number. +
        + If the regular expression + is set, only the first found to match it will be removed, + unless AbstractLineOperation.setFirstOnly(boolean) is set to false, then + all lines that match it will be removed. +
        + If a regular expression and a line number are both set, + the line number will take precedence, and the regular expression + will be ignored
        +
        +
        Parameters:
        +
        regex - the regular expression to identify the line(s) to be removed
        +
        firstOnly - if true, only the first line found (from top down) to match + the regular expression will be removed. If false, all of them + will
        +
        +
        • +
      + + + +
        +
      • +

        RemoveLine

        +
        public RemoveLine(java.lang.Integer lineNumber)
        +
        Operation to remove one line from a text file, based on a + line number.
        +
        +
        Parameters:
        +
        lineNumber - the number of the line to be removed
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        manipulateLine

        +
        protected boolean manipulateLine(java.lang.String lineToBeManipulated,
+                                 java.io.Writer writer)
        +
        +
        Specified by:
        +
        manipulateLine in class com.paypal.butterfly.utilities.operations.text.AbstractLineOperation<RemoveLine>
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<RemoveLine>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/ReplaceLine.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/ReplaceLine.html new file mode 100644 index 00000000..0d9f0cd7 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/ReplaceLine.html @@ -0,0 +1,533 @@ + + + + + +ReplaceLine (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.text
+

Class ReplaceLine

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class ReplaceLine
+extends com.paypal.butterfly.utilities.operations.text.AbstractLineOperation<ReplaceLine>
    +
    Replaces one, or more, lines from a text file. + The line to be replace is chosen either based on a regular + expression, or by the line number. +
    + If the regular expression + is set, only the first line found to match it will be replaced, + unless AbstractLineOperation.setFirstOnly(boolean) is set to false, then + all lines that match it will be replaced. +
    + If a regular expression and a line number are both set, + the line number will take precedence, and the regular expression + will be ignored
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.utilities.operations.text.AbstractLineOperation

        +manipulationWord
        • +
      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      ReplaceLine() +
      Operation to replace one, or more, lines from a text file.
      +
      ReplaceLine(java.lang.Integer lineNumber, + java.lang.String replacement) +
      Operation to replace one line from a text file, based on a + line number.
      +
      ReplaceLine(java.lang.String regex, + java.lang.String replacement) +
      Operation to replace one, or more, lines from a text file.
      +
      ReplaceLine(java.lang.String regex, + java.lang.String replacement, + boolean firstOnly) +
      Operation to replace one, or more, lines from a text file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetDescription() 
      java.lang.StringgetReplacement() 
      protected booleanmanipulateLine(java.lang.String lineToBeManipulated, + java.io.Writer writer) 
      ReplaceLinesetReplacement(java.lang.String replacement) +
      Sets the replacement line
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.utilities.operations.text.AbstractLineOperation

        +execution, getLineNumber, getRegex, isFirstOnly, setFirstOnly, setLineNumber, setRegex
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ReplaceLine

        +
        public ReplaceLine()
        +
        Operation to replace one, or more, lines from a text file. + The line to be replaced is chosen either based on a regular + expression, or by the line number. +
        + If the regular expression + is set, only the first found to match it will be replaced, + unless AbstractLineOperation.setFirstOnly(boolean) is set to false, then + all lines that match it will be replaced. +
        + If a regular expression and a line number are both set, + the line number will take precedence, and the regular expression + will be ignored
        +
        • +
      + + + +
        +
      • +

        ReplaceLine

        +
        public ReplaceLine(java.lang.String regex,
+                   java.lang.String replacement)
        +
        Operation to replace one, or more, lines from a text file. + The line to be replaced is chosen either based on a regular + expression, or by the line number. +
        + If the regular expression + is set, only the first found to match it will be replaced, + unless AbstractLineOperation.setFirstOnly(boolean) is set to false, then + all lines that match it will be replaced. +
        + If a regular expression and a line number are both set, + the line number will take precedence, and the regular expression + will be ignored
        +
        +
        Parameters:
        +
        regex - the regular expression to identify the line(s) to be replaced
        +
        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.
        +
        +
        • +
      + + + +
        +
      • +

        ReplaceLine

        +
        public ReplaceLine(java.lang.String regex,
+                   java.lang.String replacement,
+                   boolean firstOnly)
        +
        Operation to replace one, or more, lines from a text file. + The line to be replaced is chosen either based on a regular + expression, or by the line number. +
        + If the regular expression + is set, only the first found to match it will be replaced, + unless AbstractLineOperation.setFirstOnly(boolean) is set to false, then + all lines that match it will be replaced. +
        + If a regular expression and a line number are both set, + the line number will take precedence, and the regular expression + will be ignored
        +
        +
        Parameters:
        +
        regex - the regular expression to identify the line(s) to be replaced
        +
        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.
        +
        firstOnly - if true, only the first line found (from top down) to match + the regular expression will be replaced. If false, all of them + will
        +
        +
        • +
      + + + +
        +
      • +

        ReplaceLine

        +
        public ReplaceLine(java.lang.Integer lineNumber,
+                   java.lang.String replacement)
        +
        Operation to replace one line from a text file, based on a + line number.
        +
        +
        Parameters:
        +
        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 replaced
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setReplacement

        +
        public ReplaceLine setReplacement(java.lang.String replacement)
        +
        Sets the replacement line
        +
        +
        Parameters:
        +
        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.
        +
        Returns:
        +
        this transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        getReplacement

        +
        public java.lang.String getReplacement()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<ReplaceLine>
        +
        +
        • +
      + + + +
        +
      • +

        manipulateLine

        +
        protected boolean manipulateLine(java.lang.String lineToBeManipulated,
+                                 java.io.Writer writer)
+                          throws java.io.IOException
        +
        +
        Specified by:
        +
        manipulateLine in class com.paypal.butterfly.utilities.operations.text.AbstractLineOperation<ReplaceLine>
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/ReplaceText.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/ReplaceText.html new file mode 100644 index 00000000..3304a811 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/ReplaceText.html @@ -0,0 +1,495 @@ + + + + + +ReplaceText (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.text
+

Class ReplaceText

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class ReplaceText
+extends com.paypal.butterfly.extensions.api.TransformationOperation<ReplaceText>
    +
    Replaces text in a text file + based on a regular expression.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      ReplaceText() +
      Operation to replace text in a text file + based on a regular expression.
      +
      ReplaceText(java.lang.String regex) +
      Operation to replace text in a text file + based on a regular expression.
      +
      ReplaceText(java.lang.String regex, + java.lang.String replacement) +
      Operation to replace text in a text file + based on a regular expression.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      java.lang.StringgetRegex() 
      java.lang.StringgetReplacement() 
      booleanisFirstOnly() 
      ReplaceTextsetFirstOnly(boolean firstOnly) +
      Sets whether all lines, or only the first, to match the + regular expression will be replaced
      +
      ReplaceTextsetRegex(java.lang.String regex) +
      Sets the regular expression to find replacement points
      +
      ReplaceTextsetReplacement(java.lang.String replacement) +
      Sets the replacement text
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ReplaceText

        +
        public ReplaceText()
        +
        Operation to replace text in a text file + based on a regular expression.
        +
        • +
      + + + +
        +
      • +

        ReplaceText

        +
        public ReplaceText(java.lang.String regex)
        +
        Operation to replace text in a text file + based on a regular expression.
        +
        +
        Parameters:
        +
        regex - the regular expression to find replacement points
        +
        +
        • +
      + + + +
        +
      • +

        ReplaceText

        +
        public ReplaceText(java.lang.String regex,
+                   java.lang.String replacement)
        +
        Operation to replace text in a text file + based on a regular expression.
        +
        +
        Parameters:
        +
        regex - the regular expression to find replacement points
        +
        replacement - the replacement text
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setRegex

        +
        public ReplaceText setRegex(java.lang.String regex)
        +
        Sets the regular expression to find replacement points
        +
        +
        Parameters:
        +
        regex - the regular expression to find replacement points
        +
        Returns:
        +
        this transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        setReplacement

        +
        public ReplaceText setReplacement(java.lang.String replacement)
        +
        Sets the replacement text
        +
        +
        Parameters:
        +
        replacement - the replacement text
        +
        Returns:
        +
        this transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        setFirstOnly

        +
        public ReplaceText setFirstOnly(boolean firstOnly)
        +
        Sets whether all lines, or only the first, to match the + regular expression will be replaced
        +
        +
        Parameters:
        +
        firstOnly - all lines, or only the first, to match the + regular expression will be replaced
        +
        Returns:
        +
        this transformation operation instance
        +
        +
        • +
      + + + +
        +
      • +

        getRegex

        +
        public java.lang.String getRegex()
        +
        • +
      + + + +
        +
      • +

        getReplacement

        +
        public java.lang.String getReplacement()
        +
        • +
      + + + +
        +
      • +

        isFirstOnly

        +
        public boolean isFirstOnly()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<ReplaceText>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<ReplaceText>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/package-frame.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/package-frame.html new file mode 100644 index 00000000..eafdda04 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/package-frame.html @@ -0,0 +1,30 @@ + + + + + +com.paypal.butterfly.utilities.operations.text (butterfly-utilities 3.2.1 API) + + + + + +

com.paypal.butterfly.utilities.operations.text

+
+

Classes

+ +

Enums

+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/package-summary.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/package-summary.html new file mode 100644 index 00000000..1b5dae38 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/package-summary.html @@ -0,0 +1,218 @@ + + + + + +com.paypal.butterfly.utilities.operations.text (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.paypal.butterfly.utilities.operations.text

+
+
Transformation operations to manipulate text files.
+
+

See: Description

+
+
+ + + + +

Package com.paypal.butterfly.utilities.operations.text Description

+
Transformation operations to manipulate text files.
+
+
Since:
+
1.0.0
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/package-tree.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/package-tree.html new file mode 100644 index 00000000..8de2d275 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/text/package-tree.html @@ -0,0 +1,165 @@ + + + + + +com.paypal.butterfly.utilities.operations.text Class Hierarchy (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.paypal.butterfly.utilities.operations.text

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/xml/XmlXPathReplace.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/xml/XmlXPathReplace.html new file mode 100644 index 00000000..6b499dc0 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/xml/XmlXPathReplace.html @@ -0,0 +1,481 @@ + + + + + +XmlXPathReplace (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.operations.xml
+

Class XmlXPathReplace

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class XmlXPathReplace
+extends com.paypal.butterfly.extensions.api.TransformationOperation<XmlXPathReplace>
    +
    Modify an XML file based on a given XPath expression. +
    + It has the following different modes of operation: +
      +
    1. If an Element is provided, every matched node is replaced by given the element.
      2. +
    2. If a String is provided, the text of every matched node is replaced by the given String.
      3. +
    3. If neither Element nor String are provided, every matched node is removed.
      4. +
    +
    + If the XPath expression doesn't compile, or if the file is not a well formed XML file, an error is returned.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      XmlXPathReplace(java.lang.String xpathExpressionString) +
      Modify an XML file based on a given XPath expression.
      +
      XmlXPathReplace(java.lang.String xpathExpressionString, + org.w3c.dom.Element replacementElement) +
      Modify an XML file based on a given XPath expression.
      +
      XmlXPathReplace(java.lang.String xpathExpressionString, + java.lang.String replacementString) +
      Modify an XML file based on a given XPath expression.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TOExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      XmlXPathReplacesetReplacementElement(org.w3c.dom.Element replacementElement) +
      The Element that is used to replace the + Node result of xpath expression.
      +
      XmlXPathReplacesetReplacementString(java.lang.String replacementString) +
      The String that is used to replace the text result of xpath expression.
      +
      XmlXPathReplacesetXPathExpression(java.lang.String xpathExpressionString) +
      The XPathExpression whose evaluation finds the + results to replace.
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationOperation

        +getOrCreateReadFile, perform, setSaveResult
        • +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        XmlXPathReplace

        +
        public XmlXPathReplace(java.lang.String xpathExpressionString)
        +
        Modify an XML file based on a given XPath expression. + Since neither Element nor String are provided, the matched node will be removed. +
        + If the XPath expression doesn't compile, or if the file is not a well formed XML file, an error is returned.
        +
        +
        Parameters:
        +
        xpathExpressionString - a String that compiles into a XPathExpression
        +
        +
        • +
      + + + +
        +
      • +

        XmlXPathReplace

        +
        public XmlXPathReplace(java.lang.String xpathExpressionString,
+                       org.w3c.dom.Element replacementElement)
        +
        Modify an XML file based on a given XPath expression. + Since an Element is provided, the whole node is replaced by given the element. +
        + If the XPath expression doesn't compile, or if the file is not a well formed XML file, an error is returned.
        +
        +
        Parameters:
        +
        xpathExpressionString - a String that compiles into a XPathExpression
        +
        replacementElement - an Element this is used to replace the + Node in the search
        +
        +
        • +
      + + + +
        +
      • +

        XmlXPathReplace

        +
        public XmlXPathReplace(java.lang.String xpathExpressionString,
+                       java.lang.String replacementString)
        +
        Modify an XML file based on a given XPath expression. +
        + It has the following different modes of operation: + Since a String is provided, then the text of the node is replaced by the given String. +
        + If the XPath expression doesn't compile, or if the file is not a well formed XML file, an error is returned.
        +
        +
        Parameters:
        +
        xpathExpressionString - a String that compiles into a XPathExpression
        +
        replacementString - a String this is used to replace the text content of the + Node found in the search
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<XmlXPathReplace>
        +
        +
        • +
      + + + +
        +
      • +

        setReplacementString

        +
        public XmlXPathReplace setReplacementString(java.lang.String replacementString)
        +
        The String that is used to replace the text result of xpath expression.
        +
        +
        Parameters:
        +
        replacementString - a String used to replace text() of xpath.
        +
        Returns:
        +
        this instance
        +
        +
        • +
      + + + +
        +
      • +

        setReplacementElement

        +
        public XmlXPathReplace setReplacementElement(org.w3c.dom.Element replacementElement)
        +
        The Element that is used to replace the + Node result of xpath expression.
        +
        +
        Parameters:
        +
        replacementElement - an Element this is used to replace the + Node in the search
        +
        Returns:
        +
        this instance
        +
        +
        • +
      + + + +
        +
      • +

        setXPathExpression

        +
        public XmlXPathReplace setXPathExpression(java.lang.String xpathExpressionString)
        +
        The XPathExpression whose evaluation finds the + results to replace.
        +
        +
        Parameters:
        +
        xpathExpressionString - a String that compiles into a + XPathExpression
        +
        Returns:
        +
        this instance
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TOExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<XmlXPathReplace>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/xml/package-frame.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/xml/package-frame.html new file mode 100644 index 00000000..0427157d --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/xml/package-frame.html @@ -0,0 +1,20 @@ + + + + + +com.paypal.butterfly.utilities.operations.xml (butterfly-utilities 3.2.1 API) + + + + + +

com.paypal.butterfly.utilities.operations.xml

+
+

Classes

+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/xml/package-summary.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/xml/package-summary.html new file mode 100644 index 00000000..0d82b5f0 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/xml/package-summary.html @@ -0,0 +1,155 @@ + + + + + +com.paypal.butterfly.utilities.operations.xml (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.paypal.butterfly.utilities.operations.xml

+
+
Transformation operations to manipulate XML files.
+
+

See: Description

+
+
+ + + + +

Package com.paypal.butterfly.utilities.operations.xml Description

+
Transformation operations to manipulate XML files.
+
+
Since:
+
1.0.0
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/xml/package-tree.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/xml/package-tree.html new file mode 100644 index 00000000..03ffd43b --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/operations/xml/package-tree.html @@ -0,0 +1,143 @@ + + + + + +com.paypal.butterfly.utilities.operations.xml Class Hierarchy (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.paypal.butterfly.utilities.operations.xml

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/AbstractPomGetUtility.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/AbstractPomGetUtility.html new file mode 100644 index 00000000..3640ad7f --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/AbstractPomGetUtility.html @@ -0,0 +1,388 @@ + + + + + +AbstractPomGetUtility (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.pom
+

Class AbstractPomGetUtility<T extends AbstractPomGetUtility>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    +
    PomGetPackaging, PomGetParent
    +
    +
    +
    +
    public abstract class AbstractPomGetUtility<T extends AbstractPomGetUtility>
+extends com.paypal.butterfly.extensions.api.TransformationUtility<T>
    +
    Abstract class to utility class to manipulate Maven artifacts either from a pom file or a model
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      AbstractPomGetUtility() +
      Abstract class to utility class to manipulate Maven artifacts either from a pom file or a model
      +
      AbstractPomGetUtility(java.lang.String modelAttributeName) +
      Abstract class to utility class to manipulate Maven artifacts either from a pom file or a model
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetModelAttributeName() +
      Returns the name of the context attribute containing the Maven Model object
      +
      protected abstract com.paypal.butterfly.extensions.api.TUExecutionResultpomExecution(org.apache.maven.model.Model model) 
      TsetModelAttributeName(java.lang.String modelAttributeName) +
      Sets the name of the context attribute containing the Maven Model object
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AbstractPomGetUtility

        +
        public AbstractPomGetUtility()
        +
        Abstract class to utility class to manipulate Maven artifacts either from a pom file or a model
        +
        • +
      + + + +
        +
      • +

        AbstractPomGetUtility

        +
        public AbstractPomGetUtility(java.lang.String modelAttributeName)
        +
        Abstract class to utility class to manipulate Maven artifacts either from a pom file or a model
        +
        +
        Parameters:
        +
        modelAttributeName - the name of the context attribute containing the Maven Model object
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setModelAttributeName

        +
        public T setModelAttributeName(java.lang.String modelAttributeName)
        +
        Sets the name of the context attribute containing the Maven Model object
        +
        +
        Parameters:
        +
        modelAttributeName - the name of the context attribute containing the Maven Model object
        +
        Returns:
        +
        this transformation utility
        +
        +
        • +
      + + + +
        +
      • +

        getModelAttributeName

        +
        public java.lang.String getModelAttributeName()
        +
        Returns the name of the context attribute containing the Maven Model object
        +
        +
        Returns:
        +
        the name of the context attribute containing the Maven Model object
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<T extends AbstractPomGetUtility>
        +
        +
        • +
      + + + +
        +
      • +

        pomExecution

        +
        protected abstract com.paypal.butterfly.extensions.api.TUExecutionResult pomExecution(org.apache.maven.model.Model model)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/PomGetPackaging.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/PomGetPackaging.html new file mode 100644 index 00000000..d20ea058 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/PomGetPackaging.html @@ -0,0 +1,374 @@ + + + + + +PomGetPackaging (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.pom
+

Class PomGetPackaging

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class PomGetPackaging
+extends AbstractPomGetUtility<PomGetPackaging>
    +
    Retrieve the packaging of specified Maven artifact. + There are two ways to specify the Maven artifact: +
      +
    1. As a context attribute, containing the Maven Model object
      2. +
    2. As a file, specified via regular TransformationUtility.relative(String), TransformationUtility.absolute(String) or TransformationUtility.absolute(String, String) methods
      3. +
    + If Maven artifact is set with both options, the Maven model will be used, and the file will be ignored.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomGetPackaging() +
      Retrieve the packaging of specified Maven artifact.
      +
      PomGetPackaging(java.lang.String modelAttributeName) +
      Retrieve the packaging of specified Maven artifact.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetDescription() 
      protected com.paypal.butterfly.extensions.api.TUExecutionResultpomExecution(org.apache.maven.model.Model model) 
      + +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomGetPackaging

        +
        public PomGetPackaging()
        +
        Retrieve the packaging of specified Maven artifact. + There are two ways to specify the Maven artifact: +
          +
        1. As a file, specified via regular TransformationUtility.relative(String), TransformationUtility.absolute(String) or TransformationUtility.absolute(String, String) methods
          2. +
        2. As a context attribute, containing the Maven Model object
          3. +
        + If Maven artifact is set with both options, the Maven model will be used, and the file will be ignored.
        +
        • +
      + + + +
        +
      • +

        PomGetPackaging

        +
        public PomGetPackaging(java.lang.String modelAttributeName)
        +
        Retrieve the packaging of specified Maven artifact. + There are two ways to specify the Maven artifact: +
          +
        1. As a file, specified via regular TransformationUtility.relative(String), TransformationUtility.absolute(String) or TransformationUtility.absolute(String, String) methods
          2. +
        2. As a context attribute, containing the Maven Model object
          3. +
        + If Maven artifact is set with both options, the Maven model will be used, and the file will be ignored.
        +
        +
        Parameters:
        +
        modelAttributeName - the name of the context attribute containing the Maven Model object
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomGetPackaging>
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/PomGetParent.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/PomGetParent.html new file mode 100644 index 00000000..5f8b8322 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/PomGetParent.html @@ -0,0 +1,380 @@ + + + + + +PomGetParent (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.pom
+

Class PomGetParent

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class PomGetParent
+extends AbstractPomGetUtility<PomGetParent>
    +
    Retrieve the Maven coordinates (group id, artifact id and version) of the parent of specified Maven artifact. + The result is a single String where groupId, artifactId and version are separated by colon. + If given Maven artifact does not have a parent, it results in TUExecutionResult.Type.NULL + There are two ways to specify the Maven artifact: +
      +
    1. As a context attribute, containing the Maven Model object
      2. +
    2. As a file, specified via regular TransformationUtility.relative(String), TransformationUtility.absolute(String) or TransformationUtility.absolute(String, String) methods
      3. +
    + If Maven artifact is set with both options, the Maven model will be used, and the file will be ignored.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomGetParent() +
      Retrieve the Maven coordinates (group id, artifact id and version) of the parent of specified Maven artifact.
      +
      PomGetParent(java.lang.String modelAttributeName) +
      Retrieve the Maven coordinates (group id, artifact id and version) of the parent of specified Maven artifact.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetDescription() 
      protected com.paypal.butterfly.extensions.api.TUExecutionResultpomExecution(org.apache.maven.model.Model model) 
      + +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomGetParent

        +
        public PomGetParent()
        +
        Retrieve the Maven coordinates (group id, artifact id and version) of the parent of specified Maven artifact. + The result is a single String where groupId, artifactId and version are separated by colon. + If given Maven artifact does not have a parent, it results in TUExecutionResult.Type.NULL + There are two ways to specify the Maven artifact: +
          +
        1. As a file, specified via regular TransformationUtility.relative(String), TransformationUtility.absolute(String) or TransformationUtility.absolute(String, String) methods
          2. +
        2. As a context attribute, containing the Maven Model object
          3. +
        + If Maven artifact is set with both options, the Maven model will be used, and the file will be ignored.
        +
        • +
      + + + +
        +
      • +

        PomGetParent

        +
        public PomGetParent(java.lang.String modelAttributeName)
        +
        Retrieve the Maven coordinates (group id, artifact id and version) of the parent of specified Maven artifact. + The result is a single String where groupId, artifactId and version are separated by colon. + If given Maven artifact does not have a parent, it results in TUExecutionResult.Type.NULL + There are two ways to specify the Maven artifact: +
          +
        1. As a file, specified via regular TransformationUtility.relative(String), TransformationUtility.absolute(String) or TransformationUtility.absolute(String, String) methods
          2. +
        2. As a context attribute, containing the Maven Model object
          3. +
        + If Maven artifact is set with both options, the Maven model will be used, and the file will be ignored.
        +
        +
        Parameters:
        +
        modelAttributeName - the name of the context attribute containing the Maven Model object
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomGetParent>
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/PomModel.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/PomModel.html new file mode 100644 index 00000000..0d98cd9d --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/PomModel.html @@ -0,0 +1,567 @@ + + + + + +PomModel (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.pom
+

Class PomModel

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class PomModel
+extends com.paypal.butterfly.extensions.api.TransformationUtility<PomModel>
    +
    Load a Maven artifact, model it and place it in transformation context. + There are two ways to specify the Maven artifact: +
      +
    1. By its coordinates (group id, artifact id and version)
      2. +
    2. As a file, specified via regular TransformationUtility.relative(String), TransformationUtility.absolute(String) or TransformationUtility.absolute(String, String) methods
      3. +
    + If Maven artifact is set with both options, the Maven artifact coordinates will be used, and the file will be ignored.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PomModel() +
      Download a Maven artifact, model it and place it in transformation context.
      +
      PomModel(java.lang.String groupId, + java.lang.String artifactId, + java.lang.String version) +
      Download a Maven artifact, model it and place it in transformation context.
      +
      PomModel(java.lang.String groupId, + java.lang.String artifactId, + java.lang.String version, + java.lang.String repoURI) +
      Download a Maven artifact, model it and place it in transformation context.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetArtifactId() 
      java.lang.StringgetDescription() 
      java.lang.StringgetGroupId() 
      java.lang.StringgetRepoURI() 
      java.lang.StringgetVersion() 
      PomModelsetArtifact(java.lang.String artifactInfo) +
      Sets the groupId, artifactId and version from artifactInfo
      +
      PomModelsetArtifactId(java.lang.String artifactId) +
      Sets the artifactId
      +
      PomModelsetGroupId(java.lang.String groupId) +
      Sets Maven artifact group id
      +
      PomModelsetRepoURI(java.lang.String repoURI) +
      Sets the repoURI
      +
      PomModelsetVersion(java.lang.String version) +
      Sets the version
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PomModel

        +
        public PomModel()
        +
        Download a Maven artifact, model it and place it in transformation context. + The Maven artifact is specified by its group id, artifact id and version.
        +
        • +
      + + + +
        +
      • +

        PomModel

        +
        public PomModel(java.lang.String groupId,
+                java.lang.String artifactId,
+                java.lang.String version)
        +
        Download a Maven artifact, model it and place it in transformation context. + The Maven artifact is specified by its group id, artifact id and version.
        +
        +
        Parameters:
        +
        groupId - Maven artifact group id
        +
        artifactId - Maven artifact id
        +
        version - Maven artifact version
        +
        +
        • +
      + + + +
        +
      • +

        PomModel

        +
        public PomModel(java.lang.String groupId,
+                java.lang.String artifactId,
+                java.lang.String version,
+                java.lang.String repoURI)
        +
        Download a Maven artifact, model it and place it in transformation context. + The Maven artifact is specified by its group id, artifact id and version.
        +
        +
        Parameters:
        +
        groupId - Maven artifact group id
        +
        artifactId - Maven artifact id
        +
        version - Maven artifact version
        +
        repoURI - Maven repository URI
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setArtifact

        +
        public PomModel setArtifact(java.lang.String artifactInfo)
        +
        Sets the groupId, artifactId and version from artifactInfo
        +
        +
        Parameters:
        +
        artifactInfo - groupId, artifactId and version separated by colons
        +
        Returns:
        +
        this transformation utility
        +
        +
        • +
      + + + +
        +
      • +

        setGroupId

        +
        public PomModel setGroupId(java.lang.String groupId)
        +
        Sets Maven artifact group id
        +
        +
        Parameters:
        +
        groupId - Maven artifact group id
        +
        Returns:
        +
        this transformation utility
        +
        +
        • +
      + + + +
        +
      • +

        getGroupId

        +
        public java.lang.String getGroupId()
        +
        +
        Returns:
        +
        Maven artifact group id
        +
        +
        • +
      + + + +
        +
      • +

        setArtifactId

        +
        public PomModel setArtifactId(java.lang.String artifactId)
        +
        Sets the artifactId
        +
        +
        Parameters:
        +
        artifactId - Maven artifact id
        +
        Returns:
        +
        this transformation utility
        +
        +
        • +
      + + + +
        +
      • +

        getArtifactId

        +
        public java.lang.String getArtifactId()
        +
        +
        Returns:
        +
        artifactId
        +
        +
        • +
      + + + +
        +
      • +

        setVersion

        +
        public PomModel setVersion(java.lang.String version)
        +
        Sets the version
        +
        +
        Parameters:
        +
        version - Maven artifact version
        +
        Returns:
        +
        this transformation utility
        +
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        public java.lang.String getVersion()
        +
        +
        Returns:
        +
        version
        +
        +
        • +
      + + + +
        +
      • +

        setRepoURI

        +
        public PomModel setRepoURI(java.lang.String repoURI)
        +
        Sets the repoURI
        +
        +
        Parameters:
        +
        repoURI - Maven repository URI
        +
        Returns:
        +
        this transformation utility
        +
        +
        • +
      + + + +
        +
      • +

        getRepoURI

        +
        public java.lang.String getRepoURI()
        +
        +
        Returns:
        +
        repoURI
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<PomModel>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<PomModel>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/package-frame.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/package-frame.html new file mode 100644 index 00000000..d0da012c --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/package-frame.html @@ -0,0 +1,23 @@ + + + + + +com.paypal.butterfly.utilities.pom (butterfly-utilities 3.2.1 API) + + + + + +

com.paypal.butterfly.utilities.pom

+
+

Classes

+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/package-summary.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/package-summary.html new file mode 100644 index 00000000..7f2f4382 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/package-summary.html @@ -0,0 +1,160 @@ + + + + + +com.paypal.butterfly.utilities.pom (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.paypal.butterfly.utilities.pom

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/package-tree.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/package-tree.html new file mode 100644 index 00000000..8525324f --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/pom/package-tree.html @@ -0,0 +1,145 @@ + + + + + +com.paypal.butterfly.utilities.pom Class Hierarchy (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.paypal.butterfly.utilities.pom

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/text/StringFormat.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/text/StringFormat.html new file mode 100644 index 00000000..dca099c7 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/text/StringFormat.html @@ -0,0 +1,422 @@ + + + + + +StringFormat (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.text
+

Class StringFormat

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class StringFormat
+extends com.paypal.butterfly.extensions.api.TransformationUtility<StringFormat>
    +
    Applies one or more transformation context attributes to a format String, using String.format(String, Object...). + The order of attributes will be honored when applying the formatting. + If the String format and the arguments don't match in type or number, an error is returned.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      StringFormat() +
      Applies one or more transformation context attributes to a format String, using String.format(String, Object...).
      +
      StringFormat(java.lang.String format) +
      Applies one or more transformation context attributes to a format String, using String.format(String, Object...).
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.String[]getAttributeNames() 
      java.lang.StringgetDescription() 
      java.lang.StringgetFormat() 
      StringFormatsetAttributeNames(java.lang.String... attributeNames) +
      Set the name of the transformation context attributes to be applied to the String format
      +
      StringFormatsetFormat(java.lang.String format) +
      Set the String format to be applied
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StringFormat

        +
        public StringFormat()
        +
        Applies one or more transformation context attributes to a format String, using String.format(String, Object...). + The order of attributes will be honored when applying the formatting. + If the String format and the arguments don't match in type or number, an error is returned.
        +
        • +
      + + + +
        +
      • +

        StringFormat

        +
        public StringFormat(java.lang.String format)
        +
        Applies one or more transformation context attributes to a format String, using String.format(String, Object...). + The order of attributes will be honored when applying the formatting. + If the String format and the arguments don't match in type or number, an error is returned.
        +
        +
        Parameters:
        +
        format - the String format to be applied
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setFormat

        +
        public StringFormat setFormat(java.lang.String format)
        +
        Set the String format to be applied
        +
        +
        Parameters:
        +
        format - the String format to be applied
        +
        Returns:
        +
        this utility instance
        +
        +
        • +
      + + + +
        +
      • +

        setAttributeNames

        +
        public StringFormat setAttributeNames(java.lang.String... attributeNames)
        +
        Set the name of the transformation context attributes to be applied to the String format
        +
        +
        Parameters:
        +
        attributeNames - the name of the transformation context attributes to be applied to the String format
        +
        Returns:
        +
        this utility instance
        +
        +
        • +
      + + + +
        +
      • +

        getFormat

        +
        public java.lang.String getFormat()
        +
        • +
      + + + +
        +
      • +

        getAttributeNames

        +
        public java.lang.String[] getAttributeNames()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<StringFormat>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<StringFormat>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/text/package-frame.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/text/package-frame.html new file mode 100644 index 00000000..1d819df8 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/text/package-frame.html @@ -0,0 +1,20 @@ + + + + + +com.paypal.butterfly.utilities.text (butterfly-utilities 3.2.1 API) + + + + + +

com.paypal.butterfly.utilities.text

+
+

Classes

+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/text/package-summary.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/text/package-summary.html new file mode 100644 index 00000000..5fb68767 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/text/package-summary.html @@ -0,0 +1,155 @@ + + + + + +com.paypal.butterfly.utilities.text (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.paypal.butterfly.utilities.text

+
+
Transformation utilities to gather meta-data about text files.
+
+

See: Description

+
+
+ + + + +

Package com.paypal.butterfly.utilities.text Description

+
Transformation utilities to gather meta-data about text files.
+
+
Since:
+
1.0.0
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/text/package-tree.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/text/package-tree.html new file mode 100644 index 00000000..efd81403 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/text/package-tree.html @@ -0,0 +1,139 @@ + + + + + +com.paypal.butterfly.utilities.text Class Hierarchy (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.paypal.butterfly.utilities.text

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/XmlElement.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/XmlElement.html new file mode 100644 index 00000000..5dbebd85 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/XmlElement.html @@ -0,0 +1,460 @@ + + + + + +XmlElement (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.xml
+

Class XmlElement

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    Deprecated.
    +
    +
    @Deprecated
+public class XmlElement
+extends com.paypal.butterfly.extensions.api.TransformationUtility<XmlElement>
    +
    This transformation utility is deprecated. + Please use XmlXPathRetrieve instead.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      XmlElement() +
      Deprecated. 
      +
      Retrieves the value of an element, + or one of its attributes, in a XML file.
      +
      XmlElement(java.lang.String xmlElement) +
      Deprecated. 
      +
      Retrieves the value of an element, + or one of its attributes, in a XML file.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) +
      Deprecated. 
      + 
      java.lang.StringgetDescription() +
      Deprecated. 
      + 
      XmlElementsetAttribute(java.lang.String attribute) +
      Deprecated. 
      +
      Set the name of the XML element attribute + to be retrieved.
      +
      XmlElementsetXmlElement(java.lang.String xmlElement) +
      Deprecated. 
      +
      The XML element whose value, or an attribute, should be + the result of this transformation utility.
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        XmlElement

        +
        public XmlElement()
        +
        Deprecated. 
        +
        Retrieves the value of an element, + or one of its attributes, in a XML file. +
        + Note: if more than one element match + the specified XML element, the very first + one will be used
        +
        • +
      + + + +
        +
      • +

        XmlElement

        +
        public XmlElement(java.lang.String xmlElement)
        +
        Deprecated. 
        +
        Retrieves the value of an element, + or one of its attributes, in a XML file. +
        + Note: if more than one element match + the specified XML element, the very first + one will be used +
        + Specify in 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. +
        + To retrieve the value of the child name, set 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> +
        +
        +
        Parameters:
        +
        xmlElement - the XML element whose value, or an attribute, should be + the result of this transformation utility
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setXmlElement

        +
        public XmlElement setXmlElement(java.lang.String xmlElement)
        +
        Deprecated. 
        +
        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. +
        + To retrieve the value of the child name, set 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> +
        +
        +
        Parameters:
        +
        xmlElement - the XML element whose value, or an attribute, should be + the result of this transformation utility
        +
        Returns:
        +
        this instance
        +
        +
        • +
      + + + +
        +
      • +

        setAttribute

        +
        public XmlElement setAttribute(java.lang.String attribute)
        +
        Deprecated. 
        +
        Set the name of the XML element attribute + to be retrieved. If null, the element + value will be retrieved instead
        +
        +
        Parameters:
        +
        attribute - the name of the XML element attribute + to be retrieved
        +
        Returns:
        +
        this instance
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        Deprecated. 
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<XmlElement>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        Deprecated. 
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<XmlElement>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/XmlIndentation.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/XmlIndentation.html new file mode 100644 index 00000000..6c6838be --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/XmlIndentation.html @@ -0,0 +1,360 @@ + + + + + +XmlIndentation (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.xml
+

Class XmlIndentation

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class XmlIndentation
+extends com.paypal.butterfly.extensions.api.TransformationUtility<XmlIndentation>
    +
    Utility to find out indentation usage in a given XML file. + It returns a String that represents the indentation used in the very first + tag, inside the root tag, in the given XML file. + Returns TUExecutionResult.Type.NULL if the root tag has no children, + or if the first tag is at the same line as the root tag.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      XmlIndentation() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      static java.lang.StringgetFirst(java.io.File xmlFile) +
      Returns a String that represents the indentation used in the very first + tag, inside the root tag, in the given XML file.
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        XmlIndentation

        +
        public XmlIndentation()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFirst

        +
        public static java.lang.String getFirst(java.io.File xmlFile)
+                                 throws javax.xml.stream.XMLStreamException,
+                                        java.io.FileNotFoundException
        +
        Returns a String that represents the indentation used in the very first + tag, inside the root tag, in the given XML file. + Returns null if the root tag has no children, + or if the first tag is at the same line as the root tag.
        +
        +
        Parameters:
        +
        xmlFile - XML file to be evaluated
        +
        Returns:
        +
        a String that represents the indentation used in the very first tag, + inside the root tag, in the given XML file
        +
        Throws:
        +
        java.io.FileNotFoundException - if the given file does not exist
        +
        javax.xml.stream.XMLStreamException - if an error occurs when reading the XML file
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<XmlIndentation>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<XmlIndentation>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/XmlXPathRetrieve.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/XmlXPathRetrieve.html new file mode 100644 index 00000000..f37890db --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/XmlXPathRetrieve.html @@ -0,0 +1,501 @@ + + + + + +XmlXPathRetrieve (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.paypal.butterfly.utilities.xml
+

Class XmlXPathRetrieve

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable
    +
    +
    +
    +
    public class XmlXPathRetrieve
+extends com.paypal.butterfly.extensions.api.TransformationUtility<XmlXPathRetrieve>
    +
    Retrieves data from an XML file by using XPath expressions. If no element is + found, an empty string is returned if the return data type is + XPathConstants.STRING; if the return data type is + XPathConstants.NODESET, an empty node list is returned. If the XPath + expression won't compile, an error is returned.
    + If the file is not a well formed XML file, an error is returned.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +UTILITY_NAME_SYNTAX
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      XmlXPathRetrieve() +
      Retrieves data from an XML file by using XPath expressions.
      +
      XmlXPathRetrieve(java.lang.String xpathExpressionString) +
      Retrieves data from an XML file by using XPath expressions.
      +
      XmlXPathRetrieve(java.lang.String xpathExpressionString, + javax.xml.namespace.QName returnDataType) +
      Retrieves data from an XML file by using XPath expressions.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected com.paypal.butterfly.extensions.api.TUExecutionResultexecution(java.io.File transformedAppFolder, + com.paypal.butterfly.extensions.api.TransformationContext transformationContext) 
      java.lang.StringgetDescription() 
      javax.xml.namespace.QNamegetReturnDataType() +
      Returns the XPatch return type
      +
      java.lang.StringgetXPathExpressionString() +
      Return the XPath expression
      +
      voidsetReturnDataType(javax.xml.namespace.QName returnDataType) +
      Sets the XPatch return type
      +
      XmlXPathRetrievesetXPathExpression(java.lang.String xpathExpressionString) +
      The XPathExpression to be used to retrieve the data from XML file.
      +
      XmlXPathRetrievesetXPathExpression(java.lang.String xpathExpressionString, + javax.xml.namespace.QName returnDataType) +
      The XPathExpression to be used to retrieve the data from XML file.
      +
      +
        +
      • + + +

        Methods inherited from class com.paypal.butterfly.extensions.api.TransformationUtility

        +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, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        XmlXPathRetrieve

        +
        public XmlXPathRetrieve()
        +
        Retrieves data from an XML file by using XPath expressions. If no element is + found, an empty string is returned if the return data type is + XPathConstants.STRING; if the return data type is + XPathConstants.NODESET, an empty node list is returned.
        + If the XPath expression won't compile, an error is returned.
        +
        • +
      + + + +
        +
      • +

        XmlXPathRetrieve

        +
        public XmlXPathRetrieve(java.lang.String xpathExpressionString)
        +
        Retrieves data from an XML file by using XPath expressions. If no element is + found, an empty string is returned if the return data type is + XPathConstants.STRING; if the return data type is + XPathConstants.NODESET, an empty node list is returned.
        + If the XPath expression won't compile, an error is returned.
        + If the file is not a well formed XML file, an error is returned.
        +
        +
        Parameters:
        +
        xpathExpressionString - a string that compiles into a + XPathExpression
        +
        +
        • +
      + + + +
        +
      • +

        XmlXPathRetrieve

        +
        public XmlXPathRetrieve(java.lang.String xpathExpressionString,
+                        javax.xml.namespace.QName returnDataType)
        +
        Retrieves data from an XML file by using XPath expressions. If no element is + found, an empty string is returned if the return data type is + XPathConstants.STRING; if the return data type is + XPathConstants.NODESET, an empty node list is returned.
        + If the XPath expression won't compile, an error is returned.
        + If the XPath expression won't compile, an error is returned.
        + If the file is not a well formed XML file, an error is returned.
        +
        +
        Parameters:
        +
        xpathExpressionString - a string that compiles into a + XPathExpression
        +
        returnDataType - the XPath return type XPathConstants
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setXPathExpression

        +
        public XmlXPathRetrieve setXPathExpression(java.lang.String xpathExpressionString)
        +
        The XPathExpression to be used to retrieve the data from XML file.
        +
        +
        Parameters:
        +
        xpathExpressionString - a string that compiles into a + XPathExpression
        +
        Returns:
        +
        this utility instance
        +
        +
        • +
      + + + +
        +
      • +

        setXPathExpression

        +
        public XmlXPathRetrieve setXPathExpression(java.lang.String xpathExpressionString,
+                                           javax.xml.namespace.QName returnDataType)
        +
        The XPathExpression to be used to retrieve the data from XML file. + Check if value is a blank String, if it is, then a + TransformationDefinitionException is thrown.
        +
        +
        Parameters:
        +
        xpathExpressionString - a string that compiles into a + XPathExpression
        +
        returnDataType - The desired return type of the data retrieved
        +
        Returns:
        +
        this utility instance
        +
        +
        • +
      + + + +
        +
      • +

        getXPathExpressionString

        +
        public java.lang.String getXPathExpressionString()
        +
        Return the XPath expression
        +
        +
        Returns:
        +
        the XPath expression
        +
        +
        • +
      + + + +
        +
      • +

        getReturnDataType

        +
        public javax.xml.namespace.QName getReturnDataType()
        +
        Returns the XPatch return type
        +
        +
        Returns:
        +
        the returnDataType
        +
        +
        • +
      + + + +
        +
      • +

        setReturnDataType

        +
        public void setReturnDataType(javax.xml.namespace.QName returnDataType)
        +
        Sets the XPatch return type
        +
        +
        Parameters:
        +
        returnDataType - the returnDataType to set
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        +
        Specified by:
        +
        getDescription in class com.paypal.butterfly.extensions.api.TransformationUtility<XmlXPathRetrieve>
        +
        +
        • +
      + + + +
        +
      • +

        execution

        +
        protected com.paypal.butterfly.extensions.api.TUExecutionResult execution(java.io.File transformedAppFolder,
+                                                                          com.paypal.butterfly.extensions.api.TransformationContext transformationContext)
        +
        +
        Specified by:
        +
        execution in class com.paypal.butterfly.extensions.api.TransformationUtility<XmlXPathRetrieve>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/package-frame.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/package-frame.html new file mode 100644 index 00000000..6c79b9e9 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/package-frame.html @@ -0,0 +1,22 @@ + + + + + +com.paypal.butterfly.utilities.xml (butterfly-utilities 3.2.1 API) + + + + + +

com.paypal.butterfly.utilities.xml

+
+

Classes

+ +
+ + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/package-summary.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/package-summary.html new file mode 100644 index 00000000..f04232c4 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/package-summary.html @@ -0,0 +1,165 @@ + + + + + +com.paypal.butterfly.utilities.xml (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.paypal.butterfly.utilities.xml

+
+
Transformation utilities to gather meta-data about XML files.
+
+

See: Description

+
+
+ + + + +

Package com.paypal.butterfly.utilities.xml Description

+
Transformation utilities to gather meta-data about XML files.
+
+
Since:
+
1.0.0
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/package-tree.html b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/package-tree.html new file mode 100644 index 00000000..a3a37ca7 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/com/paypal/butterfly/utilities/xml/package-tree.html @@ -0,0 +1,141 @@ + + + + + +com.paypal.butterfly.utilities.xml Class Hierarchy (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.paypal.butterfly.utilities.xml

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/constant-values.html b/docs/javadocs/3.2.1/butterfly-utilities/constant-values.html new file mode 100644 index 00000000..4c3da140 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/constant-values.html @@ -0,0 +1,122 @@ + + + + + +Constant Field Values (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/deprecated-list.html b/docs/javadocs/3.2.1/butterfly-utilities/deprecated-list.html new file mode 100644 index 00000000..4301d3dd --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/deprecated-list.html @@ -0,0 +1,147 @@ + + + + + +Deprecated List (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+ +
+
+ + + +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/help-doc.html b/docs/javadocs/3.2.1/butterfly-utilities/help-doc.html new file mode 100644 index 00000000..de5b6159 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/help-doc.html @@ -0,0 +1,223 @@ + + + + + +API Help (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+ +This help file applies to API documentation generated using the standard doclet.
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/index-all.html b/docs/javadocs/3.2.1/butterfly-utilities/index-all.html new file mode 100644 index 00000000..f60679ba --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/index-all.html @@ -0,0 +1,2405 @@ + + + + + +Index (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D E F G H I J L M N O P R S T V W X  + + +

A

+
+
AbstractPomGetUtility<T extends AbstractPomGetUtility> - Class in com.paypal.butterfly.utilities.pom
+
+
Abstract class to utility class to manipulate Maven artifacts either from a pom file or a model
+
+
AbstractPomGetUtility() - Constructor for class com.paypal.butterfly.utilities.pom.AbstractPomGetUtility
+
+
Abstract class to utility class to manipulate Maven artifacts either from a pom file or a model
+
+
AbstractPomGetUtility(String) - Constructor for class com.paypal.butterfly.utilities.pom.AbstractPomGetUtility
+
+
Abstract class to utility class to manipulate Maven artifacts either from a pom file or a model
+
+
AbstractStaxArtifactPomOperation<T extends AbstractStaxArtifactPomOperation> - Class in com.paypal.butterfly.utilities.operations.pom
+
+
Abstract Artifact POM operation.
+
+
AbstractStaxArtifactPomOperation() - Constructor for class com.paypal.butterfly.utilities.operations.pom.AbstractStaxArtifactPomOperation
+
 
+
AbstractToOperation<A extends AbstractToOperation> - Class in com.paypal.butterfly.utilities.operations
+
+
Abstract "to" operation whenever a destination file path needs to be set.
+
+
AbstractToOperation(String) - Constructor for class com.paypal.butterfly.utilities.operations.AbstractToOperation
+
+
Abstract "to" operation whenever a destination file path needs to be set.
+
+
AbstractTypeCheck<T extends AbstractTypeCheck> - Class in com.paypal.butterfly.utilities.conditions.java
+
+
This abstract class is helpful in case the compilation unit has multiple types + and the condition has to be evaluated against every type.
+
+
AbstractTypeCheck(Class) - Constructor for class com.paypal.butterfly.utilities.conditions.java.AbstractTypeCheck
+
 
+
AbstractTypeCheck(String) - Constructor for class com.paypal.butterfly.utilities.conditions.java.AbstractTypeCheck
+
 
+
addAttribute(String, String) - Method in class com.paypal.butterfly.utilities.misc.RunScript
+
+
Adds a new transformation context attribute to be used in the script.
+
+
addCondition(JavaCondition) - Method in class com.paypal.butterfly.utilities.conditions.java.JavaMatch
+
+
Add a new Java condition to be evaluated against the Java class.
+
+
additionalRelativePath - Variable in class com.paypal.butterfly.utilities.operations.AbstractToOperation
+
 
+
AddLine - Class in com.paypal.butterfly.utilities.operations.text
+
+
Adds a new line to the end of a file.
+
+
AddLine() - Constructor for class com.paypal.butterfly.utilities.operations.text.AddLine
+
 
+
AddLine(String) - Constructor for class com.paypal.butterfly.utilities.operations.text.AddLine
+
+
Operation to add a new line to the end of a file.
+
+
addObject(String, Object) - Method in class com.paypal.butterfly.utilities.misc.RunScript
+
 
+
AddProperty - Class in com.paypal.butterfly.utilities.operations.properties
+
+
Adds a new property to a properties file.
+
+
AddProperty() - Constructor for class com.paypal.butterfly.utilities.operations.properties.AddProperty
+
 
+
AddProperty(String, String) - Constructor for class com.paypal.butterfly.utilities.operations.properties.AddProperty
+
+
Operation to add a new property to a properties file.
+
+
AnnotatedWith - Class in com.paypal.butterfly.utilities.conditions.java
+
+
Evaluates if the specified + Java class or interface is annotated with the + specified annotation.
+
+
AnnotatedWith(Class) - Constructor for class com.paypal.butterfly.utilities.conditions.java.AnnotatedWith
+
 
+
AnnotatedWith(String) - Constructor for class com.paypal.butterfly.utilities.conditions.java.AnnotatedWith
+
 
+
ApplyFile - Class in com.paypal.butterfly.utilities.operations.file
+
+
Applies a file, whose location is set as a URL, + into the transformed application.
+
+
ApplyFile() - Constructor for class com.paypal.butterfly.utilities.operations.file.ApplyFile
+
+
Applies a file, whose location is set as a URL, + into the transformed application.
+
+
ApplyFile(String) - Constructor for class com.paypal.butterfly.utilities.operations.file.ApplyFile
+
+
Applies a file, whose location is set as a URL, + into the transformed application.
+
+
ApplyFile(URL) - Constructor for class com.paypal.butterfly.utilities.operations.file.ApplyFile
+
+
/** + Applies a file, whose location is set as a URL, + into the transformed application.
+
+
ApplyZip - Class in com.paypal.butterfly.utilities.operations.file
+
+
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() - Constructor for class com.paypal.butterfly.utilities.operations.file.ApplyZip
+
 
+
ApplyZip(String) - Constructor for class com.paypal.butterfly.utilities.operations.file.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.
+
+
ApplyZip(URL) - Constructor for class com.paypal.butterfly.utilities.operations.file.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.
+
+
artifactId - Variable in class com.paypal.butterfly.utilities.operations.pom.AbstractStaxArtifactPomOperation
+
 
+
+ + + +

C

+
+
clone() - Method in class com.paypal.butterfly.utilities.maven.MavenGoal
+
 
+
com.paypal.butterfly.utilities.conditions - package com.paypal.butterfly.utilities.conditions
+
+
Multiple transformation utility conditions, organized by type, each one having its own subpackage.
+
+
com.paypal.butterfly.utilities.conditions.java - package com.paypal.butterfly.utilities.conditions.java
+
+
Transformation utility conditions to analyze and evaluate Java class files.
+
+
com.paypal.butterfly.utilities.conditions.pom - package com.paypal.butterfly.utilities.conditions.pom
+
+
Transformation utility conditions to analyze and evaluate Maven POM files and Maven modules.
+
+
com.paypal.butterfly.utilities.file - package com.paypal.butterfly.utilities.file
+
+
Transformation utilities to gather meta-data, find and locate files.
+
+
com.paypal.butterfly.utilities.java - package com.paypal.butterfly.utilities.java
+
+
Transformation utilities to gather meta-data about Java class files.
+
+
com.paypal.butterfly.utilities.maven - package com.paypal.butterfly.utilities.maven
+
+
Transformation utilities to gather meta-data about Maven POM files.
+
+
com.paypal.butterfly.utilities.misc - package com.paypal.butterfly.utilities.misc
+
+
Miscellaneous collection of transformation utilities.
+
+
com.paypal.butterfly.utilities.operations - package com.paypal.butterfly.utilities.operations
+
+
Multiple transformation operations, organized by type, each one having its own subpackage.
+
+
com.paypal.butterfly.utilities.operations.file - package com.paypal.butterfly.utilities.operations.file
+
+
Transformation operations to manipulate files.
+
+
com.paypal.butterfly.utilities.operations.pom - package com.paypal.butterfly.utilities.operations.pom
+
+
Transformation operations to manipulate Maven POM files.
+
+
com.paypal.butterfly.utilities.operations.properties - package com.paypal.butterfly.utilities.operations.properties
+
+
Transformation operations to manipulate properties files.
+
+
com.paypal.butterfly.utilities.operations.text - package com.paypal.butterfly.utilities.operations.text
+
+
Transformation operations to manipulate text files.
+
+
com.paypal.butterfly.utilities.operations.xml - package com.paypal.butterfly.utilities.operations.xml
+
+
Transformation operations to manipulate XML files.
+
+
com.paypal.butterfly.utilities.pom - package com.paypal.butterfly.utilities.pom
+
 
+
com.paypal.butterfly.utilities.text - package com.paypal.butterfly.utilities.text
+
+
Transformation utilities to gather meta-data about text files.
+
+
com.paypal.butterfly.utilities.xml - package com.paypal.butterfly.utilities.xml
+
+
Transformation utilities to gather meta-data about XML files.
+
+
compare(File, File) - Method in class com.paypal.butterfly.utilities.conditions.CompareFiles
+
 
+
compare(File, File) - Method in class com.paypal.butterfly.utilities.conditions.CompareXMLFiles
+
 
+
CompareFiles - Class in com.paypal.butterfly.utilities.conditions
+
+
Compares two files and returns true if the content of the files are equal, + or if they both don't exist.
+
+
CompareFiles() - Constructor for class com.paypal.butterfly.utilities.conditions.CompareFiles
+
+
Compares two files and returns true if the content of the files are equal, + or if they both don't exist.
+
+
CompareFiles(String) - Constructor for class com.paypal.butterfly.utilities.conditions.CompareFiles
+
+
Compares two files and returns true if the content of the files are equal, + or if they both don't exist.
+
+
CompareXMLFiles - Class in com.paypal.butterfly.utilities.conditions
+
+
Compares two XML files and returns true if their contents are equal, + or if both files don't exist.
+
+
CompareXMLFiles() - Constructor for class com.paypal.butterfly.utilities.conditions.CompareXMLFiles
+
+
Compares two XML files and returns true if their contents are equal, + or if both files don't exist.
+
+
CompareXMLFiles(String) - Constructor for class com.paypal.butterfly.utilities.conditions.CompareXMLFiles
+
+
Compares two XML files and returns true if their contents are equal, + or if both files don't exist.
+
+
consumeLine(String) - Method in class com.paypal.butterfly.utilities.maven.EnforcerErrorsOutputHandler
+
 
+
consumeLine(String) - Method in class com.paypal.butterfly.utilities.maven.GenericErrorsOutputHandler
+
 
+
copy() - Method in class com.paypal.butterfly.utilities.maven.EnforcerErrorsOutputHandler
+
 
+
copy() - Method in class com.paypal.butterfly.utilities.maven.GenericErrorsOutputHandler
+
 
+
copy() - Method in interface com.paypal.butterfly.utilities.maven.MavenInvocationOutputHandler
+
+
Returns a copy of this object, but with its internal state reset, + so it can be run in a brand new Maven invocation
+
+
CopyDirectory - Class in com.paypal.butterfly.utilities.operations.file
+
+
Copies the content of a directory from one location to another.
+
+
CopyDirectory() - Constructor for class com.paypal.butterfly.utilities.operations.file.CopyDirectory
+
+
Operation to copy the content of a directory from one location to another.
+
+
CopyFile - Class in com.paypal.butterfly.utilities.operations.file
+
+
Copies a file.
+
+
CopyFile() - Constructor for class com.paypal.butterfly.utilities.operations.file.CopyFile
+
+
Copies a file.
+
+
+ + + +

D

+
+
DeleteFile - Class in com.paypal.butterfly.utilities.operations.file
+
+
Deletes a single file or folder (empty or not).
+
+
DeleteFile() - Constructor for class com.paypal.butterfly.utilities.operations.file.DeleteFile
+
 
+
description - Variable in class com.paypal.butterfly.utilities.operations.AbstractToOperation
+
 
+
+ + + +

E

+
+
EnforcerErrorsOutputHandler - Class in com.paypal.butterfly.utilities.maven
+
+
Reads lines from the Maven enforcer plugin output and produces as result a set of Strings stating the validation failures, if any.
+
+
EnforcerErrorsOutputHandler() - Constructor for class com.paypal.butterfly.utilities.maven.EnforcerErrorsOutputHandler
+
 
+
equals(Object) - Method in class com.paypal.butterfly.utilities.operations.pom.AbstractStaxArtifactPomOperation
+
 
+
equals(Object) - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddModule
+
 
+
equals(Object) - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddPlugin
+
 
+
equals(Object) - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddProperty
+
 
+
equals(Object) - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePackaging
+
 
+
equals(Object) - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveDependency
+
 
+
equals(Object) - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemovePlugin
+
 
+
errorIfNoFilesFound() - Method in class com.paypal.butterfly.utilities.file.FindFiles
+
+
By default, if no files are found, an empty list is returned + and the result type is TUExecutionResult.Type#VALUE.
+
+
eval(CompilationUnit) - Method in class com.paypal.butterfly.utilities.conditions.java.AbstractTypeCheck
+
 
+
eval(CompilationUnit) - Method in class com.paypal.butterfly.utilities.conditions.java.JavaCondition
+
+
Evaluates this condition against the specified compilation + unit and returns the evaluation result.
+
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.conditions.CompareFiles
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.conditions.CompareXMLFiles
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.conditions.FileExists
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.conditions.java.JavaMatch
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.conditions.pom.PomDependencyExists
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.conditions.pom.PomHasParent
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.conditions.pom.PomJavaMatch
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.conditions.pom.PomParentMatch
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.conditions.PropertyExists
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.conditions.RegexMatch
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.conditions.XmlXPathExists
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.file.FindFile
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.file.FindFiles
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.file.LoadFile
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.file.LocateFile
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.java.JavaPackage
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.maven.MavenGoal
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.maven.RelatedArtifacts
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.misc.RunScript
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.misc.WebXmlContextParams
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.operations.file.ApplyFile
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.operations.file.ApplyZip
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.operations.file.CopyDirectory
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.operations.file.CopyFile
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.operations.file.DeleteFile
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.operations.file.MoveDirectory
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.operations.file.MoveFile
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.operations.file.RenameFile
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.operations.pom.PomFile
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.operations.properties.AddProperty
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.operations.properties.RemoveProperty
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.operations.text.AddLine
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.operations.text.InsertLine
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.operations.text.InsertText
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.operations.text.ReplaceText
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.operations.xml.XmlXPathReplace
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.pom.AbstractPomGetUtility
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.pom.PomModel
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.text.StringFormat
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.xml.XmlElement
+
+
Deprecated.
+ 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.xml.XmlIndentation
+
 
+
execution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.xml.XmlXPathRetrieve
+
 
+
Extends - Class in com.paypal.butterfly.utilities.conditions.java
+
+
Evaluates if the specified + compilation unit directly extends the + specified class.
+
+
Extends(Class) - Constructor for class com.paypal.butterfly.utilities.conditions.java.Extends
+
 
+
Extends(String) - Constructor for class com.paypal.butterfly.utilities.conditions.java.Extends
+
 
+
+ + + +

F

+
+
failIfNotFound(boolean) - Method in class com.paypal.butterfly.utilities.file.FindFile
+
 
+
failIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
 
+
failIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeParent
+
+
Deprecated.
+ 
+
failIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeParentVersion
+
 
+
failIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
 
+
failIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveDependency
+
 
+
failIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveDependencyExclusion
+
 
+
failIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveManagedDependency
+
 
+
failIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveModule
+
 
+
failIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemovePlugin
+
 
+
failIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveProperty
+
 
+
failIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomReplaceDependency
+
 
+
failIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddDependency
+
 
+
failIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddManagedDependency
+
 
+
failIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddModule
+
 
+
failIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddParent
+
 
+
failIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddPlugin
+
 
+
failIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddProperty
+
 
+
FileExists - Class in com.paypal.butterfly.utilities.conditions
+
+
Checks if a particular file or folder exists.
+
+
FileExists() - Constructor for class com.paypal.butterfly.utilities.conditions.FileExists
+
 
+
FindFile - Class in com.paypal.butterfly.utilities.file
+
+
Finds a file based on its name.
+
+
FindFile() - Constructor for class com.paypal.butterfly.utilities.file.FindFile
+
 
+
FindFile(String) - Constructor for class com.paypal.butterfly.utilities.file.FindFile
+
+
Utility to find a file based on its name
+
+
FindFiles - Class in com.paypal.butterfly.utilities.file
+
+
Finds files based on a regular expression + against the file name and/or the file path.
+
+
FindFiles() - Constructor for class com.paypal.butterfly.utilities.file.FindFiles
+
 
+
FindFiles(String, boolean) - Constructor for class com.paypal.butterfly.utilities.file.FindFiles
+
+
Utility to find files based on a regular expression + against the file name.
+
+
FindFiles(String, boolean, boolean, boolean) - Constructor for class com.paypal.butterfly.utilities.file.FindFiles
+
+
Utility to find files based on a regular expression + against the file name.
+
+
FindFiles(String, String) - Constructor for class com.paypal.butterfly.utilities.file.FindFiles
+
+
Utility to find files based on a regular expression + against the file name and the file path.
+
+
+ + + +

G

+
+
GenericErrorsOutputHandler - Class in com.paypal.butterfly.utilities.maven
+
+
Reads lines from the Maven execution output and produces as result a String stating the errors, if any.
+
+
GenericErrorsOutputHandler() - Constructor for class com.paypal.butterfly.utilities.maven.GenericErrorsOutputHandler
+
 
+
getArtifactId() - Method in class com.paypal.butterfly.utilities.conditions.pom.PomDependencyExists
+
 
+
getArtifactId() - Method in class com.paypal.butterfly.utilities.conditions.pom.PomParentMatch
+
 
+
getArtifactId() - Method in class com.paypal.butterfly.utilities.operations.pom.AbstractStaxArtifactPomOperation
+
 
+
getArtifactId() - Method in class com.paypal.butterfly.utilities.pom.PomModel
+
 
+
getAttribute() - Method in class com.paypal.butterfly.utilities.operations.pom.PomFile
+
+
Returns the name of the transformation context attribute holding the Model object
+
+
getAttributeNames() - Method in class com.paypal.butterfly.utilities.text.StringFormat
+
 
+
getAttributes() - Method in class com.paypal.butterfly.utilities.misc.RunScript
+
 
+
getConditions() - Method in class com.paypal.butterfly.utilities.conditions.java.JavaMatch
+
+
Returns the set of Java conditions to be used to + evaluate the specified class.
+
+
getDescription() - Method in class com.paypal.butterfly.utilities.conditions.CompareFiles
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.conditions.CompareXMLFiles
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.conditions.FileExists
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.conditions.java.JavaMatch
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.conditions.pom.PomDependencyExists
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.conditions.pom.PomHasParent
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.conditions.pom.PomJavaMatch
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.conditions.pom.PomParentMatch
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.conditions.PropertyExists
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.conditions.RegexMatch
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.conditions.XmlXPathExists
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.file.FindFile
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.file.FindFiles
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.file.LoadFile
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.file.LocateFile
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.java.JavaPackage
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.maven.MavenGoal
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.maven.RelatedArtifacts
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.misc.RunScript
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.misc.WebXmlContextParams
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.AbstractToOperation
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.file.ApplyFile
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.file.ApplyZip
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.file.DeleteFile
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.file.RenameFile
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddDependency
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddManagedDependency
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddModule
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddParent
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddPlugin
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddProperty
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePackaging
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeParent
+
+
Deprecated.
+ 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeParentVersion
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.pom.PomFile
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveDependency
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveDependencyExclusion
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveManagedDependency
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveModule
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemovePlugin
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveProperty
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.pom.PomReplaceDependency
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.properties.AddProperty
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.properties.RemoveProperty
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.text.AddLine
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.text.InsertLine
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.text.InsertText
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.text.RemoveLine
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.text.ReplaceLine
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.text.ReplaceText
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.operations.xml.XmlXPathReplace
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.pom.PomGetPackaging
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.pom.PomGetParent
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.pom.PomModel
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.text.StringFormat
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.xml.XmlElement
+
+
Deprecated.
+ 
+
getDescription() - Method in class com.paypal.butterfly.utilities.xml.XmlIndentation
+
 
+
getDescription() - Method in class com.paypal.butterfly.utilities.xml.XmlXPathRetrieve
+
 
+
getExecutions() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
 
+
getExtensions() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
 
+
getFileName() - Method in class com.paypal.butterfly.utilities.file.FindFile
+
 
+
getFileTo(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.operations.AbstractToOperation
+
 
+
getFileUrl() - Method in class com.paypal.butterfly.utilities.operations.file.ApplyFile
+
+
Returns the URL to locate the file to be applied
+
+
getFirst(File) - Static method in class com.paypal.butterfly.utilities.xml.XmlIndentation
+
+
Returns a String that represents the indentation used in the very first + tag, inside the root tag, in the given XML file.
+
+
getFormat() - Method in class com.paypal.butterfly.utilities.text.StringFormat
+
 
+
getGoals() - Method in class com.paypal.butterfly.utilities.maven.MavenGoal
+
+
Return the Maven goals to be executed
+
+
getGroupId() - Method in class com.paypal.butterfly.utilities.conditions.pom.PomDependencyExists
+
 
+
getGroupId() - Method in class com.paypal.butterfly.utilities.conditions.pom.PomParentMatch
+
 
+
getGroupId() - Method in class com.paypal.butterfly.utilities.operations.pom.AbstractStaxArtifactPomOperation
+
 
+
getGroupId() - Method in class com.paypal.butterfly.utilities.pom.PomModel
+
 
+
getLanguage() - Method in class com.paypal.butterfly.utilities.misc.RunScript
+
 
+
getModel() - Method in class com.paypal.butterfly.utilities.operations.pom.PomFile
+
+
Returns the Model object used to write the pom.xml file
+
+
getModelAttributeName() - Method in class com.paypal.butterfly.utilities.pom.AbstractPomGetUtility
+
+
Returns the name of the context attribute containing the Maven Model object
+
+
getModuleName() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddModule
+
+
Return the name of the module to be set by this operation
+
+
getModuleName() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveModule
+
 
+
getNameRegex() - Method in class com.paypal.butterfly.utilities.file.FindFiles
+
+
Returns the file name regular expression
+
+
getNewArtifactId() - Method in class com.paypal.butterfly.utilities.operations.pom.PomReplaceDependency
+
 
+
getNewGroupId() - Method in class com.paypal.butterfly.utilities.operations.pom.PomReplaceDependency
+
 
+
getNewLine() - Method in class com.paypal.butterfly.utilities.operations.text.AddLine
+
 
+
getNewName() - Method in class com.paypal.butterfly.utilities.operations.file.RenameFile
+
 
+
getNewScope() - Method in class com.paypal.butterfly.utilities.operations.pom.PomReplaceDependency
+
 
+
getNewVersion() - Method in class com.paypal.butterfly.utilities.operations.pom.PomReplaceDependency
+
 
+
getNumberOfTypes(CompilationUnit) - Method in class com.paypal.butterfly.utilities.conditions.java.AbstractTypeCheck
+
 
+
getNumberOfTypes(CompilationUnit) - Method in class com.paypal.butterfly.utilities.conditions.java.AnnotatedWith
+
 
+
getNumberOfTypes(CompilationUnit) - Method in class com.paypal.butterfly.utilities.conditions.java.Extends
+
 
+
getObjects() - Method in class com.paypal.butterfly.utilities.misc.RunScript
+
 
+
getOutputHandlers() - Method in class com.paypal.butterfly.utilities.maven.MavenGoal
+
+
Return the output handlers to be executed against the Maven goals execution result
+
+
getPackageInfo() - Method in class com.paypal.butterfly.utilities.conditions.java.JavaMatch
+
+
Returns the current boolean status of packageInfo.
+
+
getPackagingType() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePackaging
+
 
+
getParentArtifactId() - Method in class com.paypal.butterfly.utilities.maven.RelatedArtifacts
+
 
+
getParentGroupId() - Method in class com.paypal.butterfly.utilities.maven.RelatedArtifacts
+
 
+
getParentLevel() - Method in class com.paypal.butterfly.utilities.file.LocateFile
+
 
+
getParentVersion() - Method in class com.paypal.butterfly.utilities.maven.RelatedArtifacts
+
 
+
getPathRegex() - Method in class com.paypal.butterfly.utilities.file.FindFiles
+
+
Returns the file path regular expression
+
+
getPluginDependencies() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
 
+
getPomFilesAttribute() - Method in class com.paypal.butterfly.utilities.maven.RelatedArtifacts
+
 
+
getProperties() - Method in class com.paypal.butterfly.utilities.maven.MavenGoal
+
+
Return the Maven properties for the goal
+
+
getPropertyName() - Method in class com.paypal.butterfly.utilities.conditions.PropertyExists
+
 
+
getPropertyName() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddProperty
+
+
Return the name of the property to be set by this operation
+
+
getPropertyName() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveProperty
+
 
+
getPropertyName() - Method in class com.paypal.butterfly.utilities.operations.properties.AddProperty
+
 
+
getPropertyName() - Method in class com.paypal.butterfly.utilities.operations.properties.RemoveProperty
+
 
+
getPropertyNameRegex() - Method in class com.paypal.butterfly.utilities.conditions.PropertyExists
+
 
+
getPropertyValue() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddProperty
+
+
Returns the value of the property to be set by this operation
+
+
getPropertyValue() - Method in class com.paypal.butterfly.utilities.operations.properties.AddProperty
+
 
+
getRegex() - Method in class com.paypal.butterfly.utilities.conditions.pom.PomJavaMatch
+
+
Returns the regular expression to be evaluated against Java classes under given Maven module
+
+
getRegex() - Method in class com.paypal.butterfly.utilities.conditions.RegexMatch
+
+
Returns the regular expression to be evaluated against the specified text file
+
+
getRegex() - Method in class com.paypal.butterfly.utilities.operations.text.ReplaceText
+
 
+
getReplacement() - Method in class com.paypal.butterfly.utilities.operations.text.ReplaceLine
+
 
+
getReplacement() - Method in class com.paypal.butterfly.utilities.operations.text.ReplaceText
+
 
+
getRepoURI() - Method in class com.paypal.butterfly.utilities.pom.PomModel
+
 
+
getResource() - Method in class com.paypal.butterfly.utilities.file.LoadFile
+
+
Returns the name of the resource in the classpath
+
+
getResult() - Method in class com.paypal.butterfly.utilities.maven.EnforcerErrorsOutputHandler
+
 
+
getResult() - Method in class com.paypal.butterfly.utilities.maven.GenericErrorsOutputHandler
+
 
+
getResult() - Method in interface com.paypal.butterfly.utilities.maven.MavenInvocationOutputHandler
+
+
Returns the desired result from parsing the console output
+
+
getReturnDataType() - Method in class com.paypal.butterfly.utilities.xml.XmlXPathRetrieve
+
+
Returns the XPatch return type
+
+
getScope() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddDependency
+
 
+
getScope() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddManagedDependency
+
 
+
getScope() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
 
+
getScript() - Method in class com.paypal.butterfly.utilities.misc.RunScript
+
 
+
getToAbsoluteAttribute() - Method in class com.paypal.butterfly.utilities.operations.AbstractToOperation
+
 
+
getToRelative() - Method in class com.paypal.butterfly.utilities.operations.AbstractToOperation
+
 
+
getType() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddManagedDependency
+
 
+
getType() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
 
+
getTypeName(CompilationUnit, int) - Method in class com.paypal.butterfly.utilities.conditions.java.AbstractTypeCheck
+
 
+
getTypeName(CompilationUnit, int) - Method in class com.paypal.butterfly.utilities.conditions.java.AnnotatedWith
+
 
+
getTypeName(CompilationUnit, int) - Method in class com.paypal.butterfly.utilities.conditions.java.Extends
+
 
+
getVersion() - Method in class com.paypal.butterfly.utilities.conditions.pom.PomDependencyExists
+
 
+
getVersion() - Method in class com.paypal.butterfly.utilities.conditions.pom.PomParentMatch
+
 
+
getVersion() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddDependency
+
 
+
getVersion() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddManagedDependency
+
 
+
getVersion() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddParent
+
 
+
getVersion() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddPlugin
+
 
+
getVersion() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
 
+
getVersion() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeParent
+
+
Deprecated.
+ 
+
getVersion() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeParentVersion
+
 
+
getVersion() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
 
+
getVersion() - Method in class com.paypal.butterfly.utilities.pom.PomModel
+
 
+
getXPathExpressionString() - Method in class com.paypal.butterfly.utilities.conditions.XmlXPathExists
+
+
Return the XPath expression
+
+
getXPathExpressionString() - Method in class com.paypal.butterfly.utilities.xml.XmlXPathRetrieve
+
+
Return the XPath expression
+
+
getZipFileUrl() - Method in class com.paypal.butterfly.utilities.operations.file.ApplyZip
+
 
+
groupId - Variable in class com.paypal.butterfly.utilities.operations.pom.AbstractStaxArtifactPomOperation
+
 
+
+ + + +

H

+
+
hashCode() - Method in class com.paypal.butterfly.utilities.operations.pom.AbstractStaxArtifactPomOperation
+
 
+
hashCode() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddModule
+
 
+
hashCode() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddPlugin
+
 
+
hashCode() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddProperty
+
 
+
hashCode() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePackaging
+
 
+
hashCode() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveDependency
+
 
+
hashCode() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemovePlugin
+
 
+
+ + + +

I

+
+
InsertLine - Class in com.paypal.butterfly.utilities.operations.text
+
+
Inserts new line(s) into a text file.
+
+
InsertLine() - Constructor for class com.paypal.butterfly.utilities.operations.text.InsertLine
+
+
Operation to insert new line(s) into a text file.
+
+
InsertLine(String) - Constructor for class com.paypal.butterfly.utilities.operations.text.InsertLine
+
+
Operation to insert a new line into a text file.
+
+
InsertLine(String, Integer) - Constructor for class com.paypal.butterfly.utilities.operations.text.InsertLine
+
+
Operation to insert a new line into a text file.
+
+
InsertLine(String, String) - Constructor for class com.paypal.butterfly.utilities.operations.text.InsertLine
+
+
Operation to insert a new line into a text file.
+
+
InsertLine.InsertionMode - Enum in com.paypal.butterfly.utilities.operations.text
+
+
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 - Class in com.paypal.butterfly.utilities.operations.text
+
+
Inserts text from one file into another text file.
+
+
InsertText() - Constructor for class com.paypal.butterfly.utilities.operations.text.InsertText
+
+
Operation to insert text into another text file.
+
+
InsertText(URL) - Constructor for class com.paypal.butterfly.utilities.operations.text.InsertText
+
+
Operation to insert text into another text file.
+
+
InsertText(URL, Integer) - Constructor for class com.paypal.butterfly.utilities.operations.text.InsertText
+
+
Operation to insert text into another text file.
+
+
InsertText(URL, String) - Constructor for class com.paypal.butterfly.utilities.operations.text.InsertText
+
+
Operation to insert text into another text file.
+
+
InsertText.InsertionMode - Enum in com.paypal.butterfly.utilities.operations.text
+
+
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 +
+
+
isFailIfNotFound() - Method in class com.paypal.butterfly.utilities.file.FindFile
+
 
+
isFirstOnly() - Method in class com.paypal.butterfly.utilities.operations.text.ReplaceText
+
 
+
isIncludeFiles() - Method in class com.paypal.butterfly.utilities.file.FindFiles
+
+
Returns whether files should be included in the search or not
+
+
isIncludeFolders() - Method in class com.paypal.butterfly.utilities.file.FindFiles
+
+
Returns whether folders should be included in the search or not
+
+
isNegate() - Method in class com.paypal.butterfly.utilities.conditions.java.JavaCondition
+
+
Returns whether the evaluation result will be negated + or not.
+
+
isOptional() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
 
+
isRecursive() - Method in class com.paypal.butterfly.utilities.file.FindFiles
+
+
Returns whether the file search is recursive or not
+
+
isRemoveExecutions() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
 
+
isRemoveExtensions() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
 
+
isRemoveOptional() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
 
+
isRemovePluginDependencies() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
 
+
isRemoveScope() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
 
+
isRemoveType() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
 
+
isRemoveVersion() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
 
+
isRemoveVersion() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
 
+
+ + + +

J

+
+
JavaCondition<T extends JavaCondition> - Class in com.paypal.butterfly.utilities.conditions.java
+
+
Abstract class to specify a condition to be + evaluated against a Java class, which is + represented as a CompilationUnit.
+
+
JavaCondition() - Constructor for class com.paypal.butterfly.utilities.conditions.java.JavaCondition
+
 
+
JavaMatch - Class in com.paypal.butterfly.utilities.conditions.java
+
+
Parses and evaluates the specified Java class file + based on a set of JavaCondition.
+
+
JavaMatch() - Constructor for class com.paypal.butterfly.utilities.conditions.java.JavaMatch
+
+
This utility parses and evaluates the specified Java class file + based on a set of JavaCondition.
+
+
JavaMatch(JavaCondition) - Constructor for class com.paypal.butterfly.utilities.conditions.java.JavaMatch
+
+
This utility parses and evaluates the specified Java class file + based on a set of JavaCondition.
+
+
JavaPackage - Class in com.paypal.butterfly.utilities.java
+
+
Retrieves the package + of a given Java class.
+
+
JavaPackage() - Constructor for class com.paypal.butterfly.utilities.java.JavaPackage
+
 
+
+ + + +

L

+
+
LoadFile - Class in com.paypal.butterfly.utilities.file
+
+
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() - Constructor for class com.paypal.butterfly.utilities.file.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) - Constructor for class com.paypal.butterfly.utilities.file.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 - Class in com.paypal.butterfly.utilities.file
+
+
Locates a file based on the relative or absolute + location specified.
+
+
LocateFile() - Constructor for class com.paypal.butterfly.utilities.file.LocateFile
+
+
Locates a file based on the relative or absolute + location specified.
+
+
LocateFile(int) - Constructor for class com.paypal.butterfly.utilities.file.LocateFile
+
+
Locates a file based on the relative or absolute + location specified.
+
+
+ + + +

M

+
+
manipulateLine(String, Writer) - Method in class com.paypal.butterfly.utilities.operations.text.RemoveLine
+
 
+
manipulateLine(String, Writer) - Method in class com.paypal.butterfly.utilities.operations.text.ReplaceLine
+
 
+
MavenGoal - Class in com.paypal.butterfly.utilities.maven
+
+
Runs one or more Maven goals against a specific Maven POM file or a directory.
+
+
MavenGoal() - Constructor for class com.paypal.butterfly.utilities.maven.MavenGoal
+
+
Runs one or more Maven goals against a specific Maven POM file or a directory.
+
+
MavenGoal(String...) - Constructor for class com.paypal.butterfly.utilities.maven.MavenGoal
+
+
Runs one or more Maven goals against a specific Maven POM file or a directory.
+
+
MavenGoal(String[], MavenInvocationOutputHandler[]) - Constructor for class com.paypal.butterfly.utilities.maven.MavenGoal
+
+
Runs one or more Maven goals against a specific Maven POM file or a directory.
+
+
MavenInvocationOutputHandler<T,R> - Interface in com.paypal.butterfly.utilities.maven
+
+
Reads lines from the Maven execution console output and return data after evaluating it.
+
+
MoveDirectory - Class in com.paypal.butterfly.utilities.operations.file
+
+
Moves a directory and its content from one location to another.
+
+
MoveDirectory() - Constructor for class com.paypal.butterfly.utilities.operations.file.MoveDirectory
+
+
Moves a directory and its content from one location to another.
+
+
MoveFile - Class in com.paypal.butterfly.utilities.operations.file
+
+
Moves a file.
+
+
MoveFile() - Constructor for class com.paypal.butterfly.utilities.operations.file.MoveFile
+
+
Moves a file.
+
+
+ + + +

N

+
+
noOpIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
 
+
noOpIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeParent
+
+
Deprecated.
+ 
+
noOpIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeParentVersion
+
 
+
noOpIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
 
+
noOpIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveDependency
+
 
+
noOpIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveDependencyExclusion
+
 
+
noOpIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveManagedDependency
+
 
+
noOpIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveModule
+
 
+
noOpIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemovePlugin
+
 
+
noOpIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveProperty
+
 
+
noOpIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomReplaceDependency
+
 
+
noOpIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddDependency
+
 
+
noOpIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddManagedDependency
+
 
+
noOpIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddModule
+
 
+
noOpIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddParent
+
 
+
noOpIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddPlugin
+
 
+
noOpIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddProperty
+
 
+
+ + + +

O

+
+
overwriteIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddDependency
+
 
+
overwriteIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddManagedDependency
+
 
+
overwriteIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddModule
+
 
+
overwriteIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddParent
+
 
+
overwriteIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddPlugin
+
 
+
overwriteIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddProperty
+
 
+
+ + + +

P

+
+
PomAddDependency - Class in com.paypal.butterfly.utilities.operations.pom
+
+
Adds a new dependency to a POM file.
+
+
PomAddDependency() - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomAddDependency
+
 
+
PomAddDependency(String, String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomAddDependency
+
+
Operation to add a new dependency to a POM file.
+
+
PomAddDependency(String, String, String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomAddDependency
+
+
Operation to add a new dependency to a POM file.
+
+
PomAddDependency(String, String, String, String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomAddDependency
+
+
Operation to add a new dependency to a POM file.
+
+
PomAddManagedDependency - Class in com.paypal.butterfly.utilities.operations.pom
+
+
Adds a new managed dependency to a POM file.
+
+
PomAddManagedDependency() - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomAddManagedDependency
+
+
Operation to add a new managed dependency to a POM file.
+
+
PomAddManagedDependency(String, String, String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomAddManagedDependency
+
+
Operation to add a new managed dependency to a POM file.
+
+
PomAddManagedDependency(String, String, String, String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomAddManagedDependency
+
+
Operation to add a new managed dependency to a POM file.
+
+
PomAddModule - Class in com.paypal.butterfly.utilities.operations.pom
+
+
Adds a new module to a POM file.
+
+
PomAddModule() - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomAddModule
+
+
Adds a new module to a POM file.
+
+
PomAddModule(String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomAddModule
+
+
Adds a new module to a POM file.
+
+
PomAddParent - Class in com.paypal.butterfly.utilities.operations.pom
+
+
Add a parent artifact in a Maven POM file.
+
+
PomAddParent() - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomAddParent
+
+
Add a parent artifact in a Maven POM file.
+
+
PomAddParent(String, String, String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomAddParent
+
+
Operation to add a parent artifact in a Maven POM file
+
+
PomAddPlugin - Class in com.paypal.butterfly.utilities.operations.pom
+
+
Adds a new plugin to a POM file.
+
+
PomAddPlugin() - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomAddPlugin
+
 
+
PomAddPlugin(String, String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomAddPlugin
+
+
Operation to add a new plugin to a POM file.
+
+
PomAddPlugin(String, String, String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomAddPlugin
+
+
Operation to add a new plugin to a POM file.
+
+
PomAddProperty - Class in com.paypal.butterfly.utilities.operations.pom
+
+
Adds a new property to a POM file.
+
+
PomAddProperty() - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomAddProperty
+
+
Adds a new property to a POM file.
+
+
PomAddProperty(String, String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomAddProperty
+
+
Adds a new property to a POM file.
+
+
PomChangeDependency - Class in com.paypal.butterfly.utilities.operations.pom
+
+
Changes a dependency in a Maven POM file.
+
+
PomChangeDependency() - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
 
+
PomChangeDependency(String, String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
+
Operation to change a dependency in a Maven POM file.
+
+
PomChangePackaging - Class in com.paypal.butterfly.utilities.operations.pom
+
+
Changes the packaging of a Maven artifact, by changing its POM file.
+
+
PomChangePackaging() - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomChangePackaging
+
 
+
PomChangePackaging(String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomChangePackaging
+
+
Operation to change the packaging of a Maven artifact, by changing its POM file
+
+
PomChangeParent - Class in com.paypal.butterfly.utilities.operations.pom
+
+
Deprecated.
+
+
PomChangeParent() - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomChangeParent
+
+
Deprecated.
+ 
+
PomChangeParent(String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomChangeParent
+
+
Deprecated.
+
Operation to change the parent, or its version, in a Maven POM file
+
+
PomChangeParent(String, String, String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomChangeParent
+
+
Deprecated.
+
Operation to change the parent, or its version, in a Maven POM file
+
+
PomChangeParentVersion - Class in com.paypal.butterfly.utilities.operations.pom
+
+
Changes the parent's version in a Maven POM file.
+
+
PomChangeParentVersion() - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomChangeParentVersion
+
 
+
PomChangeParentVersion(String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomChangeParentVersion
+
+
Operation to change the parent, or its version, in a Maven POM file
+
+
PomChangePlugin - Class in com.paypal.butterfly.utilities.operations.pom
+
+
Changes a Plugin in a Maven POM file.
+
+
PomChangePlugin() - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
 
+
PomChangePlugin(String, String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
+
Operation to change a plugin in a Maven POM file.
+
+
PomCopyDependencies - Class in com.paypal.butterfly.utilities.operations.pom
+
+
Copies dependencies from a POM file to another.
+
+
PomCopyDependencies() - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomCopyDependencies
+
 
+
PomCopyManagedDependencies - Class in com.paypal.butterfly.utilities.operations.pom
+
+
Copies managed dependencies from a POM file to another.
+
+
PomCopyManagedDependencies() - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomCopyManagedDependencies
+
 
+
PomDependencyExists - Class in com.paypal.butterfly.utilities.conditions.pom
+
+
Checks if a particular Maven dependency exists in a Maven pom file.
+
+
PomDependencyExists() - Constructor for class com.paypal.butterfly.utilities.conditions.pom.PomDependencyExists
+
 
+
PomDependencyExists(String, String) - Constructor for class com.paypal.butterfly.utilities.conditions.pom.PomDependencyExists
+
+
Condition to check if a particular Maven dependency exists in a Maven pom files.
+
+
PomDependencyExists(String, String, String) - Constructor for class com.paypal.butterfly.utilities.conditions.pom.PomDependencyExists
+
+
Condition to check if a particular Maven dependency exists in a Maven pom files.
+
+
pomExecution(String, Model) - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddDependency
+
 
+
pomExecution(String, Model) - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddManagedDependency
+
 
+
pomExecution(String, Model) - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddModule
+
 
+
pomExecution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddParent
+
 
+
pomExecution(String, Model) - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddPlugin
+
 
+
pomExecution(String, Model) - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddProperty
+
 
+
pomExecution(String, Model) - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
 
+
pomExecution(String, Model) - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePackaging
+
 
+
pomExecution(String, Model) - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeParent
+
+
Deprecated.
+ 
+
pomExecution(File, TransformationContext) - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeParentVersion
+
 
+
pomExecution(String, Model) - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
 
+
pomExecution(String, Model) - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveDependency
+
 
+
pomExecution(String, Model) - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveDependencyExclusion
+
 
+
pomExecution(String, Model) - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveManagedDependency
+
 
+
pomExecution(String, Model) - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveModule
+
 
+
pomExecution(String, Model) - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemovePlugin
+
 
+
pomExecution(String, Model) - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveProperty
+
 
+
pomExecution(String, Model) - Method in class com.paypal.butterfly.utilities.operations.pom.PomReplaceDependency
+
 
+
pomExecution(Model) - Method in class com.paypal.butterfly.utilities.pom.AbstractPomGetUtility
+
 
+
pomExecution(Model) - Method in class com.paypal.butterfly.utilities.pom.PomGetPackaging
+
 
+
pomExecution(Model) - Method in class com.paypal.butterfly.utilities.pom.PomGetParent
+
 
+
PomFile - Class in com.paypal.butterfly.utilities.operations.pom
+
+
Creates, or overwrites, a pom.xml file given a Model object.
+
+
PomFile() - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomFile
+
+
Creates, or overwrites, a pom.xml file given a Model object.
+
+
PomFile(String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomFile
+
+
Creates, or overwrites, a pom.xml file given a Model object.
+
+
PomFile(Model) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomFile
+
+
Creates, or overwrites, a pom.xml file given a Model object.
+
+
PomGetPackaging - Class in com.paypal.butterfly.utilities.pom
+
+
Retrieve the packaging of specified Maven artifact.
+
+
PomGetPackaging() - Constructor for class com.paypal.butterfly.utilities.pom.PomGetPackaging
+
+
Retrieve the packaging of specified Maven artifact.
+
+
PomGetPackaging(String) - Constructor for class com.paypal.butterfly.utilities.pom.PomGetPackaging
+
+
Retrieve the packaging of specified Maven artifact.
+
+
PomGetParent - Class in com.paypal.butterfly.utilities.pom
+
+
Retrieve the Maven coordinates (group id, artifact id and version) of the parent of specified Maven artifact.
+
+
PomGetParent() - Constructor for class com.paypal.butterfly.utilities.pom.PomGetParent
+
+
Retrieve the Maven coordinates (group id, artifact id and version) of the parent of specified Maven artifact.
+
+
PomGetParent(String) - Constructor for class com.paypal.butterfly.utilities.pom.PomGetParent
+
+
Retrieve the Maven coordinates (group id, artifact id and version) of the parent of specified Maven artifact.
+
+
PomHasParent - Class in com.paypal.butterfly.utilities.conditions.pom
+
+
Checks if a parent POM exists in a Maven POM file.
+
+
PomHasParent() - Constructor for class com.paypal.butterfly.utilities.conditions.pom.PomHasParent
+
+
Default Constructor
+
+
PomJavaMatch - Class in com.paypal.butterfly.utilities.conditions.pom
+
+
Checks if a Maven module has at least one Java class + that matches a given regular expression.
+
+
PomJavaMatch() - Constructor for class com.paypal.butterfly.utilities.conditions.pom.PomJavaMatch
+
+
Checks if a Maven module has at least one Java class + that matches a given regular expression.
+
+
PomJavaMatch(String) - Constructor for class com.paypal.butterfly.utilities.conditions.pom.PomJavaMatch
+
+
Checks if a Maven module has at least one Java class + that matches a given regular expression.
+
+
PomModel - Class in com.paypal.butterfly.utilities.pom
+
+
Load a Maven artifact, model it and place it in transformation context.
+
+
PomModel() - Constructor for class com.paypal.butterfly.utilities.pom.PomModel
+
+
Download a Maven artifact, model it and place it in transformation context.
+
+
PomModel(String, String, String) - Constructor for class com.paypal.butterfly.utilities.pom.PomModel
+
+
Download a Maven artifact, model it and place it in transformation context.
+
+
PomModel(String, String, String, String) - Constructor for class com.paypal.butterfly.utilities.pom.PomModel
+
+
Download a Maven artifact, model it and place it in transformation context.
+
+
PomParentMatch - Class in com.paypal.butterfly.utilities.conditions.pom
+
+
Checks if a Maven POM file has a parent artifact and it matches the specified groupId, artifactId and version.
+
+
PomParentMatch() - Constructor for class com.paypal.butterfly.utilities.conditions.pom.PomParentMatch
+
 
+
PomParentMatch(String, String) - Constructor for class com.paypal.butterfly.utilities.conditions.pom.PomParentMatch
+
+
Condition to check if a Maven POM file has a parent artifact and it matches the specified groupId, artifactId and version.
+
+
PomParentMatch(String, String, String) - Constructor for class com.paypal.butterfly.utilities.conditions.pom.PomParentMatch
+
+
if a Maven POM file has a parent artifact and it matches the specified groupId, artifactId and version.
+
+
PomRemoveDependency - Class in com.paypal.butterfly.utilities.operations.pom
+
+
Removes a dependency entry from a POM file.
+
+
PomRemoveDependency() - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomRemoveDependency
+
 
+
PomRemoveDependency(String, String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomRemoveDependency
+
+
Operation to remove a dependency entry from a POM file
+
+
PomRemoveDependencyExclusion - Class in com.paypal.butterfly.utilities.operations.pom
+
+
Removes an exclusion from a dependency in a POM file.
+
+
PomRemoveDependencyExclusion() - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomRemoveDependencyExclusion
+
 
+
PomRemoveDependencyExclusion(String, String, String, String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomRemoveDependencyExclusion
+
+
Operation to remove an exclusion from a dependency in a POM file.
+
+
PomRemoveManagedDependency - Class in com.paypal.butterfly.utilities.operations.pom
+
+
Removes a managed dependency entry from a POM file.
+
+
PomRemoveManagedDependency() - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomRemoveManagedDependency
+
 
+
PomRemoveManagedDependency(String, String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomRemoveManagedDependency
+
+
Operation to remove a managed dependency entry from a POM file
+
+
PomRemoveModule - Class in com.paypal.butterfly.utilities.operations.pom
+
+
Removes a module entry from a POM file.
+
+
PomRemoveModule() - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomRemoveModule
+
+
Removes a module entry from a POM file.
+
+
PomRemoveModule(String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomRemoveModule
+
+
Removes a module entry from a POM file.
+
+
PomRemovePlugin - Class in com.paypal.butterfly.utilities.operations.pom
+
+
Removes a plugin entry from a POM file.
+
+
PomRemovePlugin() - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomRemovePlugin
+
 
+
PomRemovePlugin(String, String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomRemovePlugin
+
+
Operation to remove a plugin entry from a POM file
+
+
PomRemoveProperty - Class in com.paypal.butterfly.utilities.operations.pom
+
+
Removes a property entry from a POM file.
+
+
PomRemoveProperty() - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomRemoveProperty
+
 
+
PomRemoveProperty(String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomRemoveProperty
+
+
Operation to remove a property entry from a properties file
+
+
PomReplaceDependency - Class in com.paypal.butterfly.utilities.operations.pom
+
+
Replaces a dependency by another one in a POM file.
+
+
PomReplaceDependency() - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomReplaceDependency
+
 
+
PomReplaceDependency(String, String, String, String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomReplaceDependency
+
+
Operation to replace a dependency by another one in a POM file
+
+
PomReplaceDependency(String, String, String, String, String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomReplaceDependency
+
+
Operation to replace a dependency by another one in a POM file
+
+
PomReplaceDependency(String, String, String, String, String, String) - Constructor for class com.paypal.butterfly.utilities.operations.pom.PomReplaceDependency
+
+
Operation to replace a dependency by another one in a POM file
+
+
PropertyExists - Class in com.paypal.butterfly.utilities.conditions
+
+
Checks if a particular property exists in a property file.
+
+
PropertyExists() - Constructor for class com.paypal.butterfly.utilities.conditions.PropertyExists
+
+
Checks if a particular property exists in a property file.
+
+
PropertyExists(String) - Constructor for class com.paypal.butterfly.utilities.conditions.PropertyExists
+
+
Checks if a particular property exists in a property file.
+
+
+ + + +

R

+
+
RegexMatch - Class in com.paypal.butterfly.utilities.conditions
+
+
Checks if a regular expression matches any line in the specified text file.
+
+
RegexMatch() - Constructor for class com.paypal.butterfly.utilities.conditions.RegexMatch
+
+
Checks if a regular expression matches any line in the specified text file.
+
+
RegexMatch(String) - Constructor for class com.paypal.butterfly.utilities.conditions.RegexMatch
+
+
Checks if a regular expression matches any line in the specified text file.
+
+
RelatedArtifacts - Class in com.paypal.butterfly.utilities.maven
+
+
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.
+
+
RelatedArtifacts() - Constructor for class com.paypal.butterfly.utilities.maven.RelatedArtifacts
+
 
+
RelatedArtifacts(String, String, String, String) - Constructor for class com.paypal.butterfly.utilities.maven.RelatedArtifacts
+
+
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.
+
+
removeDependencies() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
+
Operation to remove dependencies of the plugin.
+
+
removeExecutions() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
+
Operation to remove executions of the plugin.
+
+
removeExtensions() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
+
Operation to remove extensions of the plugin.
+
+
RemoveLine - Class in com.paypal.butterfly.utilities.operations.text
+
+
Removes one, or more, lines from a text file.
+
+
RemoveLine() - Constructor for class com.paypal.butterfly.utilities.operations.text.RemoveLine
+
+
Operation to remove one, or more, lines from a text file.
+
+
RemoveLine(String) - Constructor for class com.paypal.butterfly.utilities.operations.text.RemoveLine
+
+
Operation to remove one, or more, lines from a text file.
+
+
RemoveLine(String, boolean) - Constructor for class com.paypal.butterfly.utilities.operations.text.RemoveLine
+
+
Operation to remove one, or more, lines from a text file.
+
+
RemoveLine(Integer) - Constructor for class com.paypal.butterfly.utilities.operations.text.RemoveLine
+
+
Operation to remove one line from a text file, based on a + line number.
+
+
removeOptional() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
 
+
RemoveProperty - Class in com.paypal.butterfly.utilities.operations.properties
+
+
Removes a property from a properties file.
+
+
RemoveProperty() - Constructor for class com.paypal.butterfly.utilities.operations.properties.RemoveProperty
+
+
Operation to remove a property from a properties file.
+
+
RemoveProperty(String) - Constructor for class com.paypal.butterfly.utilities.operations.properties.RemoveProperty
+
+
Operation to remove a property from a properties file.
+
+
removeScope() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
 
+
removeType() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
 
+
removeVersion() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
 
+
removeVersion() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
+
Operation to remove version of the plugin.
+
+
RenameFile - Class in com.paypal.butterfly.utilities.operations.file
+
+
Renames a single file.
+
+
RenameFile() - Constructor for class com.paypal.butterfly.utilities.operations.file.RenameFile
+
+
Renames a single file.
+
+
RenameFile(String) - Constructor for class com.paypal.butterfly.utilities.operations.file.RenameFile
+
+
Renames a single file.
+
+
ReplaceLine - Class in com.paypal.butterfly.utilities.operations.text
+
+
Replaces one, or more, lines from a text file.
+
+
ReplaceLine() - Constructor for class com.paypal.butterfly.utilities.operations.text.ReplaceLine
+
+
Operation to replace one, or more, lines from a text file.
+
+
ReplaceLine(String, String) - Constructor for class com.paypal.butterfly.utilities.operations.text.ReplaceLine
+
+
Operation to replace one, or more, lines from a text file.
+
+
ReplaceLine(String, String, boolean) - Constructor for class com.paypal.butterfly.utilities.operations.text.ReplaceLine
+
+
Operation to replace one, or more, lines from a text file.
+
+
ReplaceLine(Integer, String) - Constructor for class com.paypal.butterfly.utilities.operations.text.ReplaceLine
+
+
Operation to replace one line from a text file, based on a + line number.
+
+
ReplaceText - Class in com.paypal.butterfly.utilities.operations.text
+
+
Replaces text in a text file + based on a regular expression.
+
+
ReplaceText() - Constructor for class com.paypal.butterfly.utilities.operations.text.ReplaceText
+
+
Operation to replace text in a text file + based on a regular expression.
+
+
ReplaceText(String) - Constructor for class com.paypal.butterfly.utilities.operations.text.ReplaceText
+
+
Operation to replace text in a text file + based on a regular expression.
+
+
ReplaceText(String, String) - Constructor for class com.paypal.butterfly.utilities.operations.text.ReplaceText
+
+
Operation to replace text in a text file + based on a regular expression.
+
+
RunScript - Class in com.paypal.butterfly.utilities.misc
+
+
Executes a script and saves the result after evaluating it.
+
+
RunScript() - Constructor for class com.paypal.butterfly.utilities.misc.RunScript
+
+
Executes a script and saves the result after evaluating it.
+
+
RunScript(String) - Constructor for class com.paypal.butterfly.utilities.misc.RunScript
+
+
Executes a script and saves the result after evaluating it.
+
+
+ + + +

S

+
+
setArtifact(String) - Method in class com.paypal.butterfly.utilities.operations.pom.AbstractStaxArtifactPomOperation
+
+
Set dependency group id and artifact id based on a String + whose format is "groupId:artifactId".
+
+
setArtifact(String) - Method in class com.paypal.butterfly.utilities.pom.PomModel
+
+
Sets the groupId, artifactId and version from artifactInfo
+
+
setArtifactId(String) - Method in class com.paypal.butterfly.utilities.conditions.pom.PomDependencyExists
+
 
+
setArtifactId(String) - Method in class com.paypal.butterfly.utilities.conditions.pom.PomParentMatch
+
 
+
setArtifactId(String) - Method in class com.paypal.butterfly.utilities.operations.pom.AbstractStaxArtifactPomOperation
+
 
+
setArtifactId(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeParent
+
+
Deprecated.
+ 
+
setArtifactId(String) - Method in class com.paypal.butterfly.utilities.pom.PomModel
+
+
Sets the artifactId
+
+
setAttribute(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomFile
+
+
Sets the name of the transformation context attribute holding the Model object
+
+
setAttribute(String) - Method in class com.paypal.butterfly.utilities.xml.XmlElement
+
+
Deprecated.
+
Set the name of the XML element attribute + to be retrieved.
+
+
setAttributeNames(String...) - Method in class com.paypal.butterfly.utilities.text.StringFormat
+
+
Set the name of the transformation context attributes to be applied to the String format
+
+
setConditions(Set<JavaCondition>) - Method in class com.paypal.butterfly.utilities.conditions.java.JavaMatch
+
+
Sets the set of Java conditions to be used to + evaluate the specified class.
+
+
setDescription(String) - Method in class com.paypal.butterfly.utilities.operations.AbstractToOperation
+
 
+
setExclusionArtifactId(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveDependencyExclusion
+
 
+
setExclusionGroupId(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveDependencyExclusion
+
 
+
setExecutions(List<PluginExecution>) - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
+
Operation to set the Executions that will add/update the existing plugin executions.
+
+
setExtensions(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
+
Operation to set the extensions that will add/update the existing plugin extensions.
+
+
setFileName(String) - Method in class com.paypal.butterfly.utilities.file.FindFile
+
 
+
setFileUrl(URL) - Method in class com.paypal.butterfly.utilities.operations.file.ApplyFile
+
+
Set the URL to locate the file to be applied
+
+
setFirstOnly(boolean) - Method in class com.paypal.butterfly.utilities.operations.text.ReplaceText
+
+
Sets whether all lines, or only the first, to match the + regular expression will be replaced
+
+
setFormat(String) - Method in class com.paypal.butterfly.utilities.text.StringFormat
+
+
Set the String format to be applied
+
+
setGoals(String...) - Method in class com.paypal.butterfly.utilities.maven.MavenGoal
+
+
Set the Maven goals to be executed
+
+
setGroupId(String) - Method in class com.paypal.butterfly.utilities.conditions.pom.PomDependencyExists
+
 
+
setGroupId(String) - Method in class com.paypal.butterfly.utilities.conditions.pom.PomParentMatch
+
 
+
setGroupId(String) - Method in class com.paypal.butterfly.utilities.operations.pom.AbstractStaxArtifactPomOperation
+
 
+
setGroupId(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeParent
+
+
Deprecated.
+ 
+
setGroupId(String) - Method in class com.paypal.butterfly.utilities.pom.PomModel
+
+
Sets Maven artifact group id
+
+
setIncludeFiles(boolean) - Method in class com.paypal.butterfly.utilities.file.FindFiles
+
+
Set whether files should be included in the search or not.
+
+
setIncludeFolders(boolean) - Method in class com.paypal.butterfly.utilities.file.FindFiles
+
+
Set whether folders should be included in the search or not.
+
+
setIncludeMain(boolean) - Method in class com.paypal.butterfly.utilities.conditions.pom.PomJavaMatch
+
+
Sets whether Java classes under src/main/java should be evaluated or not.
+
+
setIncludeTest(boolean) - Method in class com.paypal.butterfly.utilities.conditions.pom.PomJavaMatch
+
+
Sets whether Java classes under src/test/java should be evaluated or not.
+
+
setInsertionMode(InsertLine.InsertionMode) - Method in class com.paypal.butterfly.utilities.operations.text.InsertLine
+
+
Sets the insertion mode
+
+
setInsertionMode(InsertText.InsertionMode) - Method in class com.paypal.butterfly.utilities.operations.text.InsertText
+
+
Sets the insertion mode
+
+
setLanguage(String) - Method in class com.paypal.butterfly.utilities.misc.RunScript
+
 
+
setLineNumber(Integer) - Method in class com.paypal.butterfly.utilities.operations.text.InsertLine
+
+
Sets the line number the new line should be added at.
+
+
setLineNumber(Integer) - Method in class com.paypal.butterfly.utilities.operations.text.InsertText
+
+
Sets the line number the text should be added at.
+
+
setModel(Model) - Method in class com.paypal.butterfly.utilities.operations.pom.PomFile
+
+
Sets the Model object used to write the pom.xml file
+
+
setModelAttributeName(String) - Method in class com.paypal.butterfly.utilities.pom.AbstractPomGetUtility
+
+
Sets the name of the context attribute containing the Maven Model object
+
+
setModuleName(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddModule
+
+
Sets the name of the module to be set by this operation
+
+
setModuleName(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveModule
+
 
+
setNameRegex(String) - Method in class com.paypal.butterfly.utilities.file.FindFiles
+
+
Set regular expression to be used to match the file name + during the search
+
+
setNegate(boolean) - Method in class com.paypal.butterfly.utilities.conditions.java.JavaCondition
+
+
Sets whether the result should be negated, meaning, + resulting true whenever its evaluation result would + normally results false, and vice-versa.
+
+
setNewArtifactId(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomReplaceDependency
+
 
+
setNewGroupId(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomReplaceDependency
+
 
+
setNewLine(String) - Method in class com.paypal.butterfly.utilities.operations.text.AddLine
+
+
Sets the new line to be inserted.
+
+
setNewLine(String) - Method in class com.paypal.butterfly.utilities.operations.text.InsertLine
+
+
Sets the new line to be inserted.
+
+
setNewName(String) - Method in class com.paypal.butterfly.utilities.operations.file.RenameFile
+
 
+
setNewScope(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomReplaceDependency
+
 
+
setNewVersion(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomReplaceDependency
+
 
+
setOptional() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
 
+
setOutputHandlers(MavenInvocationOutputHandler...) - Method in class com.paypal.butterfly.utilities.maven.MavenGoal
+
+
Set the output handlers to be executed against the Maven goals execution result
+
+
setPackageInfo(boolean) - Method in class com.paypal.butterfly.utilities.conditions.java.JavaMatch
+
+
Sets the result value for package info warning.
+
+
setPackagingType(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePackaging
+
 
+
setParentArtifactId(String) - Method in class com.paypal.butterfly.utilities.maven.RelatedArtifacts
+
 
+
setParentGroupId(String) - Method in class com.paypal.butterfly.utilities.maven.RelatedArtifacts
+
 
+
setParentLevel(int) - Method in class com.paypal.butterfly.utilities.file.LocateFile
+
+
Set how many parent levels up the location process should + go through.
+
+
setParentVersion(String) - Method in class com.paypal.butterfly.utilities.maven.RelatedArtifacts
+
 
+
setPathRegex(String) - Method in class com.paypal.butterfly.utilities.file.FindFiles
+
+
Set regular expression to be used to match the file path + during the search
+ Important notes: + + Use forward slash as file separator.
+
+
setPluginDependencies(List<Dependency>) - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
+
Operation to set the Dependencies that will add/update the existing plugin dependencies.
+
+
setPomFilesAttribute(String) - Method in class com.paypal.butterfly.utilities.maven.RelatedArtifacts
+
 
+
setProperties(Properties) - Method in class com.paypal.butterfly.utilities.maven.MavenGoal
+
+
Set the Maven properties for the goal
+
+
setPropertyName(String) - Method in class com.paypal.butterfly.utilities.conditions.PropertyExists
+
 
+
setPropertyName(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddProperty
+
+
Sets the name of the property to be set by this operation
+
+
setPropertyName(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveProperty
+
 
+
setPropertyName(String) - Method in class com.paypal.butterfly.utilities.operations.properties.AddProperty
+
 
+
setPropertyName(String) - Method in class com.paypal.butterfly.utilities.operations.properties.RemoveProperty
+
 
+
setPropertyNameRegex(String) - Method in class com.paypal.butterfly.utilities.conditions.PropertyExists
+
 
+
setPropertyValue(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddProperty
+
+
Sets the value of the property to be set by this operation
+
+
setPropertyValue(String) - Method in class com.paypal.butterfly.utilities.operations.properties.AddProperty
+
 
+
setRecursive(boolean) - Method in class com.paypal.butterfly.utilities.file.FindFiles
+
+
Set whether the search should be recursive or not.
+
+
setRegex(String) - Method in class com.paypal.butterfly.utilities.conditions.pom.PomJavaMatch
+
+
Sets the regular expression to be evaluated against Java classes under given Maven module
+
+
setRegex(String) - Method in class com.paypal.butterfly.utilities.conditions.RegexMatch
+
+
Sets the regular expression to be evaluated against the specified text file
+
+
setRegex(String) - Method in class com.paypal.butterfly.utilities.operations.text.InsertLine
+
+
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.
+
+
setRegex(String) - Method in class com.paypal.butterfly.utilities.operations.text.InsertText
+
+
Sets the regular expression to find insertion points +
+ See InsertText.setInsertionMode(InsertionMode)
+
+
setRegex(String) - Method in class com.paypal.butterfly.utilities.operations.text.ReplaceText
+
+
Sets the regular expression to find replacement points
+
+
setReplacement(String) - Method in class com.paypal.butterfly.utilities.operations.text.ReplaceLine
+
+
Sets the replacement line
+
+
setReplacement(String) - Method in class com.paypal.butterfly.utilities.operations.text.ReplaceText
+
+
Sets the replacement text
+
+
setReplacementElement(Element) - Method in class com.paypal.butterfly.utilities.operations.xml.XmlXPathReplace
+
+
The Element that is used to replace the + Node result of xpath expression.
+
+
setReplacementString(String) - Method in class com.paypal.butterfly.utilities.operations.xml.XmlXPathReplace
+
+
The String that is used to replace the text result of xpath expression.
+
+
setRepoURI(String) - Method in class com.paypal.butterfly.utilities.pom.PomModel
+
+
Sets the repoURI
+
+
setResource(String) - Method in class com.paypal.butterfly.utilities.file.LoadFile
+
+
Sets the name of the resource in the classpath.
+
+
setReturnDataType(QName) - Method in class com.paypal.butterfly.utilities.xml.XmlXPathRetrieve
+
+
Sets the XPatch return type
+
+
setScope(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddDependency
+
 
+
setScope(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddManagedDependency
+
 
+
setScope(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
 
+
setScript(String) - Method in class com.paypal.butterfly.utilities.misc.RunScript
+
+
Sets the script to be executed and evaluated
+
+
setTextFileUrl(URL) - Method in class com.paypal.butterfly.utilities.operations.text.InsertText
+
+
Sets the URL to the text to be inserted
+
+
setToAbsolute(String) - Method in class com.paypal.butterfly.utilities.operations.AbstractToOperation
+
+
The name of the transformation context attribute that holds + the absolute destination location.
+
+
setToAbsolute(String, String) - Method in class com.paypal.butterfly.utilities.operations.AbstractToOperation
+
+
The name of the transformation context attribute that holds + the absolute destination location.
+
+
setToRelative(String) - Method in class com.paypal.butterfly.utilities.operations.AbstractToOperation
+
+
Set relative destination location.
+
+
setType(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddManagedDependency
+
 
+
setType(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
 
+
setVersion(String) - Method in class com.paypal.butterfly.utilities.conditions.pom.PomDependencyExists
+
 
+
setVersion(String) - Method in class com.paypal.butterfly.utilities.conditions.pom.PomParentMatch
+
 
+
setVersion(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddDependency
+
 
+
setVersion(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddManagedDependency
+
 
+
setVersion(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddParent
+
 
+
setVersion(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddPlugin
+
 
+
setVersion(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
 
+
setVersion(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeParent
+
+
Deprecated.
+ 
+
setVersion(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeParentVersion
+
 
+
setVersion(String) - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
+
Operation to set the version that will add/update the existing plugin version.
+
+
setVersion(String) - Method in class com.paypal.butterfly.utilities.pom.PomModel
+
+
Sets the version
+
+
setWarnOnError(boolean) - Method in class com.paypal.butterfly.utilities.maven.MavenGoal
+
+
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.
+
+
setXmlElement(String) - Method in class com.paypal.butterfly.utilities.xml.XmlElement
+
+
Deprecated.
+
The XML element whose value, or an attribute, should be + the result of this transformation utility.
+
+
setXPathExpression(String) - Method in class com.paypal.butterfly.utilities.conditions.XmlXPathExists
+
+
The XPathExpression whose evaluation indicates + the result of this transformation utility.
+
+
setXPathExpression(String) - Method in class com.paypal.butterfly.utilities.operations.xml.XmlXPathReplace
+
+
The XPathExpression whose evaluation finds the + results to replace.
+
+
setXPathExpression(String) - Method in class com.paypal.butterfly.utilities.xml.XmlXPathRetrieve
+
+
The XPathExpression to be used to retrieve the data from XML file.
+
+
setXPathExpression(String, QName) - Method in class com.paypal.butterfly.utilities.xml.XmlXPathRetrieve
+
+
The XPathExpression to be used to retrieve the data from XML file.
+
+
setZipFileUrl(URL) - Method in class com.paypal.butterfly.utilities.operations.file.ApplyZip
+
 
+
StringFormat - Class in com.paypal.butterfly.utilities.text
+
+
Applies one or more transformation context attributes to a format String, using String.format(String, Object...).
+
+
StringFormat() - Constructor for class com.paypal.butterfly.utilities.text.StringFormat
+
+
Applies one or more transformation context attributes to a format String, using String.format(String, Object...).
+
+
StringFormat(String) - Constructor for class com.paypal.butterfly.utilities.text.StringFormat
+
+
Applies one or more transformation context attributes to a format String, using String.format(String, Object...).
+
+
+ + + +

T

+
+
toAbsoluteAttribute - Variable in class com.paypal.butterfly.utilities.operations.AbstractToOperation
+
 
+
toRelative - Variable in class com.paypal.butterfly.utilities.operations.AbstractToOperation
+
 
+
+ + + +

V

+
+
valueOf(String) - Static method in enum com.paypal.butterfly.utilities.operations.text.InsertLine.InsertionMode
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.paypal.butterfly.utilities.operations.text.InsertText.InsertionMode
+
+
Returns the enum constant of this type with the specified name.
+
+
values() - Static method in enum com.paypal.butterfly.utilities.operations.text.InsertLine.InsertionMode
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.paypal.butterfly.utilities.operations.text.InsertText.InsertionMode
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
+ + + +

W

+
+
warnButAddIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddDependency
+
 
+
warnButAddIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddManagedDependency
+
 
+
warnButAddIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddModule
+
 
+
warnButAddIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddParent
+
 
+
warnButAddIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddPlugin
+
 
+
warnButAddIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddProperty
+
 
+
warnIfNoFilesFound() - Method in class com.paypal.butterfly.utilities.file.FindFiles
+
+
By default, if no files are found, an empty list is returned + and the result type is TUExecutionResult.Type#VALUE.
+
+
warnIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeDependency
+
 
+
warnIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeParent
+
+
Deprecated.
+ 
+
warnIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangeParentVersion
+
 
+
warnIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomChangePlugin
+
 
+
warnIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveDependency
+
 
+
warnIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveDependencyExclusion
+
 
+
warnIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveManagedDependency
+
 
+
warnIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveModule
+
 
+
warnIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemovePlugin
+
 
+
warnIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomRemoveProperty
+
 
+
warnIfNotPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomReplaceDependency
+
 
+
warnNotAddIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddDependency
+
 
+
warnNotAddIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddManagedDependency
+
 
+
warnNotAddIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddModule
+
 
+
warnNotAddIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddParent
+
 
+
warnNotAddIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddPlugin
+
 
+
warnNotAddIfPresent() - Method in class com.paypal.butterfly.utilities.operations.pom.PomAddProperty
+
 
+
WebXmlContextParams - Class in com.paypal.butterfly.utilities.misc
+
+
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.
+
+
WebXmlContextParams() - Constructor for class com.paypal.butterfly.utilities.misc.WebXmlContextParams
+
 
+
+ + + +

X

+
+
XmlElement - Class in com.paypal.butterfly.utilities.xml
+
+
Deprecated.
+
+
XmlElement() - Constructor for class com.paypal.butterfly.utilities.xml.XmlElement
+
+
Deprecated.
+
Retrieves the value of an element, + or one of its attributes, in a XML file.
+
+
XmlElement(String) - Constructor for class com.paypal.butterfly.utilities.xml.XmlElement
+
+
Deprecated.
+
Retrieves the value of an element, + or one of its attributes, in a XML file.
+
+
XmlIndentation - Class in com.paypal.butterfly.utilities.xml
+
+
Utility to find out indentation usage in a given XML file.
+
+
XmlIndentation() - Constructor for class com.paypal.butterfly.utilities.xml.XmlIndentation
+
 
+
XmlXPathExists - Class in com.paypal.butterfly.utilities.conditions
+
+
Checks if a particular xpath exists in an XML file.
+
+
XmlXPathExists() - Constructor for class com.paypal.butterfly.utilities.conditions.XmlXPathExists
+
+
Checks if a particular xpath exists in an XML file.
+
+
XmlXPathExists(String) - Constructor for class com.paypal.butterfly.utilities.conditions.XmlXPathExists
+
+
Checks if a particular xpath exists in an XML file.
+
+
XmlXPathReplace - Class in com.paypal.butterfly.utilities.operations.xml
+
+
Modify an XML file based on a given XPath expression.
+
+
XmlXPathReplace(String) - Constructor for class com.paypal.butterfly.utilities.operations.xml.XmlXPathReplace
+
+
Modify an XML file based on a given XPath expression.
+
+
XmlXPathReplace(String, Element) - Constructor for class com.paypal.butterfly.utilities.operations.xml.XmlXPathReplace
+
+
Modify an XML file based on a given XPath expression.
+
+
XmlXPathReplace(String, String) - Constructor for class com.paypal.butterfly.utilities.operations.xml.XmlXPathReplace
+
+
Modify an XML file based on a given XPath expression.
+
+
XmlXPathRetrieve - Class in com.paypal.butterfly.utilities.xml
+
+
Retrieves data from an XML file by using XPath expressions.
+
+
XmlXPathRetrieve() - Constructor for class com.paypal.butterfly.utilities.xml.XmlXPathRetrieve
+
+
Retrieves data from an XML file by using XPath expressions.
+
+
XmlXPathRetrieve(String) - Constructor for class com.paypal.butterfly.utilities.xml.XmlXPathRetrieve
+
+
Retrieves data from an XML file by using XPath expressions.
+
+
XmlXPathRetrieve(String, QName) - Constructor for class com.paypal.butterfly.utilities.xml.XmlXPathRetrieve
+
+
Retrieves data from an XML file by using XPath expressions.
+
+
+A C D E F G H I J L M N O P R S T V W X 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/index.html b/docs/javadocs/3.2.1/butterfly-utilities/index.html new file mode 100644 index 00000000..31e38b05 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/index.html @@ -0,0 +1,75 @@ + + + + + +butterfly-utilities 3.2.1 API + + + + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> + + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/overview-frame.html b/docs/javadocs/3.2.1/butterfly-utilities/overview-frame.html new file mode 100644 index 00000000..bb8f1feb --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/overview-frame.html @@ -0,0 +1,36 @@ + + + + + +Overview List (butterfly-utilities 3.2.1 API) + + + + + +
All Classes
+
+

Packages

+ +
+

 

+ + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/overview-summary.html b/docs/javadocs/3.2.1/butterfly-utilities/overview-summary.html new file mode 100644 index 00000000..69a5f0cf --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/overview-summary.html @@ -0,0 +1,226 @@ + + + + + +Overview (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

butterfly-utilities 3.2.1 API

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Packages 
PackageDescription
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 and Maven modules.
+
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 +
Multiple transformation operations, organized by type, each one having its own subpackage.
+
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.properties +
Transformation operations to manipulate properties files.
+
com.paypal.butterfly.utilities.operations.text +
Transformation operations to manipulate text files.
+
com.paypal.butterfly.utilities.operations.xml +
Transformation operations to manipulate XML files.
+
com.paypal.butterfly.utilities.pom 
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.
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/overview-tree.html b/docs/javadocs/3.2.1/butterfly-utilities/overview-tree.html new file mode 100644 index 00000000..2408573a --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/overview-tree.html @@ -0,0 +1,299 @@ + + + + + +Class Hierarchy (butterfly-utilities 3.2.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/javadocs/3.2.1/butterfly-utilities/package-list b/docs/javadocs/3.2.1/butterfly-utilities/package-list new file mode 100644 index 00000000..ae34ceef --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/package-list @@ -0,0 +1,16 @@ +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 +com.paypal.butterfly.utilities.operations.file +com.paypal.butterfly.utilities.operations.pom +com.paypal.butterfly.utilities.operations.properties +com.paypal.butterfly.utilities.operations.text +com.paypal.butterfly.utilities.operations.xml +com.paypal.butterfly.utilities.pom +com.paypal.butterfly.utilities.text +com.paypal.butterfly.utilities.xml diff --git a/docs/javadocs/3.2.1/butterfly-utilities/script.js b/docs/javadocs/3.2.1/butterfly-utilities/script.js new file mode 100644 index 00000000..b3463569 --- /dev/null +++ b/docs/javadocs/3.2.1/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/3.2.1/butterfly-utilities/stylesheet.css b/docs/javadocs/3.2.1/butterfly-utilities/stylesheet.css new file mode 100644 index 00000000..98055b22 --- /dev/null +++ b/docs/javadocs/3.2.1/butterfly-utilities/stylesheet.css @@ -0,0 +1,574 @@ +/* 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:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + 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:#4D7A97; + 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-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + 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:#4D7A97; + 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:#4D7A97; + 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; +}