Package me.snowdrop.licenses

Class LicensesFileManager

  • public class LicensesFileManager
extends java.lang.Object
    Class responsible for persisting licenses information to XML and HTML files.
    Author:
    Gytis Trikleris

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void createLicensesHtml​(LicenseSummary licenseSummary, java.lang.String directoryPath)
      Create a licenses.html file and download copy of each license for offline use.
      void createLicensesXml​(LicenseSummary licenseSummary, java.lang.String directoryPath)
      Create a licenses.xml file.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • LicensesFileManager

        public LicensesFileManager()

    • Method Detail

      • createLicensesXml

        public void createLicensesXml​(LicenseSummary licenseSummary,
                              java.lang.String directoryPath)
                       throws LicensesGeneratorException
        Create a licenses.xml file.
        Parameters:
        licenseSummary - license summary XML element, which should be written to a licenses.xml file.
        directoryPath - directory where new file should be stored.
        Throws:
        LicensesGeneratorException - on generation failure

      • createLicensesHtml

        public void createLicensesHtml​(LicenseSummary licenseSummary,
                               java.lang.String directoryPath)
                        throws LicensesGeneratorException
        Create a licenses.html file and download copy of each license for offline use.
        Parameters:
        licenseSummary - license summary XML element, which should be written to a licenses.xml file.
        directoryPath - directory where new file should be stored.
        Throws:
        LicensesGeneratorException - on generation failure