]> source.dussan.org Git - jackcess.git/commitdiff
fix javadocs
authorJames Ahlborn <jtahlborn@yahoo.com>
Thu, 4 Apr 2013 03:28:41 +0000 (03:28 +0000)
committerJames Ahlborn <jtahlborn@yahoo.com>
Thu, 4 Apr 2013 03:28:41 +0000 (03:28 +0000)
git-svn-id: https://svn.code.sf.net/p/jackcess/code/jackcess/branches/jackcess-2@702 f203690c-595d-4dc9-a70b-905162fa7fd2

src/java/com/healthmarketscience/jackcess/Database.java
src/java/com/healthmarketscience/jackcess/DatabaseBuilder.java
src/java/com/healthmarketscience/jackcess/RowId.java
src/java/com/healthmarketscience/jackcess/complex/ComplexValue.java
src/java/com/healthmarketscience/jackcess/impl/ColumnImpl.java
src/java/com/healthmarketscience/jackcess/impl/DatabaseImpl.java
src/java/com/healthmarketscience/jackcess/impl/IndexCursorImpl.java
src/java/com/healthmarketscience/jackcess/impl/UsageMap.java
src/java/com/healthmarketscience/jackcess/util/CaseInsensitiveColumnMatcher.java
src/java/com/healthmarketscience/jackcess/util/MemFileChannel.java

index 0d3fe3603f4db5eb8a1dd42106d4df1d7cd06d26..f32a7cd79ddacb5de4b6cb2ea6a66eb31d49a982 100644 (file)
@@ -39,7 +39,7 @@ import com.healthmarketscience.jackcess.util.LinkResolver;
 /**
  * An Access database instance.  A new instance can be instantiated by opening
  * an existing database file ({@link DatabaseBuilder#open(File)}) or creating
- * a new database file ({@link DatabaseBuilder#create(FileFormat,File)}) (for
+ * a new database file ({@link DatabaseBuilder#create(Database.FileFormat,File)}) (for
  * more advanced opening/creating use {@link DatabaseBuilder}).  Once a
  * Database has been opened, you can interact with the data via the relevant
  * {@link Table}.  When a Database instance is no longer useful, it should
index 56af7a56690fccc46e8658b5ae1abc31346e2806..d338b836a39bc264010116c582d2a4979008cd60 100644 (file)
@@ -27,6 +27,7 @@ import java.util.TimeZone;
 
 import com.healthmarketscience.jackcess.impl.DatabaseImpl;
 import com.healthmarketscience.jackcess.impl.CodecProvider;
+import com.healthmarketscience.jackcess.util.MemFileChannel;
 
 /**
  * Builder style class for opening/creating a Database.
index 52af7ed4ed8332d73290204e64c688ac2526cfe1..c8b5ab8df08973dc7a54047d8b19da48b5b08b82 100644 (file)
@@ -22,8 +22,8 @@ package com.healthmarketscience.jackcess;
 /**
  * Uniquely identifies a row of data within the access database.  While RowIds
  * are largely opaque identifiers, they are comparable to each other (within
- * the same table) and have valid {@link #equals}, {@link #hashCode} and
- * {@link #toString} methods.
+ * the same table) and have valid {@code equals()}, {@code hashCode()} and
+ * {@code toString()} methods.
  *
  * @author James Ahlborn
  */
index cd7755480c7d28d70b4b38f0d14c27928931bec6..29b62d3c76885a38706d6ee586bd4d5bc02b2ea8 100644 (file)
@@ -24,6 +24,7 @@ import java.io.ObjectStreamException;
 
 import com.healthmarketscience.jackcess.Column;
 import com.healthmarketscience.jackcess.RowId;
+import com.healthmarketscience.jackcess.impl.complex.ComplexColumnInfoImpl;
 
 /**
  * Base interface for a value in a complex column (where there may be multiple
@@ -37,7 +38,7 @@ public interface ComplexValue
    * Returns the unique identifier of this complex value (this value is unique
    * among all values in all rows of the main table).
    * 
-   * @return the current id or {@link ComplexColumnInfo#INVALID_ID} for a new,
+   * @return the current id or {@link ComplexColumnInfoImpl#INVALID_ID} for a new,
    *         unsaved value.
    */
   public Id getId();
@@ -52,7 +53,7 @@ public interface ComplexValue
    * Returns the foreign key identifier for this complex value (this value is
    * the same for all values in the same row of the main table).
    * 
-   * @return the current id or {@link ComplexColumnInfo#INVALID_FK}
+   * @return the current id or {@link ComplexColumnInfoImpl#INVALID_FK}
    *         for a new, unsaved value.
    */
   public ComplexValueForeignKey getComplexValueForeignKey();
index e940919755940668aeb28af0bb6d57c27a65d41b..906ee0c3a254880a12ccf55d4266b902ced9e3a4 100644 (file)
@@ -51,6 +51,11 @@ import java.util.UUID;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+import com.healthmarketscience.jackcess.Column;
+import com.healthmarketscience.jackcess.ColumnBuilder;
+import com.healthmarketscience.jackcess.DataType;
+import com.healthmarketscience.jackcess.PropertyMap;
+import com.healthmarketscience.jackcess.Table;
 import com.healthmarketscience.jackcess.complex.ComplexColumnInfo;
 import com.healthmarketscience.jackcess.complex.ComplexValue;
 import com.healthmarketscience.jackcess.complex.ComplexValueForeignKey;
@@ -62,10 +67,6 @@ import com.healthmarketscience.jackcess.impl.scsu.Expand;
 import com.healthmarketscience.jackcess.impl.scsu.IllegalInputException;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
-import com.healthmarketscience.jackcess.Column;
-import com.healthmarketscience.jackcess.DataType;
-import com.healthmarketscience.jackcess.PropertyMap;
-import com.healthmarketscience.jackcess.ColumnBuilder;
 
 /**
  * Access database column definition
index 9d513af8f32fb154b74c301f566e7e2b471752c1..5f19e326327372ee99bb4cb8c1f09d6441de8156 100644 (file)
@@ -59,7 +59,6 @@ import java.util.TreeSet;
 
 import com.healthmarketscience.jackcess.ColumnBuilder;
 import com.healthmarketscience.jackcess.Cursor;
-import com.healthmarketscience.jackcess.CursorBuilder;
 import com.healthmarketscience.jackcess.DataType;
 import com.healthmarketscience.jackcess.Database;
 import com.healthmarketscience.jackcess.IndexBuilder;
@@ -1545,7 +1544,7 @@ public class DatabaseImpl implements Database
   /**
    * Returns the default TimeZone.  This is normally the platform default
    * TimeZone as returned by {@link TimeZone#getDefault}, but can be
-   * overridden using the system property {@value #TIMEZONE_PROPERTY}.
+   * overridden using the system property {@value Database#TIMEZONE_PROPERTY}.
    * @usage _advanced_method_
    */
   public static TimeZone getDefaultTimeZone()
@@ -1566,7 +1565,7 @@ public class DatabaseImpl implements Database
    * Returns the default Charset for the given JetFormat.  This may or may not
    * be platform specific, depending on the format, but can be overridden
    * using a system property composed of the prefix
-   * {@value #CHARSET_PROPERTY_PREFIX} followed by the JetFormat version to
+   * {@value Database#CHARSET_PROPERTY_PREFIX} followed by the JetFormat version to
    * which the charset should apply, e.g. {@code
    * "com.healthmarketscience.jackcess.charset.VERSION_3"}.
    * @usage _advanced_method_
@@ -1587,7 +1586,7 @@ public class DatabaseImpl implements Database
   
   /**
    * Returns the default Table.ColumnOrder.  This defaults to
-   * {@link #DEFAULT_COLUMN_ORDER}, but can be overridden using the system
+   * {@link Database#DEFAULT_COLUMN_ORDER}, but can be overridden using the system
    * property {@value #COLUMN_ORDER_PROPERTY}.
    * @usage _advanced_method_
    */
@@ -1608,7 +1607,7 @@ public class DatabaseImpl implements Database
   /**
    * Returns the default enforce foreign-keys policy.  This defaults to
    * {@code true}, but can be overridden using the system
-   * property {@value #FK_ENFORCE_PROPERTY}.
+   * property {@value Database#FK_ENFORCE_PROPERTY}.
    * @usage _advanced_method_
    */
   public static boolean getDefaultEnforceForeignKeys()
index f53b9802b62eced5316d45e8f8c94b6fd8ab7e68..365cd2ed6f2ce31351231f7995421e3c80fed311 100644 (file)
@@ -27,6 +27,7 @@ import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.Set;
 
+import com.healthmarketscience.jackcess.Index;
 import com.healthmarketscience.jackcess.IndexCursor;
 import com.healthmarketscience.jackcess.Row;
 import com.healthmarketscience.jackcess.RuntimeIOException;
index ffc3904acceb5cd92bc617b6c38c27a6976ebbe4..4f4293ddb1a4ce8a9fe7dc6160fb5705aedf5551 100644 (file)
@@ -806,7 +806,7 @@ public class UsageMap
 
     /**
      * @return valid page number if there was another page to read,
-     *         {@link RowId#LAST_PAGE_NUMBER} otherwise
+     *         {@link RowIdImpl#LAST_PAGE_NUMBER} otherwise
      */
     public int getNextPage() {
       return getAnotherPage(CursorImpl.MOVE_FORWARD);
@@ -814,7 +814,7 @@ public class UsageMap
 
     /**
      * @return valid page number if there was another page to read,
-     *         {@link RowId#FIRST_PAGE_NUMBER} otherwise
+     *         {@link RowIdImpl#FIRST_PAGE_NUMBER} otherwise
      */
     public int getPreviousPage() {
       return getAnotherPage(CursorImpl.MOVE_REVERSE);
index 3b5170ba059d7073de02425e61b7a53f4ced319e..63e460894b1e07bc1bf06f29ceeb969eff45f727 100644 (file)
@@ -22,6 +22,7 @@ package com.healthmarketscience.jackcess.util;
 
 import java.io.IOException;
 
+import com.healthmarketscience.jackcess.DataType;
 import com.healthmarketscience.jackcess.RuntimeIOException;
 import com.healthmarketscience.jackcess.Table;
 import com.healthmarketscience.jackcess.impl.ColumnImpl;
index 7c7c2309d8f70ead8cff48daa4702fe7f16e0551..3a583e5fb0e7f076630597ba50917ac2f206fad4 100644 (file)
@@ -33,6 +33,8 @@ import java.nio.channels.NonWritableChannelException;
 import java.nio.channels.ReadableByteChannel;
 import java.nio.channels.WritableByteChannel;
 
+import com.healthmarketscience.jackcess.Database;
+import com.healthmarketscience.jackcess.DatabaseBuilder;
 import com.healthmarketscience.jackcess.impl.DatabaseImpl;
 
 /**