DATAJDBC-309 - Polishing.

Author: mp911de

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/AbstractSegment.java

@@ -26,10 +26,14 @@ abstract class AbstractSegment implements Segment {
 
 	private final Segment[] children;
 
-	protected AbstractSegment(Segment ... children) {
+	protected AbstractSegment(Segment... children) {
 		this.children = children;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.relational.core.sql.Visitable#visit(org.springframework.data.relational.core.sql.Visitor)
+	 */
 	@Override
 	public void visit(Visitor visitor) {
 

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/AliasedExpression.java

@@ -20,7 +20,7 @@
  *
  * @author Jens Schauder
  */
-public class AliasedExpression extends AbstractSegment implements Aliased, Expression {
+class AliasedExpression extends AbstractSegment implements Aliased, Expression {
 
 	private final Expression expression;
 	private final String alias;
@@ -33,11 +33,19 @@ public AliasedExpression(Expression expression, String alias) {
 		this.alias = alias;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.relational.core.sql.Aliased#getAlias()
+	 */
 	@Override
 	public String getAlias() {
 		return alias;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see java.lang.Object#toString()
+	 */
 	@Override
 	public String toString() {
 		return expression.toString() + " AS " + alias;

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/AndCondition.java

@@ -26,5 +26,4 @@ public class AndCondition extends MultipleCondition {
 	AndCondition(Condition... conditions) {
 		super(" AND ", conditions);
 	}
-
 }

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/AsteriskFromTable.java

@@ -15,12 +15,14 @@
  */
 package org.springframework.data.relational.core.sql;
 
-import org.springframework.util.Assert;
-
 /**
  * {@link Segment} to select all columns from a {@link Table}.
  * <p/>
- * * Renders to: {@code <table>.*} as in {@code SELECT <table>.* FROM …}.
+ * * Renders to: {@code
+ * <table>
+ * .*} as in {@code SELECT
+ * <table>
+ * .* FROM …}.
  *
  * @author Mark Paluch
  * @see Table#asterisk()
@@ -45,6 +47,10 @@ public Table getTable() {
 		return table;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see java.lang.Object#toString()
+	 */
 	@Override
 	public String toString() {
 

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/In.java

@@ -18,8 +18,7 @@
 /**
  * {@code IN} {@link Condition} clause.
  *
- * @author Jens Schauder
- * TODO: Accept multiple Expressions.
+ * @author Jens Schauder TODO: Accept multiple Expressions.
  */
 public class In extends AbstractSegment implements Condition {
 
@@ -38,6 +37,10 @@ public static Condition create(Expression columnOrExpression, Expression arg) {
 		return new In(columnOrExpression, arg);
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see java.lang.Object#toString()
+	 */
 	@Override
 	public String toString() {
 		return left + " IN " + right;

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/IsNull.java

@@ -40,13 +40,23 @@ private IsNull(Expression expression, boolean negated) {
 		this.negated = negated;
 	}
 
+	/**
+	 * Creates a new {@link IsNull} expression.
+	 *
+	 * @param expression must not be {@literal null}.
+	 * @return
+	 */
 	public static IsNull create(Expression expression) {
 
 		Assert.notNull(expression, "Expression must not be null");
 
 		return new IsNull(expression);
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.relational.core.sql.Condition#not()
+	 */
 	@Override
 	public Condition not() {
 		return new IsNull(expression, !negated);
@@ -56,6 +66,10 @@ public boolean isNegated() {
 		return negated;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see java.lang.Object#toString()
+	 */
 	@Override
 	public String toString() {
 		return expression + (negated ? " IS NOT NULL" : " IS NULL");

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Not.java

@@ -22,18 +22,26 @@ public class Not extends AbstractSegment implements Condition {
 
 	private final Condition condition;
 
-	public Not(Condition condition) {
+	Not(Condition condition) {
 
 		super(condition);
 
 		this.condition = condition;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.relational.core.sql.Condition#not()
+	 */
 	@Override
 	public Condition not() {
 		return condition;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see java.lang.Object#toString()
+	 */
 	@Override
 	public String toString() {
 		return "NOT " + condition.toString();

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SQL.java

@@ -16,54 +16,22 @@
 package org.springframework.data.relational.core.sql;
 
 import org.springframework.data.relational.core.sql.BindMarker.NamedBindMarker;
-import org.springframework.data.relational.core.sql.SelectBuilder.SelectAndFrom;
 import org.springframework.util.Assert;
 
 /**
- * Utility to create SQL {@link Segment}s. Typically used as entry point to the Query Builder AST.
+ * Utility to create SQL {@link Segment}s. Typically used as entry point to the Statement Builder.
  * Objects and dependent objects created by the Query AST are immutable except for builders.
- * <p/>The Query Builder API is intended for framework usage to produce SQL required for framework operations.
+ * <p/>The Statement Builder API is intended for framework usage to produce SQL required for framework operations.
  *
  * @author Mark Paluch
  * @author Jens Schauder
  * @see Expressions
  * @see Conditions
  * @see Functions
+ * @see StatementBuilder
  */
 public abstract class SQL {
 
-	/**
-	 * Creates a new {@link SelectBuilder} by specifying a {@code SELECT} column.
-	 *
-	 * @param expression the select list expression.
-	 * @return the {@link SelectBuilder} containing {@link Expression}.
-	 * @see SelectBuilder#select(Expression)
-	 */
-	public static SelectAndFrom newSelect(Expression expression) {
-		return Select.builder().select(expression);
-	}
-
-	/**
-	 * Creates a new {@link SelectBuilder} by specifying one or more {@code SELECT} columns.
-	 *
-	 * @param expressions the select list expressions.
-	 * @return the {@link SelectBuilder} containing {@link Expression}s.
-	 * @see SelectBuilder#select(Expression...)
-	 */
-	public static SelectAndFrom newSelect(Expression... expressions) {
-		return Select.builder().select(expressions);
-	}
-
-	/**
-	 * Creates a new {@link SelectBuilder}.
-	 *
-	 * @return the new {@link SelectBuilder}.
-	 * @see SelectBuilder
-	 */
-	public static SelectBuilder select() {
-		return Select.builder();
-	}
-
 	/**
 	 * Creates a new {@link Column} associated with a source {@link Table}.
 	 *

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Select.java

@@ -30,6 +30,7 @@
  * </ol>
  *
  * @author Mark Paluch
+ * @see StatementBuilder
  * @see SelectBuilder
  * @see SQL
  */

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SelectList.java

@@ -17,10 +17,11 @@
 
 import java.util.List;
 
-import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
 
 /**
+ * Value object representing the select list (selected columns, functions).
+ *
  * @author Mark Paluch
  */
 public class SelectList extends AbstractSegment {
@@ -32,18 +33,6 @@ public class SelectList extends AbstractSegment {
 		this.selectList = selectList;
 	}
 
-	@Override
-	public void visit(Visitor visitor) {
-
-		Assert.notNull(visitor, "Visitor must not be null!");
-
-		visitor.enter(this);
-		for (Segment child : selectList) {
-			child.visit(visitor);
-		}
-		visitor.leave(this);
-	}
-
 	/*
 	 * (non-Javadoc)
 	 * @see java.lang.Object#toString()

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SimpleCondition.java

@@ -15,8 +15,6 @@
  */
 package org.springframework.data.relational.core.sql;
 
-import org.springframework.util.Assert;
-
 /**
  * Simple condition consisting of {@link Expression}, {@code comparator} and {@code predicate}.
  *

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SimpleFunction.java

@@ -94,6 +94,10 @@ static class AliasedFunction extends SimpleFunction implements Aliased {
 			this.alias = alias;
 		}
 
+		/*
+		 * (non-Javadoc)
+		 * @see org.springframework.data.relational.core.sql.Aliased#getAlias()
+		 */
 		@Override
 		public String getAlias() {
 			return alias;

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/StatementBuilder.java

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2019 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.relational.core.sql;
+
+import org.springframework.data.relational.core.sql.SelectBuilder.SelectAndFrom;
+
+/**
+ * Entrypoint to build SQL statements.
+ *
+ * @author Mark Paluch
+ * @see SQL
+ * @see Expressions
+ * @see Conditions
+ * @see Functions
+ */
+public abstract class StatementBuilder {
+
+	/**
+	 * Creates a new {@link SelectBuilder} by specifying a {@code SELECT} column.
+	 *
+	 * @param expression the select list expression.
+	 * @return the {@link SelectBuilder} containing {@link Expression}.
+	 * @see SelectBuilder#select(Expression)
+	 */
+	public static SelectAndFrom select(Expression expression) {
+		return Select.builder().select(expression);
+	}
+
+	/**
+	 * Creates a new {@link SelectBuilder} by specifying one or more {@code SELECT} columns.
+	 *
+	 * @param expressions the select list expressions.
+	 * @return the {@link SelectBuilder} containing {@link Expression}s.
+	 * @see SelectBuilder#select(Expression...)
+	 */
+	public static SelectAndFrom select(Expression... expressions) {
+		return Select.builder().select(expressions);
+	}
+
+	/**
+	 * Creates a new {@link SelectBuilder}.
+	 *
+	 * @return the new {@link SelectBuilder}.
+	 * @see SelectBuilder
+	 */
+	public static SelectBuilder select() {
+		return Select.builder();
+	}
+
+	private StatementBuilder() {
+
+	}
+}

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SubselectExpression.java

@@ -31,6 +31,10 @@ public class SubselectExpression extends AbstractSegment implements Expression {
 		this.subselect = subselect;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see java.lang.Object#toString()
+	 */
 	@Override
 	public String toString() {
 		return "(" + subselect.toString() + ")";

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Where.java

@@ -15,8 +15,6 @@
  */
 package org.springframework.data.relational.core.sql;
 
-import org.springframework.util.Assert;
-
 /**
  * {@code Where} clause.
  *
@@ -33,6 +31,10 @@ public class Where extends AbstractSegment {
 		this.condition = condition;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see java.lang.Object#toString()
+	 */
 	@Override
 	public String toString() {
 		return "WHERE " + condition.toString();

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/package-info.java

@@ -1,6 +1,6 @@
 
 /**
- * Statement Builder implementation. Use {@link org.springframework.data.relational.core.sql.SQL} as entry point to create SQL objects. Objects and dependent objects created by the Query AST are immutable except for builders.
+ * Statement Builder implementation. Use {@link org.springframework.data.relational.core.sql.StatementBuilder} to create statements and {@link org.springframework.data.relational.core.sql.SQL} to create SQL objects. Objects and dependent objects created by the Statement Builder are immutable except for builders.
  * <p/> The Statement Builder API is intended for framework usage to produce SQL required for framework operations.
  */
 @NonNullApi