From 8479ec8b178f36bd670807d47fc429e58785d530 Mon Sep 17 00:00:00 2001 From: Lukas Eder Date: Fri, 10 May 2013 17:27:11 +0200 Subject: [PATCH] [#1846] Added more Javadoc --- .../main/java/org/jooq/KeepResultSetMode.java | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/jOOQ/src/main/java/org/jooq/KeepResultSetMode.java b/jOOQ/src/main/java/org/jooq/KeepResultSetMode.java index 3230e116de..054709e5d1 100644 --- a/jOOQ/src/main/java/org/jooq/KeepResultSetMode.java +++ b/jOOQ/src/main/java/org/jooq/KeepResultSetMode.java @@ -55,12 +55,25 @@ public enum KeepResultSetMode { /** * Close the JDBC {@link ResultSet} after consuming it (this is the * default). + *

+ * If not explicitly overridden by + * {@link ResultQuery#resultSetConcurrency(int)} or + * {@link ResultQuery#resultSetType(int)}, this will apply + * {@link ResultSet#CONCUR_READ_ONLY} and + * {@link ResultSet#TYPE_FORWARD_ONLY}. */ CLOSE_AFTER_FETCH, /** * Keep the JDBC {@link ResultSet} after consuming it. *

+ * If not explicitly overridden by + * {@link ResultQuery#resultSetConcurrency(int)} or + * {@link ResultQuery#resultSetType(int)}, this will apply + * {@link ResultSet#CONCUR_READ_ONLY} and + * {@link ResultSet#TYPE_SCROLL_SENSITIVE} (allowing for calls to + * {@link Record#refresh()} and {@link Result#refresh()}). + *

* Client code must assure that the {@link ResultSet} is closed explicitly * to free database resources. Closing can be done through any of these * methods: @@ -76,6 +89,12 @@ public enum KeepResultSetMode { * Keep the JDBC {@link ResultSet} after consuming it, updating the * ResultSet at every change of a {@link Record}. *

+ * If not explicitly overridden by + * {@link ResultQuery#resultSetConcurrency(int)} or + * {@link ResultQuery#resultSetType(int)}, this will apply + * {@link ResultSet#CONCUR_UPDATABLE} and + * {@link ResultSet#TYPE_SCROLL_SENSITIVE}. + *

* TODO: More details here *

* Client code must assure that the {@link ResultSet} is closed explicitly @@ -94,6 +113,12 @@ public enum KeepResultSetMode { * ResultSet at every call to {@link Record#store()}, or * {@link Result#store()} (This is not yet supported). *

+ * If not explicitly overridden by + * {@link ResultQuery#resultSetConcurrency(int)} or + * {@link ResultQuery#resultSetType(int)}, this will apply + * {@link ResultSet#CONCUR_UPDATABLE} and + * {@link ResultSet#TYPE_SCROLL_SENSITIVE}. + *

* TODO: More details here *

* Client code must assure that the {@link ResultSet} is closed explicitly