Skip to content

Commit

Permalink
Final javadoc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
beikov committed Apr 19, 2015
1 parent 6e24314 commit b833086
Show file tree
Hide file tree
Showing 38 changed files with 99 additions and 100 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public interface BaseHavingBuilder<T extends BaseHavingBuilder<T>> {
/**
* Starts a {@link SubqueryInitiator} for the left hand side of a predicate.
* When the subquery builder and the restriction builder for the right hand side are finished, the predicate is added to the
* parent predicate container represented by the type {@linkplain T}.
* parent predicate container represented by the type <code>T</code>.
*
* @return The subquery initiator for building a subquery
*/
Expand All @@ -38,7 +38,7 @@ public interface BaseHavingBuilder<T extends BaseHavingBuilder<T>> {
* Starts a {@link SubqueryInitiator} for the left hand side of a predicate. All occurrences of
* <code>subqueryAlias</code> in <code>expression</code> will be replaced by the subquery.
* When the subquery builder and the restriction builder for the right hand side are finished, the predicate is added to the
* parent predicate container represented by the type {@linkplain T}.
* parent predicate container represented by the type <code>T</code>.
*
* @param subqueryAlias The alias for the subquery which will be replaced by the actual subquery
* @param expression The expression which will be used as left hand side of a predicate
Expand All @@ -48,7 +48,7 @@ public interface BaseHavingBuilder<T extends BaseHavingBuilder<T>> {

/**
* Starts a {@link RestrictionBuilder} for a having predicate with the given expression as left hand expression.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type {@linkplain T}.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type <code>T</code>.
*
* @param expression The left hand expression for a having predicate
* @return The restriction builder for the given expression
Expand All @@ -58,7 +58,7 @@ public interface BaseHavingBuilder<T extends BaseHavingBuilder<T>> {
/**
* Starts a {@link CaseWhenBuilder} for a where predicate.
* When the {@link CaseWhenBuilder} and the restriction builder for the right hand side are finished,
* the predicate is added to the parent predicate container represented by the type {@linkplain T}.
* the predicate is added to the parent predicate container represented by the type <code>T</code>.
*
* @return A {@link CaseWhenBuilder}
*/
Expand All @@ -67,7 +67,7 @@ public interface BaseHavingBuilder<T extends BaseHavingBuilder<T>> {
/**
* Starts a {@link SimpleCaseWhenBuilder} for a where predicate.
* When the {@link CaseWhenBuilder} and the restriction builder for the right hand side are finished,
* the predicate is added to the parent predicate container represented by the type {@linkplain T}.
* the predicate is added to the parent predicate container represented by the type <code>T</code>.
*
* @param expression Case operand expression
* @return A {@link CaseWhenBuilder}
Expand All @@ -76,15 +76,15 @@ public interface BaseHavingBuilder<T extends BaseHavingBuilder<T>> {

/**
* Starts an exists predicate for the having clause with a subquery on the right hand side.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type {@linkplain T}.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type <code>T</code>.
*
* @return The subquery initiator for building a subquery
*/
public SubqueryInitiator<T> havingExists();

/**
* Starts an exists predicate for the having clause with a subquery on the right hand side.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type {@linkplain T}.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type <code>T</code>.
*
* @return The subquery initiator for building a subquery
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public interface BaseJoinOnBuilder<T extends BaseJoinOnBuilder<T>> {

/**
* Starts a {@link RestrictionBuilder} for an on predicate with the given expression as left hand expression.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type {@linkplain T}.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type <code>T</code>.
*
* @param expression The left hand expression for a having predicate
* @return The restriction builder for the given expression
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public interface BaseWhereBuilder<T extends BaseWhereBuilder<T>> {
/**
* Starts a {@link SubqueryInitiator} for the left hand side of a predicate.
* When the subquery builder and the restriction builder for the right hand side are finished, the predicate is added to the
* parent predicate container represented by the type {@linkplain T}.
* parent predicate container represented by the type <code>T</code>.
*
* @return The subquery initiator for building a subquery
*/
Expand All @@ -41,7 +41,7 @@ public interface BaseWhereBuilder<T extends BaseWhereBuilder<T>> {
* All occurrences of
* <code>subqueryAlias</code> in <code>expression</code> will be replaced by the subquery.
* When the subquery builder and the restriction builder for the right hand side are finished, the predicate is added to the
* parent predicate container represented by the type {@linkplain T}.
* parent predicate container represented by the type <code>T</code>.
* </p>
*
* @param subqueryAlias The alias for the subquery which will be replaced by the actual subquery
Expand All @@ -53,7 +53,7 @@ public interface BaseWhereBuilder<T extends BaseWhereBuilder<T>> {

/**
* Starts a {@link RestrictionBuilder} for a where predicate with the given expression as left hand expression.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type {@linkplain T}.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type <code>T</code>.
*
* @param expression The left hand expression for a where predicate
* @return The restriction builder for the given expression
Expand All @@ -63,7 +63,7 @@ public interface BaseWhereBuilder<T extends BaseWhereBuilder<T>> {
/**
* Starts a {@link CaseWhenBuilder} for a where predicate.
* When the {@link CaseWhenBuilder} and the restriction builder for the right hand side are finished,
* the predicate is added to the parent predicate container represented by the type {@linkplain T}.
* the predicate is added to the parent predicate container represented by the type <code>T</code>.
*
* @return A {@link CaseWhenBuilder}
*/
Expand All @@ -72,7 +72,7 @@ public interface BaseWhereBuilder<T extends BaseWhereBuilder<T>> {
/**
* Starts a {@link SimpleCaseWhenBuilder} for a where predicate.
* When the {@link CaseWhenBuilder} and the restriction builder for the right hand side are finished,
* the predicate is added to the parent predicate container represented by the type {@linkplain T}.
* the predicate is added to the parent predicate container represented by the type <code>T</code>.
*
* @param expression Case operand expression
* @return A {@link CaseWhenBuilder}
Expand All @@ -81,15 +81,15 @@ public interface BaseWhereBuilder<T extends BaseWhereBuilder<T>> {

/**
* Starts an exists predicate for the where clause with a subquery on the right hand side.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type {@linkplain T}.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type <code>T</code>.
*
* @return The subquery initiator for building a subquery
*/
public SubqueryInitiator<T> whereExists();

/**
* Starts an not exists predicate for the where clause with a subquery on the right hand side.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type {@linkplain T}.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type <code>T</code>.
*
* @return The subquery initiator for building a subquery
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public interface BinaryPredicateBuilder<T> {

/**
* Uses the given value as right hand side for the binary predicate.
* Finishes the binary predicate and adds it to the parent predicate container represented by the type {@linkplain T}.
* Finishes the binary predicate and adds it to the parent predicate container represented by the type <code>T</code>.
*
* @param value The value to use for the right hand side of the binary predicate
* @return The parent predicate container builder
Expand All @@ -37,7 +37,7 @@ public interface BinaryPredicateBuilder<T> {

/**
* Uses the given expression as right hand side for the binary predicate.
* Finishes the binary predicate and adds it to the parent predicate container represented by the type {@linkplain T}.
* Finishes the binary predicate and adds it to the parent predicate container represented by the type <code>T</code>.
*
* @param expression The expression to use for the right hand side of the binary predicate
* @return The parent predicate container builder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ public interface CaseWhenAndBuilder<T> {
public CaseWhenOrBuilder<CaseWhenAndBuilder<T>> or();

/**
* Finishes the AND predicate and adds it to the parent predicate container represented by the type {@linkplain T}.
* Finishes the AND predicate and adds it to the parent predicate container represented by the type <code>T</code>.
*
* @return The parent predicate container builder
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ public interface CaseWhenOrBuilder<T> {
public CaseWhenAndBuilder<CaseWhenOrBuilder<T>> and();

/**
* Finishes the OR predicate and adds it to the parent predicate container represented by the type {@linkplain T}.
* Finishes the OR predicate and adds it to the parent predicate container represented by the type <code>T</code>.
*
* @return The parent predicate container builder
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
public interface CriteriaBuilderFactory {

/**
* Like {@link CriteriaBuilderFactory#create(javax.persistence.EntityManager, java.lang.Class, java.lang.String)
* Like {@link CriteriaBuilderFactory#create(javax.persistence.EntityManager, java.lang.Class, java.lang.String)}
* but with the alias equivalent to the camel cased result of what {@link Class#getSimpleName()} of the result class returns.
*
* @param entityManager The entity manager to use for the criteria builder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
public interface HavingAndBuilder<T> extends BaseHavingBuilder<HavingAndBuilder<T>> {

/**
* Finishes the AND predicate and adds it to the parent predicate container represented by the type {@linkplain T}.
* Finishes the AND predicate and adds it to the parent predicate container represented by the type <code>T</code>.
*
* @return The parent predicate container builder
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public interface HavingBuilder<T extends HavingBuilder<T>> extends BaseHavingBui

/**
* Starts a {@link HavingOrBuilder} which is a predicate consisting only of disjunctiv connected predicates.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type {@linkplain T}.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type <code>T</code>.
*
* @return The or predicate builder for the having clause
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
public interface HavingOrBuilder<T> extends BaseHavingBuilder<HavingOrBuilder<T>> {

/**
* Finishes the OR predicate and adds it to the parent predicate container represented by the type {@linkplain T}.
* Finishes the OR predicate and adds it to the parent predicate container represented by the type <code>T</code>.
*
* @return The parent predicate container builder
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
public interface JoinOnAndBuilder<T> extends BaseJoinOnBuilder<JoinOnAndBuilder<T>> {

/**
* Finishes the AND predicate and adds it to the parent predicate container represented by the type {@linkplain T}.
* Finishes the AND predicate and adds it to the parent predicate container represented by the type <code>T</code>.
*
* @return The parent predicate container builder
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ public interface JoinOnBuilder<T> extends BaseJoinOnBuilder<JoinOnBuilder<T>> {

/**
* Starts a {@link JoinOnOrBuilder} which is a predicate consisting only of disjunctiv connected predicates.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type {@linkplain T}.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type <code>T</code>.
*
* @return The or predicate builder for the having clause
*/
public JoinOnOrBuilder<JoinOnBuilder<T>> onOr();

/**
* Finishes the ON clause and adds it to the parent predicate container represented by the type {@linkplain T}.
* Finishes the ON clause and adds it to the parent predicate container represented by the type <code>T</code>.
*
* @return The parent predicate container builder
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
public interface JoinOnOrBuilder<T> extends BaseJoinOnBuilder<JoinOnOrBuilder<T>> {

/**
* Finishes the OR predicate and adds it to the parent predicate container represented by the type {@linkplain T}.
* Finishes the OR predicate and adds it to the parent predicate container represented by the type <code>T</code>.
*
* @return The parent predicate container builder
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import java.util.List;

/**
* An object build provides the select clause expressions that should be used by a {@link QueryBuilder} and provides methods for transforming tuples into the target type {@linkplain T}.
* An object build provides the select clause expressions that should be used by a {@link QueryBuilder} and provides methods for transforming tuples into the target type <code>T</code>.
*
* @param <T> The type that this builder produces
* @author Christian Beikov
Expand All @@ -34,7 +34,7 @@ public interface ObjectBuilder<T> {
public void applySelects(SelectBuilder<?, ?> selectBuilder);

/**
* Builds an object of the target type {@linkplain T} from the given tuple.
* Builds an object of the target type <code>T</code> from the given tuple.
*
* @param tuple The result tuple
* @return The target object
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ public interface QuantifiableBinaryPredicateBuilder<T> extends BinaryPredicateBu

/**
* Starts a {@link SubqueryInitiator} for the right hand side of a predicate that uses the ALL quantor.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type {@linkplain T}.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type <code>T</code>.
*
* @return The subquery initiator for building a subquery
*/
public SubqueryInitiator<T> all();

/**
* Starts a {@link SubqueryInitiator} for the right hand side of a predicate that uses the ANY quantor.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type {@linkplain T}.
* When the builder finishes, the predicate is added to the parent predicate container represented by the type <code>T</code>.
*
* @return The subquery initiator for building a subquery
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ public interface QueryBuilder<T, X extends QueryBuilder<T, X>> extends BaseQuery
* Applies the given object builder to this query. The object builder provides the select clauses and is used to transform the result set tuples.
*
* @param <Y> The new query result type specified by the given class
* @param builder The object builder which transforms the result set into objects of type {@linkplain Y}
* @param builder The object builder which transforms the result set into objects of type <code>Y</code>
* @return The query builder for chaining calls
*/
public <Y> QueryBuilder<Y, ?> selectNew(ObjectBuilder<Y> builder);
Expand Down
Loading

0 comments on commit b833086

Please sign in to comment.