Docs & rules

maveniverse/domtripGitHub

This is a public, read-only report. Striff reads this repository's docs, turns each sentence that makes a claim about the code into a rule, and checks the rule against the code on the default branch. How this works

main2ec56f6Last read Oct 3

Is this yours? Install to manage it

Once installed, Striff checks every pull request.

Rules summary
Documents
Rules
29
29
29
29
1
1
1
1
14
4
2
8
13
6
1
6
25 docs
maveniverse/domtripOpen repository

maveniverse/domtrip — documented rules

29 of 29 rules, printed November 17, 2026.

The sentence in your docs
The Document.of(Path) method is the recommended way to load XML files as it handles encoding detection automatically:
Document has an of method
Holds
Creates a new editor with an existing Document object.
Editor depends on Document
Holds
The DomTripXMLReader implements org.xml.sax.XMLReader and is used internally by DomTripSAXSource.
DomTripSAXSource depends on DomTripXMLReader
Holds
Class SAXOutputter, Purpose Walks the tree and emits SAX events to a ContentHandler
SAXOutputter is in eu.maveniverse.domtrip.sax
Holds
Class DomTripXMLReader, Purpose XMLReader implementation for JAXP interop
DomTripXMLReader is in eu.maveniverse.domtrip.sax
Holds
Class DomTripSAXSource, Purpose SAXSource adapter wrapping a domtrip Document
DomTripSAXSource is in eu.maveniverse.domtrip.sax
Holds
Class DomTripStreamReader, Purpose XMLStreamReader backed by a domtrip Document
DomTripStreamReader is in eu.maveniverse.domtrip.stax
Holds
Class DomTripStAXSource, Purpose StAXSource adapter wrapping a domtrip Document
DomTripStAXSource is in eu.maveniverse.domtrip.stax
Holds
The DomTripVisitor interface provides callbacks for each node type with flow control:
DomTripVisitor is a contract
Holds
Call accept() on any element to start a depth-first traversal of its subtree:
Element has an accept method
Holds
Use Editor.walk() to traverse the full document including top-level comments and processing instructions:
Editor has a walk method
Holds
Node Type Element, Callback enterElement() + children + exitElement(), Returns Action / void
2 rules from this sentence
DomTripVisitor has an enterElement method
Holds
DomTripVisitor has an exitElement method
Holds
Node Type Text, Callback visitText(), Returns Action
DomTripVisitor has a visitText method
Holds
Node Type Comment, Callback visitComment(), Returns Action
DomTripVisitor has a visitComment method
Holds
Node Type ProcessingInstruction, Callback visitProcessingInstruction(), Returns Action
DomTripVisitor has a visitProcessingInstruction method
Holds
Field versionStyle, Type VersionStyle, Description INLINE or MANAGED null = auto-detect
AlignOptions has a versionStyle field
Holds
Field versionSource, Type VersionSource, Description LITERAL or PROPERTY null = auto-detect
AlignOptions has a versionSource field
Holds
Field namingConvention, Type PropertyNamingConvention, Description Property naming pattern null = auto-detect
AlignOptions has a namingConvention field
Holds
Field propertyName, Type String, Description Explicit property name override
AlignOptions has a propertyName field
Holds
Field propertyNameGenerator, Type Function<Coordinates, String>, Description Custom property name generator
AlignOptions has a propertyNameGenerator field
Holds
Field scope, Type String, Description Maven dependency scope (e.g., "test" )
AlignOptions has a scope field
Holds
The PomEditor throws DomTripException for error conditions:
PomEditor depends on DomTripException
Holds
API Dependencies, Access editor.dependencies(), Purpose CRUD, exclusions, alignment, convention detection, profile scoping
PomEditor has a dependencies method
Holds
API Plugins, Access editor.plugins(), Purpose CRUD, pluginManagement
PomEditor has a plugins method
Holds
API Properties, Access editor.properties(), Purpose CRUD
PomEditor has a properties method
Holds
API Subprojects, Access editor.subprojects(), Purpose Module management
PomEditor has a subprojects method
Holds
API Parent, Access editor.parent(), Purpose Parent POM management
PomEditor has a parent method
Holds
API Profiles, Access editor.profiles(), Purpose Profile lookup
PomEditor has a profiles method
Holds
29 rules from 8 docs

More open-source reports

Every report →

Other public repositories whose docs Striff read and checked against their code.