com.soebes.maven.plugins.mlv.licenses
Class LicensesFile

java.lang.Object
  com.soebes.maven.plugins.mlv.licenses.LicensesFile

public class LicensesFile
extends Object

This class will serve methods for loading the licenses.xml file.

Author:

Karl Heinz Marbaise

Constructor Summary

LicensesFile()

Method Summary

static LicensesContainer	getLicenses(File licenseFile) Load the licenses.xml file and convert it into LicenseContainer class to have the information of the licenses.xml file available.
static LicensesContainer	getLicenses(InputStream licensesInputStream) Load the licenses.xml file from an InputStream which usually means via getResourceAsStream().
static String	toString(LicensesContainer licensesContainer) We convert the LicensesContainer into a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

LicensesFile

public LicensesFile()

Method Detail

getLicenses

public static LicensesContainer getLicenses(File licenseFile)
                                     throws IOException,
                                            org.codehaus.plexus.util.xml.pull.XmlPullParserException

Load the licenses.xml file and convert it into LicenseContainer class to have the information of the licenses.xml file available.

Parameters:

licenseFile -

Returns:

LicensesContainer instance.

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

IOException

getLicenses

public static LicensesContainer getLicenses(InputStream licensesInputStream)
                                     throws IOException,
                                            org.codehaus.plexus.util.xml.pull.XmlPullParserException

Load the licenses.xml file from an InputStream which usually means via getResourceAsStream().

Parameters:

licensesInputStream - The input stream where to load the license file from.

Returns:

LicensesContainer instance.

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

IOException

toString

public static String toString(LicensesContainer licensesContainer)
                       throws IOException

We convert the LicensesContainer into a string.

Parameters:

licensesContainer -

Returns:

Throws:

IOException