[PATCH 3/7] Fix javadoc comments in filters/xmerge - ConverterinfoMgr.java

Nigel Hawkins n.hawkins at gmx.com
Tue Nov 2 05:59:17 PDT 2010


---
 .../xmerge/util/registry/ConverterInfoMgr.java     |   52 ++++++++------------
 1 files changed, 21 insertions(+), 31 deletions(-)

diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/util/registry/ConverterInfoMgr.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/util/registry/ConverterInfoMgr.java
index 66fede9..b94a708 100644
--- a/xmerge/source/xmerge/java/org/openoffice/xmerge/util/registry/ConverterInfoMgr.java
+++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/util/registry/ConverterInfoMgr.java
@@ -1,7 +1,7 @@
 /*************************************************************************
  *
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- * 
+ *
  * Copyright 2000, 2010 Oracle and/or its affiliates.
  *
  * OpenOffice.org - a multi-platform office productivity suite
@@ -37,7 +37,7 @@ import java.io.*;
  *  manager can exist at a time.  It is final, so it may not be
  *  subclassed.
  *
- *  @author: Brian Cameron
+ *  @author Brian Cameron
  */
 public final class ConverterInfoMgr {
 
@@ -50,15 +50,13 @@ public final class ConverterInfoMgr {
        converterInfoList = new Vector();
     }
 
-
    /**
     *  Adds a converter plug-in to the registry.  The
     *  <code>ConverterInfo</code> must have a unique DisplayName
     *  and must have non-null values for DisplayName, ClassImpl,
-    *  OfficeMime, and DeviceMime.  
+    *  OfficeMime, and DeviceMime.
     *
-    *  @param  ConverterInfo  A <code>ConverterInfo</code> object
-    *                         describing a plug-in.
+    *  @param  ci  A <code>ConverterInfo</code> object describing a plug-in.
     *
     *  @throws  RegistryException  If the <code>ConverterInfo</code>
     *                              is not valid.
@@ -102,7 +100,7 @@ public final class ConverterInfoMgr {
                 throw re;
             }
         }
-       
+
         // Since this is a adding to a static Vector, make sure this
         // add method call is synchronized.
         //
@@ -110,15 +108,14 @@ public final class ConverterInfoMgr {
             converterInfoList.add(ci);
         }
     }
-   
 
    /**
-    *  Adds a <code>Vector</code> of converter plug-ins to the registry.
-    *  Each <code>ConverterInfo</code> in the <code>Vector</code> must have 
+    *  Adds a list of converter plug-ins to the registry.
+    *  Each <code>ConverterInfo</code> in the list must have
     *  a unique DisplayName and must have non-null values for DisplayName,
-    *  ClassImpl, OfficeMime, and DeviceMime.  
+    *  ClassImpl, OfficeMime, and DeviceMime.
     *
-    *  @param  ciVectory  A <code>Vector</code> of <code>ConverterInfo</code> 
+    *  @param  jarEnum  An <code>Enumeration</code> of <code>ConverterInfo</code>
     *                     objects describing one or more plug-in(s).
     *
     *  @throws  RegistryException  If a <code>ConverterInfo</code> in the
@@ -132,7 +129,6 @@ public final class ConverterInfoMgr {
         }
     }
 
-
    /**
     *  Returns an <code>Enumeration</code> of registered
     *  <code>ConverterInfo</code> objects.
@@ -145,14 +141,13 @@ public final class ConverterInfoMgr {
       return (converterInfoList.elements());
    }
 
-
    /**
     *  Removes any <code>ConverterInfo</code> object from the registry
     *  that have the specified jar name value.
     *
     *  @param  jar  The name of the jarfile.
     *
-    *  @return  True if a <code>ConverterInfo</code> object was 
+    *  @return  True if a <code>ConverterInfo</code> object was
     *           removed, false otherwise.
     */
    public static boolean removeByJar(String jar) {
@@ -183,14 +178,13 @@ public final class ConverterInfoMgr {
         return rc;
     }
 
-
    /**
     *  Removes any <code>ConverterInfo</code> object from the registry
     *  that have the specified display name value.
     *
     *  @param  name  The display name.
     *
-    *  @return  True if a <code>ConverterInfo</code> object was 
+    *  @return  True if a <code>ConverterInfo</code> object was
     *           removed, false otherwise.
     */
    public static boolean removeByName(String name) {
@@ -210,7 +204,6 @@ public final class ConverterInfoMgr {
         return rc;
     }
 
-
    /**
     *  Returns the <code>ConverterInfo</code> object that supports
     *  the specified device/office mime type conversion.  If there
@@ -220,7 +213,7 @@ public final class ConverterInfoMgr {
     *  @param  deviceMime  The device mime.
     *  @param  officeMime  The office mime.
     *
-    *  @return  The first plug-in that supports the specified 
+    *  @return  The first plug-in that supports the specified
     *           conversion.
     */
     public static ConverterInfo findConverterInfo(String deviceMime, String officeMime) {
@@ -254,15 +247,14 @@ public final class ConverterInfoMgr {
         return null;
     }
 
-
    /**
     *  Returns an array of two <code>ConverterInfo</code> objects that
     *  can be chained to perform the specified mime type conversion.
     *  If there are multiple <code>ConverterInfo</code> objects that
     *  support this conversion, only the first is returned.
     *
-    *  @param  deviceMimeFrom  The device from mime.
-    *  @param  deviceMimeTo    The device to mime.
+    *  @param  deviceFromMime  The device from mime.
+    *  @param  deviceToMime    The device to mime.
     *
     *  @return  An array of two <code>ConverterInfo</code> objects
     *           that can be chained to perform the specified
@@ -323,11 +315,10 @@ public final class ConverterInfoMgr {
         return null;
     }
 
-
     /**
-     *  main to let the user specify what plug-ins to register from 
+     *  main to let the user specify what plug-ins to register from
      *  jarfiles and to display the currently registered plug-ins.
-     * 
+     *
      *  @param  args  Not used.
      */
     public static void main(String args[]) {
@@ -360,7 +351,7 @@ public final class ConverterInfoMgr {
             }
 
             System.out.println("");
- 
+
             // Quit
             //
             if (c == 'Q') {
@@ -392,7 +383,7 @@ public final class ConverterInfoMgr {
                     }
                 }
 
-            // Unload by Display Name or Jarfile 
+            // Unload by Display Name or Jarfile
             //
         } else if (c == 'T') {
         if (validate== true){
@@ -426,7 +417,7 @@ public final class ConverterInfoMgr {
                     } else {
                         System.out.println("Remove failed.");
                     }
-             
+
                 } catch (Exception e) {
                     System.out.println("Error removing value from registry");
                     System.out.println("Error msg: " + e.getMessage());
@@ -451,7 +442,7 @@ public final class ConverterInfoMgr {
                     System.out.println("Error adding data to registry");
                     System.out.println("Error msg: " + e.getMessage());
                 }
-            
+
                 if (c == 'F') {
                     System.out.println("Enter office mime: ");
                 } else {
@@ -506,7 +497,7 @@ public final class ConverterInfoMgr {
                     int feCnt = 1;
                     while (fromEnum.hasMoreElements())
                     {
-                        System.out.println("    DeviceMime   : (#" + feCnt + ") : " + 
+                        System.out.println("    DeviceMime   : (#" + feCnt + ") : " +
                             (String)fromEnum.nextElement());
                         feCnt++;
                     }
@@ -533,4 +524,3 @@ public final class ConverterInfoMgr {
         }
     }
 }
-
-- 
1.7.0.4


--=-r9HQZWKbe5d9ZLbtzsqO
Content-Disposition: attachment; filename*0=0004-Fix-javadoc-comments-in-filters-xmerge-ColourConvert.pat; filename*1=ch
Content-Type: text/x-patch; name="0004-Fix-javadoc-comments-in-filters-xmerge-ColourConvert.patch"; charset="UTF-8"
Content-Transfer-Encoding: 7bit



More information about the LibreOffice mailing list