Package org.apache.ivy.plugins.parser.m2

Class PomModuleDescriptorParser

java.lang.Object

org.apache.ivy.plugins.parser.m2.PomModuleDescriptorParser

All Implemented Interfaces:

ModuleDescriptorParser

public final class PomModuleDescriptorParser
extends Object
implements ModuleDescriptorParser

A parser for Maven 2 POM.

The configurations used in the generated module descriptor mimics the behavior defined by Maven 2 scopes, as documented here. The PomModuleDescriptorParser use a PomDomReader to read the pom, and the PomModuleDescriptorBuilder to write the ivy module descriptor using the info read by the PomDomReader.

Field Summary

Fields

Modifier and Type	Field	Description
private static final PomModuleDescriptorParser	INSTANCE
private static final String	PARENT_MAP_KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PomModuleDescriptorParser()

Method Summary

Modifier and Type	Method	Description
boolean	accept(Resource res)
private void	addSourcesAndJavadocArtifactsIfPresent(PomModuleDescriptorBuilder mdBuilder, ParserSettings ivySettings)
private void	addTo(PomModuleDescriptorBuilder mdBuilder, PomDependencyMgt dep, ParserSettings ivySettings)
static PomModuleDescriptorParser	getInstance()
Artifact	getMetadataArtifact(ModuleRevisionId mrid, Resource res)	Returns the module metadata artifact corresponding to the given module revision id that this parser parses
String	getType()	Return the 'type' of module artifacts this parser is parsing
private ParseException	newParserException(Exception e)
ModuleDescriptor	parseDescriptor(ParserSettings ivySettings, URL descriptorURL, boolean validate)
ModuleDescriptor	parseDescriptor(ParserSettings ivySettings, URL descriptorURL, Resource res, boolean validate)
private ResolvedModuleRevision	parseOtherPom(ParserSettings ivySettings, ModuleRevisionId parentModRevID, boolean isParentPom)
void	toIvyFile(InputStream is, Resource res, File destFile, ModuleDescriptor md)	Convert a module descriptor to an ivy file.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

private static final PomModuleDescriptorParser INSTANCE

PARENT_MAP_KEY

private static final String PARENT_MAP_KEY

Constructor Details

PomModuleDescriptorParser

private PomModuleDescriptorParser()

Method Details

getInstance

public static PomModuleDescriptorParser getInstance()

toIvyFile

public void toIvyFile(InputStream is,
 Resource res,
 File destFile,
 ModuleDescriptor md)
               throws ParseException,
IOException

Description copied from interface: ModuleDescriptorParser

Convert a module descriptor to an ivy file. This method MUST close the given input stream when job is finished

Specified by:

toIvyFile in interface ModuleDescriptorParser

Parameters:

is - input stream with opened on original module descriptor resource

res - Resource

destFile - File

md - ModuleDescriptor

Throws:

ParseException - if something goes wrong

IOException - if something goes wrong

accept

public boolean accept(Resource res)

Specified by:

accept in interface ModuleDescriptorParser

toString

public String toString()

Overrides:

toString in class Object

getMetadataArtifact

public Artifact getMetadataArtifact(ModuleRevisionId mrid,
 Resource res)

Description copied from interface: ModuleDescriptorParser

Returns the module metadata artifact corresponding to the given module revision id that this parser parses

Specified by:

getMetadataArtifact in interface ModuleDescriptorParser

Parameters:

mrid - the module revision id for which the module artifact should be returned

res - the resource for which the module artifact should be returned

Returns:

the module artifact corresponding to the given mrid and resource

getType

public String getType()

Description copied from interface: ModuleDescriptorParser

Return the 'type' of module artifacts this parser is parsing

Specified by:

getType in interface ModuleDescriptorParser

Returns:

the 'type' of module artifacts this parser is parsing

parseDescriptor

public ModuleDescriptor parseDescriptor(ParserSettings ivySettings,
 URL descriptorURL,
 boolean validate)
                                 throws ParseException,
IOException

Specified by:

parseDescriptor in interface ModuleDescriptorParser

Throws:

ParseException

IOException

parseDescriptor

public ModuleDescriptor parseDescriptor(ParserSettings ivySettings,
 URL descriptorURL,
 Resource res,
 boolean validate)
                                 throws ParseException,
IOException

Specified by:

parseDescriptor in interface ModuleDescriptorParser

Throws:

ParseException

IOException

addTo

private void addTo(PomModuleDescriptorBuilder mdBuilder,
 PomDependencyMgt dep,
 ParserSettings ivySettings)
            throws ParseException,
IOException

Throws:

ParseException

IOException

addSourcesAndJavadocArtifactsIfPresent

private void addSourcesAndJavadocArtifactsIfPresent(PomModuleDescriptorBuilder mdBuilder,
 ParserSettings ivySettings)

parseOtherPom

private ResolvedModuleRevision parseOtherPom(ParserSettings ivySettings,
 ModuleRevisionId parentModRevID,
 boolean isParentPom)
                                      throws ParseException

Throws:

ParseException

newParserException

private ParseException newParserException(Exception e)