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

Class PomModuleDescriptorBuilder

java.lang.Object

org.apache.ivy.plugins.parser.m2.PomModuleDescriptorBuilder

public class PomModuleDescriptorBuilder
extends Object

Build a module descriptor. This class handle the complexity of the structure of an ivy ModuleDescriptor and isolate the PomModuleDescriptorParser from it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static interface	PomModuleDescriptorBuilder.ConfMapper
static class	PomModuleDescriptorBuilder.PomDependencyDescriptor	DependencyDescriptor that provides access to the original PomDependencyData.
static class	PomModuleDescriptorBuilder.PomModuleDescriptor
private static class	PomModuleDescriptorBuilder.PomPluginElement

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	DEPENDENCY_MANAGEMENT
private static final int	DEPENDENCY_MANAGEMENT_KEY_PARTS_COUNT
private static final String	EXTRA_INFO_DELIMITER
private static final String	IVY_XML_MAVEN_NAMESPACE_URI	The namespace URI which is used to refer to Maven (pom) specific elements within a Ivy module descriptor file (ivy.xml)
private final PomModuleDescriptorBuilder.PomModuleDescriptor	ivyModuleDescriptor
private static final Collection<String>	JAR_PACKAGINGS
private DefaultArtifact	mainArtifact
(package private) static final Map<String,PomModuleDescriptorBuilder.ConfMapper>	MAVEN2_CONF_MAPPING
static final Configuration[]	MAVEN2_CONFIGURATIONS
private ModuleRevisionId	mrid
private ParserSettings	parserSettings
private static final String	PROPERTIES
private static final String	WRONG_NUMBER_OF_PARTS_MSG

Constructor Summary

Constructors

Constructor	Description
PomModuleDescriptorBuilder(ModuleDescriptorParser parser, Resource res, ParserSettings ivySettings)

Method Summary

Modifier and Type	Method	Description
void	addDependency(DependencyDescriptor descriptor)
void	addDependency(Resource res, PomReader.PomDependencyData dep)
void	addDependencyMgt(PomDependencyMgt dep)
private void	addExtraInfo(String key, String value)
void	addExtraInfos(List<ExtraInfoHolder> extraInfosHolder)
void	addExtraInfos(Map<String,String> extraAttributes)	Deprecated.
void	addJavadocArtifact()
void	addMainArtifact(String artifactId, String packaging)
void	addPlugin(PomDependencyMgt plugin)
void	addProperty(String propertyName, String value)
void	addSourceArtifact()
void	addSrcArtifact()
private DefaultDependencyArtifactDescriptor	createDefaultArtifact(DefaultDependencyDescriptor dd)
static Map<String,String>	extractPomProperties(List<ExtraInfoHolder> extraInfos)
static Map<String,String>	extractPomProperties(Map<String,String> extraInfo)	Deprecated.
private String	getDefaultScope(PomReader.PomDependencyData dep)
private String	getDefaultVersion(PomReader.PomDependencyData dep)
static Map<ModuleId,String>	getDependencyManagementMap(ModuleDescriptor md)
static List<PomDependencyMgt>	getDependencyManagements(ModuleDescriptor md)
private static List<ModuleId>	getDependencyMgtExclusions(ModuleDescriptor descriptor, String groupId, String artifactId)
private static String	getDependencyMgtExtraInfoKeyForScope(String groupId, String artifactId)
private static String	getDependencyMgtExtraInfoKeyForVersion(String groupId, String artifactId)
private static String	getDependencyMgtExtraInfoPrefixForExclusion(String groupId, String artifactId)
Artifact	getJavadocArtifact()
Artifact	getMainArtifact()
ModuleDescriptor	getModuleDescriptor()
static List<PomDependencyMgt>	getPlugins(ModuleDescriptor md)
private static String	getPropertyExtraInfoKey(String propertyName)
Artifact	getSourceArtifact()
Artifact	getSrcArtifact()
private boolean	isNonDefaultArtifact(PomReader.PomDependencyData dep)
private void	overwriteExtraInfoIfExists(String key, String value)
void	setDescription(String description)
void	setHomePage(String homePage)
void	setLicenses(License[] licenses)
void	setModuleRevId(String groupId, String artifactId, String version)
private static boolean	shouldExcludeAllTransitiveDeps(List<ModuleId> exclusions)

Methods inherited from class java.lang.Object

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

Field Details

IVY_XML_MAVEN_NAMESPACE_URI

private static final String IVY_XML_MAVEN_NAMESPACE_URI

The namespace URI which is used to refer to Maven (pom) specific elements within a Ivy module descriptor file (ivy.xml)

See Also:

• Constant Field Values

DEPENDENCY_MANAGEMENT_KEY_PARTS_COUNT

private static final int DEPENDENCY_MANAGEMENT_KEY_PARTS_COUNT

See Also:

• Constant Field Values

MAVEN2_CONFIGURATIONS

public static final Configuration[] MAVEN2_CONFIGURATIONS

MAVEN2_CONF_MAPPING

static final Map<String,PomModuleDescriptorBuilder.ConfMapper> MAVEN2_CONF_MAPPING

DEPENDENCY_MANAGEMENT

private static final String DEPENDENCY_MANAGEMENT

See Also:

• Constant Field Values

PROPERTIES

private static final String PROPERTIES

See Also:

• Constant Field Values

EXTRA_INFO_DELIMITER

private static final String EXTRA_INFO_DELIMITER

See Also:

• Constant Field Values

JAR_PACKAGINGS

private static final Collection<String> JAR_PACKAGINGS

ivyModuleDescriptor

private final PomModuleDescriptorBuilder.PomModuleDescriptor ivyModuleDescriptor

mrid

private ModuleRevisionId mrid

mainArtifact

private DefaultArtifact mainArtifact

parserSettings

private ParserSettings parserSettings

WRONG_NUMBER_OF_PARTS_MSG

private static final String WRONG_NUMBER_OF_PARTS_MSG

See Also:

• Constant Field Values

Constructor Details

PomModuleDescriptorBuilder

public PomModuleDescriptorBuilder(ModuleDescriptorParser parser,
 Resource res,
 ParserSettings ivySettings)

Method Details

getModuleDescriptor

public ModuleDescriptor getModuleDescriptor()

setModuleRevId

public void setModuleRevId(String groupId,
 String artifactId,
 String version)

setHomePage

public void setHomePage(String homePage)

setDescription

public void setDescription(String description)

setLicenses

public void setLicenses(License[] licenses)

addMainArtifact

public void addMainArtifact(String artifactId,
 String packaging)

addDependency

public void addDependency(Resource res,
 PomReader.PomDependencyData dep)

isNonDefaultArtifact

private boolean isNonDefaultArtifact(PomReader.PomDependencyData dep)

createDefaultArtifact

private DefaultDependencyArtifactDescriptor createDefaultArtifact(DefaultDependencyDescriptor dd)

shouldExcludeAllTransitiveDeps

private static boolean shouldExcludeAllTransitiveDeps(List<ModuleId> exclusions)

addDependency

public void addDependency(DependencyDescriptor descriptor)

addDependencyMgt

public void addDependencyMgt(PomDependencyMgt dep)

addPlugin

public void addPlugin(PomDependencyMgt plugin)

getPlugins

public static List<PomDependencyMgt> getPlugins(ModuleDescriptor md)

getDefaultVersion

private String getDefaultVersion(PomReader.PomDependencyData dep)

getDefaultScope

private String getDefaultScope(PomReader.PomDependencyData dep)

getDependencyMgtExtraInfoKeyForVersion

private static String getDependencyMgtExtraInfoKeyForVersion(String groupId,
 String artifactId)

getDependencyMgtExtraInfoKeyForScope

private static String getDependencyMgtExtraInfoKeyForScope(String groupId,
 String artifactId)

getPropertyExtraInfoKey

private static String getPropertyExtraInfoKey(String propertyName)

getDependencyMgtExtraInfoPrefixForExclusion

private static String getDependencyMgtExtraInfoPrefixForExclusion(String groupId,
 String artifactId)

getDependencyMgtExclusions

private static List<ModuleId> getDependencyMgtExclusions(ModuleDescriptor descriptor,
 String groupId,
 String artifactId)

getDependencyManagementMap

public static Map<ModuleId,String> getDependencyManagementMap(ModuleDescriptor md)

getDependencyManagements

public static List<PomDependencyMgt> getDependencyManagements(ModuleDescriptor md)

addExtraInfos

@Deprecated
public void addExtraInfos(Map<String,String> extraAttributes)

Deprecated.

addExtraInfo

private void addExtraInfo(String key,
 String value)

overwriteExtraInfoIfExists

private void overwriteExtraInfoIfExists(String key,
 String value)

addExtraInfos

public void addExtraInfos(List<ExtraInfoHolder> extraInfosHolder)

extractPomProperties

@Deprecated
public static Map<String,String> extractPomProperties(Map<String,String> extraInfo)

Deprecated.

extractPomProperties

public static Map<String,String> extractPomProperties(List<ExtraInfoHolder> extraInfos)

addProperty

public void addProperty(String propertyName,
 String value)

getMainArtifact

public Artifact getMainArtifact()

getSourceArtifact

public Artifact getSourceArtifact()

getSrcArtifact

public Artifact getSrcArtifact()

getJavadocArtifact

public Artifact getJavadocArtifact()

addSourceArtifact

public void addSourceArtifact()

addSrcArtifact

public void addSrcArtifact()

addJavadocArtifact

public void addJavadocArtifact()