Class AbstractRefactoringTool
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.tools.AbstractRefactoringTool
-
- Direct Known Subclasses:
BasicRefactoringTool
,RefactoringTool
public abstract class AbstractRefactoringTool extends java.lang.Object
The abstract definition of a refactoring- Since:
- 2.4
- Version:
- 2.4
- Author:
- Pascal Filion
- See Also:
RefactoringTool
,BasicRefactoringTool
-
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.lang.CharSequence
getJPQLFragment()
Returns the original JPQL query or the JPQL fragment that was passed to this tool so it can be manipulated.java.lang.String
getJPQLQueryBNFId()
Returns the unique identifier of the JPQL query BNF that determined how the JPQL query or fragment needs to be parsed.IManagedTypeProvider
getManagedTypeProvider()
Returns the provider of managed types.boolean
isTolerant()
Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries.void
setTolerant(boolean tolerant)
Sets whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries.abstract java.lang.String
toActualText()
Returns the resulted of the refactoring operations.
-
-
-
Method Detail
-
getJPQLFragment
public java.lang.CharSequence getJPQLFragment()
Returns the original JPQL query or the JPQL fragment that was passed to this tool so it can be manipulated.- Returns:
- The string representation of the JPQL query or fragment
-
getJPQLQueryBNFId
public java.lang.String getJPQLQueryBNFId()
Returns the unique identifier of the JPQL query BNF that determined how the JPQL query or fragment needs to be parsed.- Returns:
- The ID of the
JPQLQueryBNF
used to parse the query
-
getManagedTypeProvider
public IManagedTypeProvider getManagedTypeProvider()
Returns the provider of managed types.- Returns:
- The provider that gives access to the managed types
-
isTolerant
public boolean isTolerant()
Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries.- Returns:
- By default, the parsing system uses tolerance
-
setTolerant
public void setTolerant(boolean tolerant)
Sets whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries.- Parameters:
tolerant
-true
if the JPQL query or fragment should be parsed with tolerance;false
otherwise
-
toActualText
public abstract java.lang.String toActualText()
Returns the resulted of the refactoring operations. The list of changes will be removed after applying the changes.- Returns:
- The string representation of the JPQL query that contains the changes
-
-