io.quarkus.maven.utilities

Class PomTransformer

java.lang.Object

io.quarkus.maven.utilities.PomTransformer

public class PomTransformer
extends Object

A utility to transform pom.xml files on the DOM level while keeping the original comments and formatting also on places where common javax.xml.transform.Transformer or javax.xml.parsers.DocumentBuilder based solutions tend to fail, such as

• Order of XML declaration attributes
• Whitespace after the XML declaration
• Line breaks between element attributes
• File final whitespace

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PomTransformer.Transformation A transformation of a DOM
static class	PomTransformer.TransformationContext A context of a set of PomTransformer.Transformations.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static Pattern	EOL_PATTERN
(package private) static Pattern[]	POSTPROCESS_PATTERNS

Constructor Summary

Constructors

Constructor and Description
PomTransformer(Path path, Charset charset)

Method Summary

Modifier and Type	Method and Description
(package private) static String	anyNs(String... elements) A generator of XPath 1.0 "any namespace" selector, such as /*:[local-name()='foo']/*:[local-name()='bar'].
(package private) static String	detectEol(String src)
(package private) static String	detectIndentation(Node document, XPath xPath)
(package private) static String	postprocess(String src, String result)
void	transform(Collection<PomTransformer.Transformation> transformations) Loads the document under path, applies the given transformations, mitigates the formatting issues caused by Transformer and finally stores the document back to the file under path.
(package private) static void	transform(Collection<PomTransformer.Transformation> edits, Path path, Supplier<String> source, Consumer<String> outConsumer)
void	transform(PomTransformer.Transformation... transformations) Loads the document under path, applies the given transformations, mitigates the formatting issues caused by Transformer and finally stores the document back to the file under path.

Methods inherited from class java.lang.Object

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

Field Detail

POSTPROCESS_PATTERNS

static final Pattern[] POSTPROCESS_PATTERNS

EOL_PATTERN

static final Pattern EOL_PATTERN

Constructor Detail

PomTransformer

public PomTransformer(Path path,
                      Charset charset)

Method Detail

transform

public void transform(PomTransformer.Transformation... transformations)

Loads the document under path, applies the given transformations, mitigates the formatting issues caused by Transformer and finally stores the document back to the file under path.

Parameters:

transformations - the PomTransformer.Transformations to apply

transform

public void transform(Collection<PomTransformer.Transformation> transformations)

Loads the document under path, applies the given transformations, mitigates the formatting issues caused by Transformer and finally stores the document back to the file under path.

Parameters:

transformations - the PomTransformer.Transformations to apply

transform

static void transform(Collection<PomTransformer.Transformation> edits,
                      Path path,
                      Supplier<String> source,
                      Consumer<String> outConsumer)

postprocess

static String postprocess(String src,
                          String result)

detectIndentation

static String detectIndentation(Node document,
                                XPath xPath)

detectEol

static String detectEol(String src)

anyNs

static String anyNs(String... elements)

A generator of XPath 1.0 "any namespace" selector, such as /*:[local-name()='foo']/*:[local-name()='bar']. In XPath 2.0, this would be just /*:foo/*:bar, but as of Java 13, there is only XPath 1.0 available in the JDK.

Parameters:

elements - namespace-less element names

Returns:

am XPath 1.0 style selector