From 260914d657114b4e5c0e52efb30e4984ffe6cdef Mon Sep 17 00:00:00 2001 From: James Ahlborn Date: Thu, 4 Apr 2013 03:28:41 +0000 Subject: [PATCH] fix javadocs 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 | 2 +- .../healthmarketscience/jackcess/DatabaseBuilder.java | 1 + src/java/com/healthmarketscience/jackcess/RowId.java | 4 ++-- .../jackcess/complex/ComplexValue.java | 5 +++-- .../healthmarketscience/jackcess/impl/ColumnImpl.java | 9 +++++---- .../healthmarketscience/jackcess/impl/DatabaseImpl.java | 9 ++++----- .../jackcess/impl/IndexCursorImpl.java | 1 + .../com/healthmarketscience/jackcess/impl/UsageMap.java | 4 ++-- .../jackcess/util/CaseInsensitiveColumnMatcher.java | 1 + .../jackcess/util/MemFileChannel.java | 2 ++ 10 files changed, 22 insertions(+), 16 deletions(-) diff --git a/src/java/com/healthmarketscience/jackcess/Database.java b/src/java/com/healthmarketscience/jackcess/Database.java index 0d3fe36..f32a7cd 100644 --- a/src/java/com/healthmarketscience/jackcess/Database.java +++ b/src/java/com/healthmarketscience/jackcess/Database.java @@ -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 diff --git a/src/java/com/healthmarketscience/jackcess/DatabaseBuilder.java b/src/java/com/healthmarketscience/jackcess/DatabaseBuilder.java index 56af7a5..d338b83 100644 --- a/src/java/com/healthmarketscience/jackcess/DatabaseBuilder.java +++ b/src/java/com/healthmarketscience/jackcess/DatabaseBuilder.java @@ -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. diff --git a/src/java/com/healthmarketscience/jackcess/RowId.java b/src/java/com/healthmarketscience/jackcess/RowId.java index 52af7ed..c8b5ab8 100644 --- a/src/java/com/healthmarketscience/jackcess/RowId.java +++ b/src/java/com/healthmarketscience/jackcess/RowId.java @@ -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 */ diff --git a/src/java/com/healthmarketscience/jackcess/complex/ComplexValue.java b/src/java/com/healthmarketscience/jackcess/complex/ComplexValue.java index cd77554..29b62d3 100644 --- a/src/java/com/healthmarketscience/jackcess/complex/ComplexValue.java +++ b/src/java/com/healthmarketscience/jackcess/complex/ComplexValue.java @@ -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(); diff --git a/src/java/com/healthmarketscience/jackcess/impl/ColumnImpl.java b/src/java/com/healthmarketscience/jackcess/impl/ColumnImpl.java index e940919..906ee0c 100644 --- a/src/java/com/healthmarketscience/jackcess/impl/ColumnImpl.java +++ b/src/java/com/healthmarketscience/jackcess/impl/ColumnImpl.java @@ -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 diff --git a/src/java/com/healthmarketscience/jackcess/impl/DatabaseImpl.java b/src/java/com/healthmarketscience/jackcess/impl/DatabaseImpl.java index 9d513af..5f19e32 100644 --- a/src/java/com/healthmarketscience/jackcess/impl/DatabaseImpl.java +++ b/src/java/com/healthmarketscience/jackcess/impl/DatabaseImpl.java @@ -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() diff --git a/src/java/com/healthmarketscience/jackcess/impl/IndexCursorImpl.java b/src/java/com/healthmarketscience/jackcess/impl/IndexCursorImpl.java index f53b980..365cd2e 100644 --- a/src/java/com/healthmarketscience/jackcess/impl/IndexCursorImpl.java +++ b/src/java/com/healthmarketscience/jackcess/impl/IndexCursorImpl.java @@ -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; diff --git a/src/java/com/healthmarketscience/jackcess/impl/UsageMap.java b/src/java/com/healthmarketscience/jackcess/impl/UsageMap.java index ffc3904..4f4293d 100644 --- a/src/java/com/healthmarketscience/jackcess/impl/UsageMap.java +++ b/src/java/com/healthmarketscience/jackcess/impl/UsageMap.java @@ -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); diff --git a/src/java/com/healthmarketscience/jackcess/util/CaseInsensitiveColumnMatcher.java b/src/java/com/healthmarketscience/jackcess/util/CaseInsensitiveColumnMatcher.java index 3b5170b..63e4608 100644 --- a/src/java/com/healthmarketscience/jackcess/util/CaseInsensitiveColumnMatcher.java +++ b/src/java/com/healthmarketscience/jackcess/util/CaseInsensitiveColumnMatcher.java @@ -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; diff --git a/src/java/com/healthmarketscience/jackcess/util/MemFileChannel.java b/src/java/com/healthmarketscience/jackcess/util/MemFileChannel.java index 7c7c230..3a583e5 100644 --- a/src/java/com/healthmarketscience/jackcess/util/MemFileChannel.java +++ b/src/java/com/healthmarketscience/jackcess/util/MemFileChannel.java @@ -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; /** -- 2.39.5