diff options
author | James Ahlborn <jtahlborn@yahoo.com> | 2012-05-24 14:25:39 +0000 |
---|---|---|
committer | James Ahlborn <jtahlborn@yahoo.com> | 2012-05-24 14:25:39 +0000 |
commit | 6f2b4edfebf72dc7a2dc1df16ce628112d66de99 (patch) | |
tree | 612765a242a4f40c6a74be5223606a9091e7b1e4 | |
parent | 499897124cf42fcc879db23833f6067099ec9a94 (diff) | |
download | jackcess-6f2b4edfebf72dc7a2dc1df16ce628112d66de99.tar.gz jackcess-6f2b4edfebf72dc7a2dc1df16ce628112d66de99.zip |
enhance javadoc
git-svn-id: https://svn.code.sf.net/p/jackcess/code/jackcess/trunk@624 f203690c-595d-4dc9-a70b-905162fa7fd2
-rw-r--r-- | src/java/com/healthmarketscience/jackcess/Table.java | 24 |
1 files changed, 17 insertions, 7 deletions
diff --git a/src/java/com/healthmarketscience/jackcess/Table.java b/src/java/com/healthmarketscience/jackcess/Table.java index 2a00126..6a6b807 100644 --- a/src/java/com/healthmarketscience/jackcess/Table.java +++ b/src/java/com/healthmarketscience/jackcess/Table.java @@ -1372,14 +1372,21 @@ public class Table } /** - * Add a single row to this table and write it to disk + * Adds a single row to this table and writes it to disk. The values are + * expected to be given in the order that the Columns are listed by the + * {@link #getColumns} method. This is by default the storage order of the + * Columns in the database, however this order can be influenced by setting + * the ColumnOrder via {@link Database#setColumnOrder} prior to opening the + * Table. The {@link #asRow} method can be used to easily convert a row Map into the + * appropriate row array for this Table. * <p> - * Note, if this table has an auto-number column, the value written will be - * put back into the given row array. + * Note, if this table has an auto-number column, the value generated will be + * put back into the given row array (assuming the given row array is at + * least as long as the number of Columns in this Table). * - * @param row row values for a single row. the row will be modified if - * this table contains an auto-number column, otherwise it - * will not be modified. + * @param row row values for a single row. the given row array will be + * modified if this table contains an auto-number column, + * otherwise it will not be modified. * @usage _general_method_ */ public void addRow(Object... row) throws IOException { @@ -1392,7 +1399,10 @@ public class Table * is much more efficient than calling <code>addRow</code> multiple times. * <p> * Note, if this table has an auto-number column, the values written will be - * put back into the given row arrays. + * put back into the given row arrays (assuming the given row array is at + * least as long as the number of Columns in this Table). + * + * @see #addRow(Object...) for more details on row arrays * * @param rows List of Object[] row values. the rows will be modified if * this table contains an auto-number column, otherwise they |