[#796] Complete public org.jooq.impl Javadoc

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> {
 

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
  */

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 {

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> {

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() {}
 }

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
  */

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> {

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

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 {

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 {

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> {

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 {

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> {

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> {

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
  */

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() {}
 }

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> {

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;

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
  */

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
  */

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
  */