TokenContext (Oracle Fusion Middleware Java API Reference for Oracle Extension SDK)

java.lang.Object
- oracle.javatools.db.ddl.TokenContext

```
public class TokenContext
extends java.lang.Object
```
A TokenContext is the state object for a TokenProcessor. It is used when proessing "token code" to create DDL.
When processing a token, the DDL statement that is being created can be added to as appropriate for the contents of a given token.
Multiple statements can be built up as part of a single generation. The full generation can be accessed using getStatements().

Since:

11

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`append(java.lang.Object value)` Appends the given value to the current statement buffer.
`void`	`appendString(java.lang.String string, boolean incrementNewlines)` Appends the given string.
`void`	`decrementIndent()` Decrements the indent which will be appended at the beginning of every new line.
`void`	`endCurrentStatement()` Terminates the current statement that is being appended to.
`Difference`	`findUpdateDifference(DBObject obj)` If we are processing the update of an object, this finds a Difference that shows the changes for the given object.
`Schema`	`getDefaultSchema()` Gets the default Schema from the underlying provider.
`Difference`	`getDifference()` Gets the Difference for the current token.
`java.lang.String`	`getExternalName(java.lang.String name)` Gets the external version (e.g.
`java.lang.Object`	`getLoopObject()` Gets the loop object.
`java.lang.Object`	`getObject()` Gets the context object for the current token.
`DDLOptions`	`getOptions()` Gets the DDLOptions that the generation was started with.
`java.lang.Object`	`getPropertyValue(java.lang.String propName)` Gets a property value from the context object.
`DBObjectProvider`	`getProvider()` Gets the DBObjectProvider that the DBObjects being generated are from/for.
`java.util.List<java.lang.String>`	`getStatements()` Returns the full list of statements that have been built in this DDL generation.
`void`	`incrementIndent()` Increments the indent which will be appended at the beginning of every new line.
`boolean`	`isUpdate()` Tests whether the current token has a Difference, and that tokens such as `{old.name}` and `{+columns}` will therefore work.
`int`	`length()` Gets the length of the current statement being built.
`TokenContext`	`newChildContext(java.lang.Object newObj)` Creates a new child context for the given object.
`void`	`removeIfEndsWith(java.lang.String str)` If the current statement ends with the given string, this method removes that string from the end of the statement.
`java.lang.String`	`toString()` Gets the contents of the current buffer being built.

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

- Method Detail
  - getProvider
```
public DBObjectProvider getProvider()
```
    Gets the DBObjectProvider that the DBObjects being generated are from/for. This can be null if the generator is being used in isolation.
    
    Returns:
    
    the provider for the DBObjects being generated
  - getDefaultSchema
```
public Schema getDefaultSchema()
```
    Gets the default Schema from the underlying provider.
    
    Returns:
    
    the default schema, or null if one cannot be obtained.
  - getObject
```
public java.lang.Object getObject()
```
    Gets the context object for the current token. For an update token this is the "updated object" from the context's difference.
    
    Returns:
    
    the context object that the token is being generated from.
  - getDifference
```
public Difference getDifference()
```
    Gets the Difference for the current token. This will only return a Difference if the current token is processing the update of a particular object.
    
    Returns:
    
    the Difference for the current token.
  - isUpdate
```
public boolean isUpdate()
```
    Tests whether the current token has a Difference, and that tokens such as {old.name} and {+columns} will therefore work.
    
    Returns:
    
    true if this context can use update tokens
  - findUpdateDifference
```
public Difference findUpdateDifference(DBObject obj)
```
    If we are processing the update of an object, this finds a Difference that shows the changes for the given object. The object must be in the child hierarchy of the root object being generated.
    This will only return a Difference if it contains changes (i.e. !isSame()).
    
    Parameters:
    
    obj - the object to find a difference for (can be the original or updated object).
    
    Returns:
    
    the Difference for the update to given object, or null if we are not generating update DDL, or the object has no Difference (e.g. is not part of the changes), or the object has not changed.
  - getOptions
```
public DDLOptions getOptions()
```
    Gets the DDLOptions that the generation was started with.
    
    Returns:
    
    the options for DDL generation.
  - getLoopObject
```
public java.lang.Object getLoopObject()
```
    Gets the loop object. When processing a loop (e.g. a list of child objects) this object is used for the {each} token.
    
    Returns:
    
    the contextual loop object
  - endCurrentStatement
```
public void endCurrentStatement()
```
    Terminates the current statement that is being appended to. Any append after this is called with start a new statement.
    
    See Also:
    
    append(Object)
  - incrementIndent
```
public void incrementIndent()
```
    Increments the indent which will be appended at the beginning of every new line.
  - decrementIndent
```
public void decrementIndent()
```
    Decrements the indent which will be appended at the beginning of every new line.
  - toString
```
public java.lang.String toString()
```
    Gets the contents of the current buffer being built. This only includes the current statement (and trims any trailing whitespace).
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the current buffer as a String
  - getStatements
```
public java.util.List<java.lang.String> getStatements()
```
    Returns the full list of statements that have been built in this DDL generation. This is always the full list, even if called on a child token context.
    Calling this method ends the current statement.
    
    Returns:
    
    the list of DDL statements that has been generated
    
    See Also:
    
    endCurrentStatement()
  - length
```
public int length()
```
    Gets the length of the current statement being built. If a statement has not been started, or has just been ended this will return 0.
    
    Returns:
    
    the length of the current statement.
  - removeIfEndsWith
```
public void removeIfEndsWith(java.lang.String str)
```
    If the current statement ends with the given string, this method removes that string from the end of the statement. Use to remove unwanted whitespace or loop seperators.
    
    Parameters:
    
    str - the string to remove if present
  - getExternalName
```
public java.lang.String getExternalName(java.lang.String name)
```
    Gets the external version (e.g. quoted where necessary) for the given object name.
  - appendString
```
public void appendString(java.lang.String string,
                         boolean incrementNewlines)
```
    Appends the given string. If the buffer currently ends with a newline and there is an increment defined the new string will be automatically incremented.
    
    Parameters:
    
    string - the string to append to the current buffer
    
    incrementNewlines - whether to also include the current increment on any newlines within string.
  - append
```
public void append(java.lang.Object value)
```
    Appends the given value to the current statement buffer. The behaviour of this method depends on the value. For simple String/primitive values they are simply appended as Strings to the buffer. More custom logic includes:
    - DBObject - the name of the object is appended, quoted if necessary, unless the TokenProcessor has a GLOBAL token registered for the object's type.
    - SchemaObject - as DBObject but the schema name will also be included if it is different to the schema of the object being generated.
    - SQLFragment - the value of getSQLText() is appended.
    - DataTypeUsage - the full ddl for the usage (including attributes) is appended.
    - DBObjectID - the name of the referenced object is appended, quoted and prepended with schema name if necessary.
    - Any array - each object will be appended, comma separated.
    Parameters:
    
    value - the object to append
  - newChildContext
```
public TokenContext newChildContext(java.lang.Object newObj)
```
    Creates a new child context for the given object. Should be used when token processing recurses to process a child object. The new context will have newObj as the target for all tokens.
    
    Parameters:
    
    newObj - the context object (a child of the current context object)
    
    Returns:
    
    a new TokenContext for processing properties of newObj
  - getPropertyValue
```
public java.lang.Object getPropertyValue(java.lang.String propName)
```
    Gets a property value from the context object. If this is an update context and the value for the given property has changed then this will return the value from the updated object.
    
    Parameters:
    
    propName - the name of the property to get the value for
    
    Returns:
    
    the property value

Class TokenContext

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getProvider

getDefaultSchema

getObject

getDifference

isUpdate

findUpdateDifference

getOptions

getLoopObject

endCurrentStatement

incrementIndent

decrementIndent

toString

getStatements

length

removeIfEndsWith

getExternalName

appendString

append

newChildContext

getPropertyValue