BaseJPQLQueryFormatter

java.lang.Object
- org.eclipse.persistence.jpa.jpql.tools.model.BaseJPQLQueryFormatter

All Implemented Interfaces:

IJPQLQueryFormatter, StateObjectVisitor

Direct Known Subclasses:

AbstractActualJPQLQueryFormatter, AbstractJPQLQueryFormatter
```
public abstract class BaseJPQLQueryFormatter
extends Object
implements StateObjectVisitor, IJPQLQueryFormatter
```
An abstract implementation of a IJPQLQueryFormatter.

Since:

2.4

Version:

2.4

Author:

Pascal Filion

Nested Class Summary
- Nested classes/interfaces inherited from interface org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryFormatter
  IJPQLQueryFormatter.IdentifierStyle

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`IJPQLQueryFormatter.IdentifierStyle`	`getIdentifierStyle()`	Returns the style to use when formatting the JPQL identifiers.
`String`	`toString()`
`String`	`toString(StateObject stateObject)`	Creates a string representation of the given `StateObject`.

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

Methods inherited from interface org.eclipse.persistence.jpa.jpql.tools.model.query.StateObjectVisitor
visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

- Method Detail
  - getIdentifierStyle
```
public IJPQLQueryFormatter.IdentifierStyle getIdentifierStyle()
```
    Returns the style to use when formatting the JPQL identifiers.
    
    Returns:
    
    One of the possible ways to format the JPQL identifiers
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toString
```
public String toString(StateObject stateObject)
```
    Creates a string representation of the given StateObject.
    
    Specified by:
    
    toString in interface IJPQLQueryFormatter
    
    Parameters:
    
    stateObject - The StateObject that represents a complete or incomplete JPQL query
    
    Returns:
    
    The string representation of the given StateObject