Class AbstractXmlMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.codehaus.mojo.xml.AbstractXmlMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
Direct Known Subclasses:
CheckFormatMojo, TransformMojo, ValidateMojo

public abstract class AbstractXmlMojo extends org.apache.maven.plugin.AbstractMojo
Abstract base class for the plugins Mojo's.
  • Field Details

    • project

      @Parameter(defaultValue="${project}", required=true, readonly=true) private org.apache.maven.project.MavenProject project
      The Maven Project.
    • settings

      @Parameter(defaultValue="${settings}", required=true, readonly=true) private org.apache.maven.settings.Settings settings
      The Maven Settings.
    • basedir

      @Parameter(defaultValue="${project.basedir}", required=true, readonly=true) private File basedir
      The base directory, relative to which directory names are interpreted.
    • skip

      @Parameter(property="xml.skip", defaultValue="false") private boolean skip
      Whether to skip execution.
    • catalogs

      @Parameter private String[] catalogs
      An XML catalog file, or URL, which is being used to resolve entities.
    • catalogHandling

      @Parameter(property="xml.catalogHandling", defaultValue="passThrough") private AbstractXmlMojo.CatalogHandling catalogHandling
      How to handle entities which cannot be found in any catalog.
    • locator

      @Component private org.codehaus.plexus.resource.ResourceManager locator
      Plexus resource manager used to obtain XSL.
    • locatorInitialized

      private boolean locatorInitialized
  • Constructor Details

    • AbstractXmlMojo

      public AbstractXmlMojo()
  • Method Details

    • getProject

      protected org.apache.maven.project.MavenProject getProject()
      Returns the maven project.
    • getBasedir

      protected File getBasedir()
      Returns the projects base directory.
    • asAbsoluteFile

      protected File asAbsoluteFile(File f)
      Converts the given file into an file with an absolute path.
    • setCatalogs

      protected void setCatalogs(List<File> pCatalogFiles, List<URL> pCatalogUrls) throws org.apache.maven.plugin.MojoExecutionException
      Returns the plugins catalog files.
      Throws:
      org.apache.maven.plugin.MojoExecutionException
    • getResolver

      protected Resolver getResolver() throws org.apache.maven.plugin.MojoExecutionException
      Creates a new resolver.
      Throws:
      org.apache.maven.plugin.MojoExecutionException
    • getFileNames

      protected String[] getFileNames(File pDir, String[] pIncludes, String[] pExcludes) throws org.apache.maven.plugin.MojoFailureException, org.apache.maven.plugin.MojoExecutionException
      Scans a directory for files and returns a set of path names.
      Throws:
      org.apache.maven.plugin.MojoFailureException
      org.apache.maven.plugin.MojoExecutionException
    • asFiles

      protected File[] asFiles(File pDir, String[] pFileNames)
      Converts the given set of file names into a set of File instances. The file names may be relative to the given base directory.
    • getFiles

      protected File[] getFiles(File pDir, String[] pIncludes, String[] pExcludes) throws org.apache.maven.plugin.MojoFailureException, org.apache.maven.plugin.MojoExecutionException
      Scans a directory for files and returns a set of File instances.
      Throws:
      org.apache.maven.plugin.MojoFailureException
      org.apache.maven.plugin.MojoExecutionException
    • getExcludes

      protected String[] getExcludes(String[] origExcludes, boolean skipDefaultExcludes)
      Calculates the exclusions to use when searching files.
    • isEmpty

      private boolean isEmpty(String value)
    • setProperty

      private void setProperty(List<String> pProperties, String pKey, String pValue)
    • activateProxy

      protected Object activateProxy()
      Called to install the plugins proxy settings.
    • passivateProxy

      protected void passivateProxy(Object pProperties)
      Called to restore the proxy settings, which have been installed when the plugin was invoked.
    • getResource

      protected URL getResource(String pResource) throws org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoFailureException
    • getLocator

      protected org.codehaus.plexus.resource.ResourceManager getLocator()
    • isSkipping

      protected boolean isSkipping()
    • checkCatalogHandling

      void checkCatalogHandling() throws org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoFailureException
    • getCatalogHandling

      protected AbstractXmlMojo.CatalogHandling getCatalogHandling()