aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorArtur Signell <artur@vaadin.com>2011-12-12 15:00:28 +0200
committerArtur Signell <artur@vaadin.com>2011-12-12 15:00:52 +0200
commit4ebaa95c985ded7ecb83838e91c55a7d555d3536 (patch)
tree605c725fede21edf29abb718576cf2e724db7626
parent582e3e697aedceacba7f8d83e8c7b0c4e812c8ef (diff)
downloadvaadin-framework-4ebaa95c985ded7ecb83838e91c55a7d555d3536.tar.gz
vaadin-framework-4ebaa95c985ded7ecb83838e91c55a7d555d3536.zip
Misc minor javadoc fixes
-rw-r--r--src/com/vaadin/data/util/sqlcontainer/OptimisticLockException.java4
-rw-r--r--src/com/vaadin/data/util/sqlcontainer/query/FreeformQuery.java56
-rw-r--r--src/com/vaadin/data/validator/CompositeValidator.java16
-rw-r--r--src/com/vaadin/terminal/gwt/widgetsetutils/ClassPathExplorer.java2
4 files changed, 64 insertions, 14 deletions
diff --git a/src/com/vaadin/data/util/sqlcontainer/OptimisticLockException.java b/src/com/vaadin/data/util/sqlcontainer/OptimisticLockException.java
index 248b159aa9..adfd439ac8 100644
--- a/src/com/vaadin/data/util/sqlcontainer/OptimisticLockException.java
+++ b/src/com/vaadin/data/util/sqlcontainer/OptimisticLockException.java
@@ -3,6 +3,8 @@
*/
package com.vaadin.data.util.sqlcontainer;
+import com.vaadin.data.util.sqlcontainer.query.TableQuery;
+
/**
* An OptimisticLockException is thrown when trying to update or delete a row
* that has been changed since last read from the database.
@@ -12,7 +14,7 @@ package com.vaadin.data.util.sqlcontainer;
* configuration. In order to turn on optimistic locking, you need to specify
* the version column in your TableQuery instance.
*
- * @see com.vaadin.addon.sqlcontainer.query.TableQuery#setVersionColumn(String)
+ * @see TableQuery#setVersionColumn(String)
*
* @author Jonatan Kronqvist / Vaadin Ltd
*/
diff --git a/src/com/vaadin/data/util/sqlcontainer/query/FreeformQuery.java b/src/com/vaadin/data/util/sqlcontainer/query/FreeformQuery.java
index 7dcab29611..56a8455a16 100644
--- a/src/com/vaadin/data/util/sqlcontainer/query/FreeformQuery.java
+++ b/src/com/vaadin/data/util/sqlcontainer/query/FreeformQuery.java
@@ -178,15 +178,14 @@ public class FreeformQuery implements QueryDelegate {
/**
* Fetches the results for the query. This implementation always fetches the
- * entire record set, ignoring the offset and pagelength parameters. In
+ * entire record set, ignoring the offset and page length parameters. In
* order to support lazy loading of records, you must supply a
* FreeformQueryDelegate that implements the
* FreeformQueryDelegate.getQueryString(int,int) method.
*
* @throws SQLException
*
- * @see com.vaadin.addon.sqlcontainer.query.FreeformQueryDelegate#getQueryString(int,
- * int) {@inheritDoc}
+ * @see FreeformQueryDelegate#getQueryString(int, int)
*/
@SuppressWarnings("deprecation")
public ResultSet getResults(int offset, int pagelength) throws SQLException {
@@ -249,8 +248,8 @@ public class FreeformQuery implements QueryDelegate {
* (non-Javadoc)
*
* @see
- * com.vaadin.addon.sqlcontainer.query.QueryDelegate#setFilters(java.util
- * .List)
+ * com.vaadin.data.util.sqlcontainer.query.QueryDelegate#setFilters(java
+ * .util.List)
*/
public void setFilters(List<Filter> filters)
throws UnsupportedOperationException {
@@ -262,6 +261,13 @@ public class FreeformQuery implements QueryDelegate {
}
}
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * com.vaadin.data.util.sqlcontainer.query.QueryDelegate#setOrderBy(java
+ * .util.List)
+ */
public void setOrderBy(List<OrderBy> orderBys)
throws UnsupportedOperationException {
if (delegate != null) {
@@ -272,6 +278,13 @@ public class FreeformQuery implements QueryDelegate {
}
}
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * com.vaadin.data.util.sqlcontainer.query.QueryDelegate#storeRow(com.vaadin
+ * .data.util.sqlcontainer.RowItem)
+ */
public int storeRow(RowItem row) throws SQLException {
if (activeConnection == null) {
throw new IllegalStateException("No transaction is active!");
@@ -287,6 +300,13 @@ public class FreeformQuery implements QueryDelegate {
}
}
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * com.vaadin.data.util.sqlcontainer.query.QueryDelegate#removeRow(com.vaadin
+ * .data.util.sqlcontainer.RowItem)
+ */
public boolean removeRow(RowItem row) throws SQLException {
if (activeConnection == null) {
throw new IllegalStateException("No transaction is active!");
@@ -302,6 +322,12 @@ public class FreeformQuery implements QueryDelegate {
}
}
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * com.vaadin.data.util.sqlcontainer.query.QueryDelegate#beginTransaction()
+ */
public synchronized void beginTransaction()
throws UnsupportedOperationException, SQLException {
if (activeConnection != null) {
@@ -311,6 +337,11 @@ public class FreeformQuery implements QueryDelegate {
activeConnection.setAutoCommit(false);
}
+ /*
+ * (non-Javadoc)
+ *
+ * @see com.vaadin.data.util.sqlcontainer.query.QueryDelegate#commit()
+ */
public synchronized void commit() throws UnsupportedOperationException,
SQLException {
if (activeConnection == null) {
@@ -323,6 +354,11 @@ public class FreeformQuery implements QueryDelegate {
activeConnection = null;
}
+ /*
+ * (non-Javadoc)
+ *
+ * @see com.vaadin.data.util.sqlcontainer.query.QueryDelegate#rollback()
+ */
public synchronized void rollback() throws UnsupportedOperationException,
SQLException {
if (activeConnection == null) {
@@ -333,6 +369,13 @@ public class FreeformQuery implements QueryDelegate {
activeConnection = null;
}
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * com.vaadin.data.util.sqlcontainer.query.QueryDelegate#getPrimaryKeyColumns
+ * ()
+ */
public List<String> getPrimaryKeyColumns() {
return primaryKeyColumns;
}
@@ -357,9 +400,8 @@ public class FreeformQuery implements QueryDelegate {
* getContainsRowQueryString method in FreeformQueryDelegate and this will
* be used instead of the logic.
*
- * @see com.vaadin.addon.sqlcontainer.query.FreeformQueryDelegate#getContainsRowQueryString(Object...)
+ * @see FreeformQueryDelegate#getContainsRowQueryString(Object...)
*
- * {@inheritDoc}
*/
@SuppressWarnings("deprecation")
public boolean containsRowWithKey(Object... keys) throws SQLException {
diff --git a/src/com/vaadin/data/validator/CompositeValidator.java b/src/com/vaadin/data/validator/CompositeValidator.java
index 25d53e97fd..2dd5950cec 100644
--- a/src/com/vaadin/data/validator/CompositeValidator.java
+++ b/src/com/vaadin/data/validator/CompositeValidator.java
@@ -72,6 +72,9 @@ public class CompositeValidator extends AbstractValidator {
/**
* Constructs a composite validator in given mode.
+ *
+ * @param mode
+ * @param errorMessage
*/
public CompositeValidator(CombinationMode mode, String errorMessage) {
super(errorMessage);
@@ -139,8 +142,8 @@ public class CompositeValidator extends AbstractValidator {
/**
* Gets the mode of the validator.
*
- * @return Operation mode of the validator: {@link CombinationMode.AND} or
- * {@link CombinationMode.OR}.
+ * @return Operation mode of the validator: {@link CombinationMode#AND} or
+ * {@link CombinationMode#OR}.
*/
public final CombinationMode getMode() {
return mode;
@@ -149,8 +152,8 @@ public class CompositeValidator extends AbstractValidator {
/**
* Sets the mode of the validator. The valid modes are:
* <ul>
- * <li>{@link CombinationMode.AND} (default)
- * <li>{@link CombinationMode.OR}
+ * <li>{@link CombinationMode#AND} (default)
+ * <li>{@link CombinationMode#OR}
* </ul>
*
* @param mode
@@ -219,8 +222,11 @@ public class CompositeValidator extends AbstractValidator {
* validators of given type null is returned.
* </p>
*
+ * @param validatorType
+ * The type of validators to return
+ *
* @return Collection<Validator> of validators compatible with given type
- * that must apply or null if none fould.
+ * that must apply or null if none found.
*/
public Collection<Validator> getSubValidators(Class validatorType) {
if (mode != MODE_AND) {
diff --git a/src/com/vaadin/terminal/gwt/widgetsetutils/ClassPathExplorer.java b/src/com/vaadin/terminal/gwt/widgetsetutils/ClassPathExplorer.java
index 2e4ce39513..b4fe92d3b7 100644
--- a/src/com/vaadin/terminal/gwt/widgetsetutils/ClassPathExplorer.java
+++ b/src/com/vaadin/terminal/gwt/widgetsetutils/ClassPathExplorer.java
@@ -95,7 +95,7 @@ public class ClassPathExplorer {
/**
* Finds server side widgets with {@link ClientWidget} annotation on the
* class path (entries that can contain widgets/widgetsets - see
- * {@link #getRawClasspathEntries()}).
+ * getRawClasspathEntries()).
*
* As a side effect, also accept criteria are searched under the same class
* path entries and added into the acceptCriterion collection.