Class FormatDocviewXmlMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

    @Mojo(name="format-xml",
          defaultPhase=PROCESS_SOURCES,
          threadSafe=true)
    public class FormatDocviewXmlMojo
    extends org.apache.maven.plugin.AbstractMojo
    Either checks only the formatting of the Docview XML files to comply with the formatting rules from FileVault or also reformats those files.
    • Field Detail

      • includes

        @Parameter
        protected Set<String> includes
        Include patterns for files to include. If not set defaults to [**\/*.xml].

        Note: includes have precedences over excludes. Each pattern can either be an Ant-like pattern or a regular expression if it is starting with %regex[ and ending with ].

      • excludes

        @Parameter
        protected Set<String> excludes
        Exclude patterns for files to exclude. If not set defaults to [].

        Note: includes have precedences over excludes. Each pattern can either be an Ant-like pattern or a regular expression if it is starting with %regex[ and ending with ].

    • Constructor Detail

      • FormatDocviewXmlMojo

        @Inject
        public FormatDocviewXmlMojo​(org.sonatype.plexus.build.incremental.BuildContext buildContext)
    • Method Detail

      • execute

        public void execute()
                     throws org.apache.maven.plugin.MojoExecutionException,
                            org.apache.maven.plugin.MojoFailureException
        Throws:
        org.apache.maven.plugin.MojoExecutionException
        org.apache.maven.plugin.MojoFailureException
      • executeInternal

        protected void executeInternal​(@NotNull
                                       @NotNull File sourceDirectory)
                                throws org.apache.maven.plugin.MojoExecutionException,
                                       org.apache.maven.plugin.MojoFailureException
        Throws:
        org.apache.maven.plugin.MojoExecutionException
        org.apache.maven.plugin.MojoFailureException