org.apache.ivy.plugins.parser

Interface ModuleDescriptorParser

public interface ModuleDescriptorParser

Method Summary
booleanaccept(Resource res)
ArtifactgetMetadataArtifact(ModuleRevisionId mrid, Resource res)
Returns the module metadata artifact corresponding to the given module revision id that this parser parses
StringgetType()
Return the 'type' of module artifacts this parser is parsing
ModuleDescriptorparseDescriptor(ParserSettings ivySettings, URL descriptorURL, boolean validate)
ModuleDescriptorparseDescriptor(ParserSettings ivySettings, URL descriptorURL, Resource res, boolean validate)
voidtoIvyFile(InputStream is, Resource res, File destFile, ModuleDescriptor md)
Convert a module descriptor to an ivy file.

Method Detail

accept

public boolean accept(Resource res)

getMetadataArtifact

public Artifact getMetadataArtifact(ModuleRevisionId mrid, Resource res)
Returns the module metadata artifact corresponding to the given module revision id that this parser parses

Parameters: res the resource for which the module artifact should be returned mrid the module revision id for which the module artifact should be returned

Returns: the module artifact corresponding to the given mrid and resource

getType

public String getType()
Return the 'type' of module artifacts this parser is parsing

Returns: the 'type' of module artifacts this parser is parsing

parseDescriptor

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

parseDescriptor

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

toIvyFile

public void toIvyFile(InputStream is, Resource res, File destFile, ModuleDescriptor md)
Convert a module descriptor to an ivy file. This method MUST close the given input stream when job is finished

Parameters: is input stream with opened on original module descriptor resource