oracle.javatools.parser.java.v2.model

Interface SourceVariable

All Superinterfaces:

Element, JavaElement, JavaHasAnnotations, JavaHasName, JavaHasType, JavaVariable, SourceElement, SourceHasModifiers, SourceHasName, SourceHasType

All Known Subinterfaces:

SourceCatchParameter, SourceEnumConstant, SourceFieldVariable, SourceFormalParameter, SourceLambdaParameter, SourceLocalVariable, SourceMemberVariable

public interface SourceVariable
extends SourceElement, SourceHasModifiers, SourceHasName, SourceHasType, JavaVariable

A SourceVariable is the syntactic (aka symbolic) representation of a java variable, including: field variables, enum constant variables, local variables, and formal parameters.

Field Summary

Fields

Modifier and Type	Field and Description
static SourceVariable[]	EMPTY_ARRAY
static int	PRINT_DECLARATION Constant that can be used as the format argument in calls to SourceVariable.print(int) or SourceVariable.print(PrintWriter, int).
static int	PRINT_FIELD_NAME Constant that can be used as the format argument in calls to SourceVariable.print(int) or SourceVariable.print(PrintWriter, int).
static int	PRINT_TYPE Constant that can be used as the format argument in calls to SourceVariable.print(int) or SourceVariable.print(PrintWriter, int).

Fields inherited from interface oracle.javatools.parser.java.v2.model.SourceElement

CHILDREN_ALL, CHILDREN_BLANKLINES, CHILDREN_COMMENTS, CHILDREN_default, CHILDREN_none, CHILDREN_REGULAR, PRINT_ALL, REFORMAT_ALL, REFORMAT_INDENT

Method Summary

Modifier and Type	Method and Description
SourceExpression	getInitializer() Gets the initializer, null if none.
SourceVariableDeclaration	getOwningDeclaration() Gets the owning variable declaration, null if this is a formal parameter.
void	separateSelf() Extracts sibling variables so that this is the only variable on its variable declaration.
void	setInitializer(SourceExpression expr) Unlinks the current initializer, if any, and links the input element.

Methods inherited from interface oracle.javatools.parser.java.v2.model.SourceHasModifiers

addModifiers, getModifiers, getSourceAnnotations, hasSourceAnnotation, isValidModifiers, removeModifiers, setModifiers

Methods inherited from interface oracle.javatools.parser.java.v2.model.SourceHasName

getName, getNameElement, setName, setNameElement

Methods inherited from interface oracle.javatools.parser.java.v2.model.SourceHasType

getSourceType, setSourceType

Methods inherited from interface oracle.javatools.parser.java.v2.model.SourceElement

addSelf, addSelf, addSelfAfter, addSelfBefore, adjustTextIndentation, clearBinding, cloneSelf, compile, createContext, getBinding, getChildren, getChildren, getCompiledObject, getContainedElements, getContext, getEndOffset, getFirstToken, getJdkVersion, getLastToken, getOwningFile, getOwningSourceFile, getParent, getSiblingAfter, getSiblingAfter, getSiblingBefore, getSiblingBefore, getSiblings, getSiblings, getStartOffset, getSymbolKind, getText, getTokens, getTokens, hasErrors, print, print, print, print, reformatSelf, removeSelf, replaceSelf, resolve, setBinding, setContext, visitSelf

Methods inherited from interface oracle.javatools.parser.java.v2.model.JavaVariable

getConstantValue, isVarargs

Methods inherited from interface oracle.javatools.parser.java.v2.model.JavaHasType

getResolvedType, getUnresolvedType

Methods inherited from interface oracle.javatools.parser.java.v2.model.JavaHasName

getName

Methods inherited from interface oracle.javatools.parser.java.v2.model.JavaHasAnnotations

getAnnotation, getAnnotations, getDeclaredAnnotation, getDeclaredAnnotations, hasAnnotation, hasDeclaredAnnotation

Methods inherited from interface oracle.javatools.parser.java.v2.model.JavaElement

getElementKind, getFile, getModifiers, getOwner, getSourceElement, isDeprecated, isFinal, isHidden, isMandated, isSourceElement, isSynthetic, printCompiledInfo

Field Detail

EMPTY_ARRAY

static final SourceVariable[] EMPTY_ARRAY

PRINT_FIELD_NAME

static final int PRINT_FIELD_NAME

Constant that can be used as the format argument in calls to SourceVariable.print(int) or SourceVariable.print(PrintWriter, int). Prints the variable name followed by array brackets and the initializer.

See Also:

Constant Field Values

PRINT_DECLARATION

static final int PRINT_DECLARATION

Constant that can be used as the format argument in calls to SourceVariable.print(int) or SourceVariable.print(PrintWriter, int). Prints the type followed by the variable name.

See Also:

Constant Field Values

PRINT_TYPE

static final int PRINT_TYPE

Constant that can be used as the format argument in calls to SourceVariable.print(int) or SourceVariable.print(PrintWriter, int). Prints the type.

See Also:

Constant Field Values

Method Detail

getInitializer

SourceExpression getInitializer()

Gets the initializer, null if none.

Returns:

This variable's initializer. Null if none was declared.

setInitializer

void setInitializer(SourceExpression expr)

Unlinks the current initializer, if any, and links the input element.

Throws:

java.lang.IllegalStateException - if the input element is already linked.

getOwningDeclaration

SourceVariableDeclaration getOwningDeclaration()

Gets the owning variable declaration, null if this is a formal parameter.

Returns:

The owning variable declaration.

 Field variables (SRC_FIELD_VARIABLE) return SrcFieldDeclaration's.
 Formal parameters (SRC_FORMAL_PARAMETER) return null.
 Local variables (SRC_LOCAL_VARIABLE) return SrcLocalsDeclaration's.
 

separateSelf

void separateSelf()

Extracts sibling variables so that this is the only variable on its variable declaration. Sibling variables before will be extracted into a new variable declaration that occurs before. Sibling variables after will be extracted into a new variable declaration that occurs after.

For example, suppose we tell "f2" to separate itself:

   int f0 = 0, f1 = 1, f2 = 2, f3 = 3, f4 = 4;
 

Then, the result will be:

   int f0 = 0, f1 = 1;
   int f2 = 2;
   int f3 = 3, f4 = 4;