javadoc an cleanup of unneeded code (mainly already out-commented)

git-svn-id: https://joinup.ec.europa.eu/svn/pdf-as/trunk@690 7b5415b0-85f9-ee4d-85bd-d5d0c3b42d1c

1 files changed, 26 insertions, 1 deletions

diff --git a/pdf-as-web/src/main/java/at/gv/egiz/pdfas/web/helper/ApiHelper.java b/pdf-as-web/src/main/java/at/gv/egiz/pdfas/web/helper/ApiHelper.java
index a0f22fd..04dabaa 100644
--- a/pdf-as-web/src/main/java/at/gv/egiz/pdfas/web/helper/ApiHelper.java
+++ b/pdf-as-web/src/main/java/at/gv/egiz/pdfas/web/helper/ApiHelper.java
@@ -22,6 +22,13 @@ public class ApiHelper {
 

    public static final String INTERNAL_PDF_AS_OBJECT = "INTERNAL_PDF_AS_OBJECT";

    

+   /**

+    * Instantiate the {@link PdfAs} implementation.

+    * 

+    * @param file config directory

+    * @return

+    * @throws WebException

+    */

    public static PdfAs createApiObject(File file) throws WebException {

       try {

          Class pdfAsClass = Class.forName("at.gv.egiz.pdfas.impl.api.PdfAsObject");

@@ -45,7 +52,13 @@ public class ApiHelper {
          throw new WebException(e);

       }

    }

-   

+

+   /**

+    * Instantiate the {@link PdfAsInternal} implementation.

+    * 

+    * @return

+    * @throws WebException

+    */

    public static PdfAsInternal createInternalApiObject() throws WebException {

       try {

          Class pdfAsClass = Class.forName("at.gv.egiz.pdfas.impl.api.internal.PdfAsInternalObject");

@@ -62,10 +75,22 @@ public class ApiHelper {
       }

    }

 

+   /**

+    * Retrieve the {@link PdfAs} object from the {@link ServletContext}

+    * 

+    * @param servletContext

+    * @return

+    */

    public static PdfAs getPdfAsFromContext(ServletContext servletContext) {

       return (PdfAs)servletContext.getAttribute(PDF_AS_OBJECT);

    }

 

+   /**

+    * Retrieve the {@link PdfAsInternal} object from the {@link ServletContext}

+    * 

+    * @param servletContext

+    * @return

+    */

    public static PdfAsInternal getPdfAsInternalFromContext(ServletContext servletContext) {

       return (PdfAsInternal)servletContext.getAttribute(INTERNAL_PDF_AS_OBJECT);

    }