com.atlassian.plugin.parsers
Interface DescriptorParserFactory

All Known Implementing Classes:

OsgiPluginXmlDescriptorParserFactory, XmlDescriptorParserFactory

public interface DescriptorParserFactory

A factory for creating descriptor parsers.

See Also:

DescriptorParser, XmlDescriptorParserFactory

Method Summary

DescriptorParser

getInstance(InputStream source, String... applicationKeys) Creates a new DescriptorParser for getting plugin descriptor information from the provided source data.

Method Detail

getInstance

DescriptorParser getInstance(InputStream source,
                             String... applicationKeys)
                             throws PluginParseException

Creates a new DescriptorParser for getting plugin descriptor information from the provided source data.

Parameters:

source - the stream of data which represents the descriptor. The stream will only be read once, so it need not be resettable.

applicationKeys - The list of application keys to match for module descriptors

Returns:

an instance of the descriptor parser tied to this InputStream

Throws:

PluginParseException - if there was a problem creating the descriptor parser due to an invalid source stream.