AbstractCaseExpressionStateObjectBuilder (EclipseLink 2.7.15, API Reference)

java.lang.Object
- org.eclipse.persistence.jpa.jpql.tools.model.AbstractStateObjectBuilder
- - org.eclipse.persistence.jpa.jpql.tools.model.AbstractScalarExpressionStateObjectBuilder<T>
  - - org.eclipse.persistence.jpa.jpql.tools.model.AbstractConditionalExpressionStateObjectBuilder<ICaseExpressionStateObjectBuilder>
    - - org.eclipse.persistence.jpa.jpql.tools.model.AbstractCaseExpressionStateObjectBuilder

All Implemented Interfaces:

IAbstractConditionalExpressionStateObjectBuilder<ICaseExpressionStateObjectBuilder>, ICaseExpressionStateObjectBuilder, IScalarExpressionStateObjectBuilder<ICaseExpressionStateObjectBuilder>

Direct Known Subclasses:

DefaultCaseExpressionStateObjectBuilder
```
public abstract class AbstractCaseExpressionStateObjectBuilder
extends AbstractConditionalExpressionStateObjectBuilder<ICaseExpressionStateObjectBuilder>
implements ICaseExpressionStateObjectBuilder
```
This abstract implementation of ICaseExpressionStateObjectBuilder adds support for creating a CASE expression.

Version:

2.4

Author:

Pascal Filion

Since:

2.4

Constructor Summary

Constructors
Modifier Constructor Description

protected AbstractCaseExpressionStateObjectBuilder(StateObject parent)
Creates a new AbstractCaseExpressionStateObjectBuilder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CaseExpressionStateObject`	`buildStateObject()`	Creates the actual state object based on the information this builder gathered.
`ICaseExpressionStateObjectBuilder`	`when(ICaseExpressionStateObjectBuilder when, ICaseExpressionStateObjectBuilder then)`	Creates a single `WHEN` expression.

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.AbstractConditionalExpressionStateObjectBuilder
all, allOrAny, and, any, between, between, collectionPath, comparison, comparison, different, different, different, equal, equal, equal, exists, exists, FALSE, greaterThan, greaterThan, greaterThan, greaterThanOrEqual, greaterThanOrEqual, greaterThanOrEqual, in, in, in, in, in, in, isEmpty, isEmpty, isNotEmpty, isNotNull, isNull, isNull, keyword, like, like, like, like, lower, lowerThan, lowerThan, lowerThan, lowerThanOrEqual, lowerThanOrEqual, lowerThanOrEqual, member, member, memberOf, notBetween, notExists, notIn, notIn, notIn, notLike, notLike, notLike, notMember, notMemberOf, NULL, or, some, sub, substring, trim, trim, TRUE, upper, variable

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.AbstractScalarExpressionStateObjectBuilder
abs, add, arithmetic, avg, avg, avgDistinct, buildCollectionPath, buildIdentificationVariable, buildInputParameter, buildNumeric, buildNumeric, buildStateFieldPath, buildStringLiteral, case_, coalesce, concat, count, count, countDistinct, currentDate, currentTime, currentTimestamp, date, divide, entityType, enumLiteral, function, function, getCaseBuilder, getParent, index, length, literal, literals, locate, locate, max, max, maxDistinct, min, min, minDistinct, minus, mod, multiply, nullIf, numeric, numeric, parameter, path, plus, size, sqrt, stateObjects, stateObjects, string, sub, subtract, sum, sum, sumDistinct, type

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.AbstractStateObjectBuilder
add, checkBuilder, checkBuilders, hasStateObjects, pop

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.persistence.jpa.jpql.tools.model.IAbstractConditionalExpressionStateObjectBuilder
all, and, any, between, collectionPath, different, different, different, equal, equal, equal, exists, FALSE, greaterThan, greaterThan, greaterThan, greaterThanOrEqual, greaterThanOrEqual, greaterThanOrEqual, in, in, in, isEmpty, isNotEmpty, isNotNull, isNull, like, like, like, lower, lowerThan, lowerThan, lowerThan, lowerThanOrEqual, lowerThanOrEqual, lowerThanOrEqual, member, memberOf, notBetween, notExists, notIn, notIn, notIn, notLike, notLike, notLike, notMember, notMemberOf, NULL, or, some, sub, substring, trim, trim, TRUE, upper, variable

Methods inherited from interface org.eclipse.persistence.jpa.jpql.tools.model.IScalarExpressionStateObjectBuilder
abs, add, avg, avgDistinct, case_, coalesce, concat, count, countDistinct, currentDate, currentTime, currentTimestamp, date, divide, entityType, enumLiteral, function, function, getCaseBuilder, index, length, locate, locate, max, maxDistinct, min, minDistinct, minus, mod, multiply, nullIf, numeric, numeric, parameter, path, plus, size, sqrt, string, sub, subtract, sum, sumDistinct, type

- Constructor Detail
  - AbstractCaseExpressionStateObjectBuilder
```
protected AbstractCaseExpressionStateObjectBuilder(StateObject parent)
```
    Creates a new AbstractCaseExpressionStateObjectBuilder.
    
    Parameters:
    
    parent - The parent of the CASE expression to build, which is only required when a JPQL fragment needs to be parsed
- Method Detail
  - buildStateObject
```
public CaseExpressionStateObject buildStateObject()
```
    Creates the actual state object based on the information this builder gathered.
    
    Specified by:
    
    buildStateObject in interface ICaseExpressionStateObjectBuilder
    
    Returns:
    
    The newly created CaseExpressionStateObject
  - when
```
public ICaseExpressionStateObjectBuilder when(ICaseExpressionStateObjectBuilder when,
                                              ICaseExpressionStateObjectBuilder then)
```
    Creates a single WHEN expression.
    
    Specified by:
    
    when in interface ICaseExpressionStateObjectBuilder
    
    Parameters:
    
    when - The WHEN expression
    
    then - The THEN expression
    
    Returns:
    
    This builder