Package org.craftercms.commons.plugin.impl

Class PluginDescriptorReaderImpl

java.lang.Object

org.craftercms.commons.plugin.impl.PluginDescriptorReaderImpl

All Implemented Interfaces:

PluginDescriptorReader

public class PluginDescriptorReaderImpl
extends Object
implements PluginDescriptorReader

Default implementation of PluginDescriptorReader that parses YAML files.

Since:

3.1.1

Author:

joseross

Constructor Summary

Constructors

Constructor	Description
PluginDescriptorReaderImpl()

Method Summary

Modifier and Type	Method	Description
PluginDescriptor	read(InputStream is)	Parses a PluginDescriptor from the given stream
PluginDescriptor	read(Reader reader)	Parses a PluginDescriptor from the given reader

Methods inherited from class java.lang.Object

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

Constructor Details

PluginDescriptorReaderImpl

public PluginDescriptorReaderImpl()

Method Details

read

public PluginDescriptor read(InputStream is)
                      throws PluginException

Parses a PluginDescriptor from the given stream

Specified by:

read in interface PluginDescriptorReader

Parameters:

is - the stream to parse

Returns:

the plugin descriptor

Throws:

PluginException - if there is any error parsing the stream

read

public PluginDescriptor read(Reader reader)
                      throws PluginException

Parses a PluginDescriptor from the given reader

Specified by:

read in interface PluginDescriptorReader

Parameters:

reader - the reader to parse

Returns:

the plugin descriptor

Throws:

PluginException - if there is any error parsing the reader