Changeset 164 for trunk/corelib/src/org/bridgedb/file/IDMapperText.java

Timestamp:

08/19/09 13:33:04 (3 years ago)

Author:

martijn

Message:

Javadoc, style issues in corelib and bio

Files:

• trunk/corelib/src/org/bridgedb/file/IDMapperText.java (modified) (4 diffs)

trunk/corelib/src/org/bridgedb/file/IDMapperText.java

@@ -42 +42 @@
         }
         
-        private static class Driver implements org.bridgedb.Driver
+        /** Knows how to instantiate IDMapperText. */
+        private static final class Driver implements org.bridgedb.Driver
         {
-            private Driver() {} // prevent outside instantiation;
+                        /** prevent outside instantiation. */
+            private Driver() {}
                 
+            /** {@inheritDoc} */
             public IDMapper connect(String location) throws IDMapperException
             {
@@ -110 +113 @@
             }
 
+            /** 
+             * parse the separator list part of the connection string.
+             * \@ or \t will be unescaped.
+             * @param config the connection string to parse
+             * @param head the section to look for, either dssep or idsep
+             * @return separators
+             */
             private char[] parseConfig(String config, String head) {
-                Set<Character> delimiters = new HashSet();
+                Set<Character> delimiters = new HashSet<Character>();
                 Pattern p = Pattern.compile(head+"=(.|\\t|\\@),",
                         Pattern.CASE_INSENSITIVE);
@@ -142 +152 @@
         }
 
-    protected final URL url;
-    protected char[] dataSourceDelimiters;
-    protected char[] idDelimiters;
-    protected boolean transitivity;
+    private final URL url;
+    private char[] dataSourceDelimiters;
+    private char[] idDelimiters;
+    private boolean transitivity;
 
     /**
@@ -205 +215 @@
     /**
      * Free search is not supported for delimiter-text file.
+     * This will throw UnsupportedOperationException
+     * @param text ignored
+     * @param limit ignored
+     * @return does not return
+     * @throws IDMapperException will not be thrown
      */
     public Set<Xref> freeSearch (String text, int limit) throws IDMapperException {