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. + *
+ * This also acts as a static data type registry for jOOQ internally. + *
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
+ *
+ * @author Lukas Eder
+ */
@SuppressWarnings("unchecked")
public abstract class AbstractDataType
+ * 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
+ *
+ * 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
+ *
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
+ *
* @author Lukas Eder
*/
public class ArrayRecordImpl
* Currently, this is only supported for the {@link SQLDialect#ORACLE} dialect.
+ *
+ * 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
+ *
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
+ *
* @author Lukas Eder
*/
public class ParameterImpl
+ * 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
+ * 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
+ *
+ * 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
+ *
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
+ *
* @author Lukas Eder
*/
public class StoredFunctionImpl
+ * 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.
+ *
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
+ *
* @author Lukas Eder
*/
public class TableFieldImpl
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
+ *
* @author Lukas Eder
*/
public class TableImpl
+ * 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
+ *
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
+ *
* @author Lukas Eder
*/
public class UDTFieldImpl
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
+ *
+ * @author Lukas Eder
+ */
public class UDTImpl
+ * 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
+ *
+ * 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
+ *
+ * This type is for JOOQ INTERNAL USE only. Do not reference directly
*
* @author Lukas Eder
*/