oracle.javatools.db.token

Class TokenPattern.PatternResult

java.lang.Object

oracle.javatools.db.token.TokenPattern.PatternResult

Enclosing class:

TokenPattern<T extends Token>

public class TokenPattern.PatternResult
extends java.lang.Object

The results of a test of a sequence of Tokens against a TokenPattern. The PatternResult is obtained from one of the getResult methods of TokenPattern which define the start token (that is the token from which to begin the test), the optional end token (that is the token beyond which the test should not extend) and an indicator of whether the pattern must match from the start token, or is allowed to scan through the tokens until a match is found.

A PatternResult is an immutable object, from which the details of the pattern match can be queried, such as named matches tokens.

Method Summary

Modifier and Type	Method and Description
T	getEndToken()
java.lang.String	getNamedMatch(java.lang.String name)
java.lang.String	getNamedMatch(java.lang.String name, boolean format) Returns the results of a named search clause.
T	getNamedMatchEndToken(java.lang.String name)
T	getNamedMatchStartToken(java.lang.String name)
T	getStartToken()
int	getTokenCount()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getNamedMatch

public final java.lang.String getNamedMatch(java.lang.String name)

Returns:

the formatted result of a named TokenClause within the Matcher if that clause matched. See getNamedMatch(String name, boolean format)

getNamedMatch

public final java.lang.String getNamedMatch(java.lang.String name,
                                            boolean format)

Returns the results of a named search clause.

Parameters:

name - The search clause name.

format - how the match should be returned

• if format == false, the results are the exact string from the original source from the start of the match to end. This will preserve the case of the original source, include whitespace and comments.
  
• if format == true, the results will have comments removed, alphanumerics (other than string literals) will be forced to uppercase, and white space will just be around alphanumerics and following right parenthesis.

Returns:

the result of a named TokenClause within the search if that clause matched. If named clause did not produce a match, or the name cannot be found, null is returned.

getNamedMatchStartToken

public final T getNamedMatchStartToken(java.lang.String name)

getNamedMatchEndToken

public final T getNamedMatchEndToken(java.lang.String name)

getStartToken

public T getStartToken()

Returns:

the first token of a successful match, or null if match failed

getEndToken

public T getEndToken()

Returns:

the last token of a successful match, or null if match failed

getTokenCount

public int getTokenCount()