org.sourceflow.visualbasic
Class VisualBasicVariable

java.lang.Object
  org.sourceflow.CodeElement
      org.sourceflow.visualbasic.VisualBasicVariable

All Implemented Interfaces:

java.lang.Comparable

public class VisualBasicVariable

extends CodeElement

A class generating a Visual Basic variable declaration.

Field Summary

static int	FRIEND The friend access modifier constant.
static int	PRIVATE The private access modifier constant.
static int	PROTECTED The protected access modifier constant.
static int	PROTECTED_FRIEND The protected friend access modifier constant.
static int	PUBLIC The public access modifier constant.
static int	READONLY The readonly modifier constant.
static int	SHADOWS The shadows modifier constant.
static int	SHARED The shared modifier constant.

Constructor Summary

VisualBasicVariable(int modifiers, java.lang.String type, java.lang.String name)
Creates a new variable with the specified modifiers, type and name.

VisualBasicVariable(int modifiers, java.lang.String type, java.lang.String name, java.lang.String initValue)
Creates a new variable with the specified modifiers, type, name and initializer.

VisualBasicVariable(java.lang.String type, java.lang.String name)
Creates a new variable with the specified type and name.

VisualBasicVariable(java.lang.String type, java.lang.String name, java.lang.String initValue)
Creates a new variable with the specified type, name and initializer.

Method Summary

void	addArrayInit(java.lang.String elementValue) Adds initialization code for an array element value.
void	addComment(VisualBasicComment comment) Adds a comment to this variable.
int	category() Returns a numeric category number for the code element.
void	print(java.io.PrintWriter out, CodeStyle style, int indent) Prints the code element to the specified output stream.
java.lang.String	toString() Returns the variable name.

Methods inherited from class org.sourceflow.CodeElement

compareTo, printSeparator

Methods inherited from class java.lang.Object

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

Field Detail

PUBLIC

public static final int PUBLIC

The public access modifier constant.

See Also:

Constant Field Values

PROTECTED_FRIEND

public static final int PROTECTED_FRIEND

The protected friend access modifier constant.

See Also:

Constant Field Values

PROTECTED

public static final int PROTECTED

The protected access modifier constant.

See Also:

Constant Field Values

FRIEND

public static final int FRIEND

The friend access modifier constant.

See Also:

Constant Field Values

PRIVATE

public static final int PRIVATE

The private access modifier constant.

See Also:

Constant Field Values

SHARED

public static final int SHARED

The shared modifier constant.

See Also:

Constant Field Values

SHADOWS

public static final int SHADOWS

The shadows modifier constant.

See Also:

Constant Field Values

READONLY

public static final int READONLY

The readonly modifier constant.

See Also:

Constant Field Values

Constructor Detail

VisualBasicVariable

public VisualBasicVariable(java.lang.String type,
                           java.lang.String name)

Creates a new variable with the specified type and name.

Parameters:

type - the variable type

name - the variable name

VisualBasicVariable

public VisualBasicVariable(int modifiers,
                           java.lang.String type,
                           java.lang.String name)

Creates a new variable with the specified modifiers, type and name.

Parameters:

modifiers - the modifier flags to use

type - the variable type

name - the variable name

VisualBasicVariable

public VisualBasicVariable(java.lang.String type,
                           java.lang.String name,
                           java.lang.String initValue)

Creates a new variable with the specified type, name and initializer.

Parameters:

type - the variable type

name - the variable name

initValue - the initialize value

VisualBasicVariable

public VisualBasicVariable(int modifiers,
                           java.lang.String type,
                           java.lang.String name,
                           java.lang.String initValue)

Creates a new variable with the specified modifiers, type, name and initializer.

Parameters:

modifiers - the modifier flags to use

type - the variable type

name - the variable name

initValue - the initialize value

Method Detail

toString

public java.lang.String toString()

Returns the variable name.

Returns:

the variable name

addComment

public void addComment(VisualBasicComment comment)

Adds a comment to this variable.

Parameters:

comment - the comment to add

addArrayInit

public void addArrayInit(java.lang.String elementValue)

Adds initialization code for an array element value. Each array element value added will be added last in the list of initialization values. If an init value has been specified with the constructor, it will be added first.

Parameters:

elementValue - the array element value

category

public int category()

Returns a numeric category number for the code element. A lower category number implies that the code element should be placed before code elements with a higher category number within a declaration.

Specified by:

category in class CodeElement

Returns:

the category number

print

public void print(java.io.PrintWriter out,
                  CodeStyle style,
                  int indent)

Prints the code element to the specified output stream.

Specified by:

print in class CodeElement

Parameters:

out - the output stream

style - the code style to use

indent - the indentation level