From 9972c1cccc0362e3da76c28209b8e609de8770ed Mon Sep 17 00:00:00 2001
From: Lukas Eder <lukas.eder@gmail.com>
Date: Mon, 29 Aug 2011 17:31:47 +0000
Subject: [PATCH] [#796] Complete public org.jooq.impl Javadoc

---
 jOOQ/src/main/java/org/jooq/impl/AbstractDataType.java |  9 +++++++++
 jOOQ/src/main/java/org/jooq/impl/AbstractKeys.java     |  2 ++
 .../java/org/jooq/impl/AbstractStoredProcedure.java    |  4 ++++
 jOOQ/src/main/java/org/jooq/impl/ArrayRecordImpl.java  |  4 ++++
 jOOQ/src/main/java/org/jooq/impl/FalseCondition.java   |  8 +++-----
 jOOQ/src/main/java/org/jooq/impl/PackageImpl.java      |  2 ++
 jOOQ/src/main/java/org/jooq/impl/ParameterImpl.java    |  4 ++++
 jOOQ/src/main/java/org/jooq/impl/SQLDataType.java      | 10 +++++++++-
 jOOQ/src/main/java/org/jooq/impl/SchemaImpl.java       |  4 ++++
 jOOQ/src/main/java/org/jooq/impl/SequenceImpl.java     |  4 ++++
 .../main/java/org/jooq/impl/StoredFunctionImpl.java    |  4 ++++
 .../main/java/org/jooq/impl/StoredProcedureImpl.java   |  4 ++++
 jOOQ/src/main/java/org/jooq/impl/TableFieldImpl.java   |  4 ++++
 jOOQ/src/main/java/org/jooq/impl/TableImpl.java        |  4 ++++
 jOOQ/src/main/java/org/jooq/impl/TableRecordImpl.java  |  2 ++
 jOOQ/src/main/java/org/jooq/impl/TrueCondition.java    |  8 +++-----
 jOOQ/src/main/java/org/jooq/impl/UDTFieldImpl.java     |  4 ++++
 jOOQ/src/main/java/org/jooq/impl/UDTImpl.java          |  7 +++++++
 jOOQ/src/main/java/org/jooq/impl/UDTRecordImpl.java    |  2 ++
 .../main/java/org/jooq/impl/UpdatableRecordImpl.java   |  2 ++
 .../main/java/org/jooq/impl/UpdatableTableImpl.java    |  2 ++
 21 files changed, 83 insertions(+), 11 deletions(-)

diff --git a/jOOQ/src/main/java/org/jooq/impl/AbstractDataType.java b/jOOQ/src/main/java/org/jooq/impl/AbstractDataType.java
index 4089c74a40..b93f729958 100644
--- a/jOOQ/src/main/java/org/jooq/impl/AbstractDataType.java
+++ b/jOOQ/src/main/java/org/jooq/impl/AbstractDataType.java
@@ -57,6 +57,15 @@ import org.jooq.SQLDialect;
 import org.jooq.SQLDialectNotSupportedException;
 import org.jooq.UDTRecord;
 
+/**
+ * A common base class for data types.
+ * <p>
+ * This also acts as a static data type registry for jOOQ internally.
+ * <p>
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
+ *
+ * @author Lukas Eder
+ */
 @SuppressWarnings("unchecked")
 public abstract class AbstractDataType<T> implements DataType<T> {
 
diff --git a/jOOQ/src/main/java/org/jooq/impl/AbstractKeys.java b/jOOQ/src/main/java/org/jooq/impl/AbstractKeys.java
index 98a822c5ac..3e269874d0 100644
--- a/jOOQ/src/main/java/org/jooq/impl/AbstractKeys.java
+++ b/jOOQ/src/main/java/org/jooq/impl/AbstractKeys.java
@@ -44,6 +44,8 @@ import org.jooq.UniqueKey;
 
 /**
  * A base class for generated static references
+ * <p>
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
  *
  * @author Lukas Eder
  */
diff --git a/jOOQ/src/main/java/org/jooq/impl/AbstractStoredProcedure.java b/jOOQ/src/main/java/org/jooq/impl/AbstractStoredProcedure.java
index 554288eecc..e4ebe56976 100644
--- a/jOOQ/src/main/java/org/jooq/impl/AbstractStoredProcedure.java
+++ b/jOOQ/src/main/java/org/jooq/impl/AbstractStoredProcedure.java
@@ -47,6 +47,10 @@ import org.jooq.Schema;
 import org.jooq.StoredProcedure;
 
 /**
+ * A common base class for stored procedures
+ * <p>
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
+ *
  * @author Lukas Eder
  */
 public abstract class AbstractStoredProcedure extends AbstractStoredObject implements StoredProcedure {
diff --git a/jOOQ/src/main/java/org/jooq/impl/ArrayRecordImpl.java b/jOOQ/src/main/java/org/jooq/impl/ArrayRecordImpl.java
index 6f685cfe50..57c2195924 100644
--- a/jOOQ/src/main/java/org/jooq/impl/ArrayRecordImpl.java
+++ b/jOOQ/src/main/java/org/jooq/impl/ArrayRecordImpl.java
@@ -52,6 +52,10 @@ import org.jooq.SQLDialectNotSupportedException;
 import org.jooq.util.oracle.OracleUtils;
 
 /**
+ * A common base class for Oracle ARRAY types
+ * <p>
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
+ *
  * @author Lukas Eder
  */
 public class ArrayRecordImpl<T> extends AbstractStore<T> implements ArrayRecord<T> {
diff --git a/jOOQ/src/main/java/org/jooq/impl/FalseCondition.java b/jOOQ/src/main/java/org/jooq/impl/FalseCondition.java
index f10a7a9cc9..f85b3d7c41 100644
--- a/jOOQ/src/main/java/org/jooq/impl/FalseCondition.java
+++ b/jOOQ/src/main/java/org/jooq/impl/FalseCondition.java
@@ -44,13 +44,12 @@ import org.jooq.Attachable;
 import org.jooq.BindContext;
 import org.jooq.RenderContext;
 
-
 /**
  * @author Lukas Eder
  */
-public class FalseCondition extends AbstractCondition {
+class FalseCondition extends AbstractCondition {
 
-    private static final long          serialVersionUID = -3972466479081463547L;
+    private static final long serialVersionUID = -3972466479081463547L;
 
     @Override
     public void bind(BindContext context) throws SQLException {}
@@ -65,6 +64,5 @@ public class FalseCondition extends AbstractCondition {
         return Collections.emptyList();
     }
 
-    FalseCondition() {
-    }
+    FalseCondition() {}
 }
diff --git a/jOOQ/src/main/java/org/jooq/impl/PackageImpl.java b/jOOQ/src/main/java/org/jooq/impl/PackageImpl.java
index 1795cfafb0..153e68e240 100644
--- a/jOOQ/src/main/java/org/jooq/impl/PackageImpl.java
+++ b/jOOQ/src/main/java/org/jooq/impl/PackageImpl.java
@@ -52,6 +52,8 @@ import org.jooq.Schema;
  * functions)
  * <p>
  * Currently, this is only supported for the {@link SQLDialect#ORACLE} dialect.
+ * <p>
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
  *
  * @author Lukas Eder
  */
diff --git a/jOOQ/src/main/java/org/jooq/impl/ParameterImpl.java b/jOOQ/src/main/java/org/jooq/impl/ParameterImpl.java
index ca7cf9265d..f56e94393e 100644
--- a/jOOQ/src/main/java/org/jooq/impl/ParameterImpl.java
+++ b/jOOQ/src/main/java/org/jooq/impl/ParameterImpl.java
@@ -49,6 +49,10 @@ import org.jooq.RenderContext;
 import org.jooq.SQLDialect;
 
 /**
+ * A common base class for stored procedure parameters
+ * <p>
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
+ *
  * @author Lukas Eder
  */
 public class ParameterImpl<T> extends AbstractNamedTypeProviderQueryPart<T> implements Parameter<T> {
diff --git a/jOOQ/src/main/java/org/jooq/impl/SQLDataType.java b/jOOQ/src/main/java/org/jooq/impl/SQLDataType.java
index e3e51869c4..497e82ce6d 100644
--- a/jOOQ/src/main/java/org/jooq/impl/SQLDataType.java
+++ b/jOOQ/src/main/java/org/jooq/impl/SQLDataType.java
@@ -60,9 +60,17 @@ import org.jooq.util.sybase.SybaseDataType;
 
 
 /**
+ * The SQL standard data types, as described in {@link Types}.
+ * <p>
+ * These types are usually the ones that are referenced by generated source
+ * code. Most RDBMS have an almost 1:1 mapping between their vendor-specific
+ * types and the ones in this class (except Oracle). Some RDBMS also have
+ * extensions, e.g. for geospacial data types. See the dialect-specific data
+ * type classes for more information.
+ *
  * @author Lukas Eder
  */
-public class SQLDataType<T> extends AbstractDataType<T> {
+public final class SQLDataType<T> extends AbstractDataType<T> {
 
     /**
      * Generated UID
diff --git a/jOOQ/src/main/java/org/jooq/impl/SchemaImpl.java b/jOOQ/src/main/java/org/jooq/impl/SchemaImpl.java
index da73b9baf2..62243ef6d6 100644
--- a/jOOQ/src/main/java/org/jooq/impl/SchemaImpl.java
+++ b/jOOQ/src/main/java/org/jooq/impl/SchemaImpl.java
@@ -52,6 +52,10 @@ import org.jooq.Table;
 import org.jooq.UDT;
 
 /**
+ * A common base class for database schemata
+ * <p>
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
+ *
  * @author Lukas Eder
  */
 public class SchemaImpl extends AbstractNamedQueryPart implements Schema {
diff --git a/jOOQ/src/main/java/org/jooq/impl/SequenceImpl.java b/jOOQ/src/main/java/org/jooq/impl/SequenceImpl.java
index ee42fc1ddf..34dba40036 100644
--- a/jOOQ/src/main/java/org/jooq/impl/SequenceImpl.java
+++ b/jOOQ/src/main/java/org/jooq/impl/SequenceImpl.java
@@ -44,6 +44,10 @@ import org.jooq.Schema;
 import org.jooq.Sequence;
 
 /**
+ * A common base class for sequences
+ * <p>
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
+ *
  * @author Lukas Eder
  */
 public class SequenceImpl implements Sequence {
diff --git a/jOOQ/src/main/java/org/jooq/impl/StoredFunctionImpl.java b/jOOQ/src/main/java/org/jooq/impl/StoredFunctionImpl.java
index 176f8b3de8..5aefddd52e 100644
--- a/jOOQ/src/main/java/org/jooq/impl/StoredFunctionImpl.java
+++ b/jOOQ/src/main/java/org/jooq/impl/StoredFunctionImpl.java
@@ -52,6 +52,10 @@ import org.jooq.Schema;
 import org.jooq.StoredFunction;
 
 /**
+ * A common base class for stored functions
+ * <p>
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
+ *
  * @author Lukas Eder
  */
 public class StoredFunctionImpl<T> extends AbstractStoredObject implements StoredFunction<T> {
diff --git a/jOOQ/src/main/java/org/jooq/impl/StoredProcedureImpl.java b/jOOQ/src/main/java/org/jooq/impl/StoredProcedureImpl.java
index 0a2b7c2f4b..4d7f999a19 100644
--- a/jOOQ/src/main/java/org/jooq/impl/StoredProcedureImpl.java
+++ b/jOOQ/src/main/java/org/jooq/impl/StoredProcedureImpl.java
@@ -58,6 +58,10 @@ import org.jooq.Schema;
 import org.jooq.UDTRecord;
 
 /**
+ * A common base class for stored procedures
+ * <p>
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
+ *
  * @author Lukas Eder
  */
 public class StoredProcedureImpl extends AbstractStoredProcedure {
diff --git a/jOOQ/src/main/java/org/jooq/impl/TableFieldImpl.java b/jOOQ/src/main/java/org/jooq/impl/TableFieldImpl.java
index 4aefc32f76..0f3ef52fdc 100644
--- a/jOOQ/src/main/java/org/jooq/impl/TableFieldImpl.java
+++ b/jOOQ/src/main/java/org/jooq/impl/TableFieldImpl.java
@@ -51,6 +51,10 @@ import org.jooq.Table;
 import org.jooq.TableField;
 
 /**
+ * A common base type for table fields.
+ * <p>
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
+ *
  * @author Lukas Eder
  */
 public class TableFieldImpl<R extends Record, T> extends AbstractField<T> implements TableField<R, T> {
diff --git a/jOOQ/src/main/java/org/jooq/impl/TableImpl.java b/jOOQ/src/main/java/org/jooq/impl/TableImpl.java
index 948199df12..953e8f7f4a 100644
--- a/jOOQ/src/main/java/org/jooq/impl/TableImpl.java
+++ b/jOOQ/src/main/java/org/jooq/impl/TableImpl.java
@@ -49,6 +49,10 @@ import org.jooq.Schema;
 import org.jooq.Table;
 
 /**
+ * A common base type for tables
+ * <p>
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
+ *
  * @author Lukas Eder
  */
 public class TableImpl<R extends Record> extends AbstractTable<R> {
diff --git a/jOOQ/src/main/java/org/jooq/impl/TableRecordImpl.java b/jOOQ/src/main/java/org/jooq/impl/TableRecordImpl.java
index 6d62448df1..0c00148a74 100644
--- a/jOOQ/src/main/java/org/jooq/impl/TableRecordImpl.java
+++ b/jOOQ/src/main/java/org/jooq/impl/TableRecordImpl.java
@@ -52,6 +52,8 @@ import org.jooq.UpdateQuery;
 
 /**
  * A record implementation for a record originating from a single table
+ * <p>
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
  *
  * @author Lukas Eder
  */
diff --git a/jOOQ/src/main/java/org/jooq/impl/TrueCondition.java b/jOOQ/src/main/java/org/jooq/impl/TrueCondition.java
index dbe8ecf597..c753fbcda3 100644
--- a/jOOQ/src/main/java/org/jooq/impl/TrueCondition.java
+++ b/jOOQ/src/main/java/org/jooq/impl/TrueCondition.java
@@ -44,13 +44,12 @@ import org.jooq.Attachable;
 import org.jooq.BindContext;
 import org.jooq.RenderContext;
 
-
 /**
  * @author Lukas Eder
  */
-public class TrueCondition extends AbstractCondition {
+class TrueCondition extends AbstractCondition {
 
-    private static final long         serialVersionUID = 775364624704563687L;
+    private static final long serialVersionUID = 775364624704563687L;
 
     @Override
     public final void bind(BindContext context) throws SQLException {}
@@ -65,6 +64,5 @@ public class TrueCondition extends AbstractCondition {
         return Collections.emptyList();
     }
 
-    TrueCondition() {
-    }
+    TrueCondition() {}
 }
diff --git a/jOOQ/src/main/java/org/jooq/impl/UDTFieldImpl.java b/jOOQ/src/main/java/org/jooq/impl/UDTFieldImpl.java
index 10d3a93471..1c458c117f 100644
--- a/jOOQ/src/main/java/org/jooq/impl/UDTFieldImpl.java
+++ b/jOOQ/src/main/java/org/jooq/impl/UDTFieldImpl.java
@@ -51,6 +51,10 @@ import org.jooq.UDTField;
 import org.jooq.UDTRecord;
 
 /**
+ * A common base type for UDT attributes / fields
+ * <p>
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
+ *
  * @author Lukas Eder
  */
 public class UDTFieldImpl<R extends UDTRecord<R>, T> extends AbstractField<T> implements UDTField<R, T> {
diff --git a/jOOQ/src/main/java/org/jooq/impl/UDTImpl.java b/jOOQ/src/main/java/org/jooq/impl/UDTImpl.java
index 451212cb13..e2777a712a 100644
--- a/jOOQ/src/main/java/org/jooq/impl/UDTImpl.java
+++ b/jOOQ/src/main/java/org/jooq/impl/UDTImpl.java
@@ -52,6 +52,13 @@ import org.jooq.Schema;
 import org.jooq.UDT;
 import org.jooq.UDTRecord;
 
+/**
+ * A common base type for UDT's
+ * <p>
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
+ *
+ * @author Lukas Eder
+ */
 public class UDTImpl<R extends UDTRecord<R>> extends AbstractType<R> implements UDT<R> {
 
     private static final long               serialVersionUID = -2208672099190913126L;
diff --git a/jOOQ/src/main/java/org/jooq/impl/UDTRecordImpl.java b/jOOQ/src/main/java/org/jooq/impl/UDTRecordImpl.java
index 31e4b8829e..3783b1a81f 100644
--- a/jOOQ/src/main/java/org/jooq/impl/UDTRecordImpl.java
+++ b/jOOQ/src/main/java/org/jooq/impl/UDTRecordImpl.java
@@ -46,6 +46,8 @@ import org.jooq.UDTRecord;
 
 /**
  * A record implementation for a record originating from a single UDT
+ * <p>
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
  *
  * @author Lukas Eder
  */
diff --git a/jOOQ/src/main/java/org/jooq/impl/UpdatableRecordImpl.java b/jOOQ/src/main/java/org/jooq/impl/UpdatableRecordImpl.java
index 0ac685979f..1b11dca0df 100644
--- a/jOOQ/src/main/java/org/jooq/impl/UpdatableRecordImpl.java
+++ b/jOOQ/src/main/java/org/jooq/impl/UpdatableRecordImpl.java
@@ -49,6 +49,8 @@ import org.jooq.UpdatableTable;
 
 /**
  * A record implementation for a record holding a primary key
+ * <p>
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
  *
  * @author Lukas Eder
  */
diff --git a/jOOQ/src/main/java/org/jooq/impl/UpdatableTableImpl.java b/jOOQ/src/main/java/org/jooq/impl/UpdatableTableImpl.java
index 958d3e7f6e..867818891a 100644
--- a/jOOQ/src/main/java/org/jooq/impl/UpdatableTableImpl.java
+++ b/jOOQ/src/main/java/org/jooq/impl/UpdatableTableImpl.java
@@ -49,6 +49,8 @@ import org.jooq.UpdatableTable;
 
 /**
  * A table implementation for a table holding a primary key
+ * <p>
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
  *
  * @author Lukas Eder
  */