Org.SourceFlow.Java
Class JavaVariable

IComparable
   |
   +--CodeElement
         |
         +--JavaVariable

public class JavaVariable

extends CodeElement

A class generating a Java variable declaration. The variable declaration should be placed as a member in a class.

Category

public override 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.

Returns:

the category number

FINAL

public const int FINAL;

The final modifier constant.

PACKAGE_LOCAL

public const int PACKAGE_LOCAL;

The package local access modifier constant (i.e. no modifier).

PRIVATE

public const int PRIVATE;

The private access modifier constant.

PROTECTED

public const int PROTECTED;

The protected access modifier constant.

PUBLIC

public const int PUBLIC;

The public access modifier constant.

STATIC

public const int STATIC;

The static modifier constant.

TRANSIENT

public const int TRANSIENT;

The transient modifier constant.

VOLATILE

public const int VOLATILE;

The volatile modifier constant.

JavaVariable

public JavaVariable( string type, string name );

Creates a new private variable with the specified type and name.

Parameters:

type - the variable type

name - the variable name

JavaVariable

public JavaVariable( int modifiers, string type, 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

JavaVariable

public JavaVariable( string type, string name, string initValue );

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

Parameters:

type - the variable type

name - the variable name

initValue - the initialize value

JavaVariable

public JavaVariable( int modifiers, string type, string name, 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

AddComment

public void AddComment( JavaComment comment );

Adds a comment to this variable.

Parameters:

comment - the comment to add

AddVectorInit

public void AddVectorInit( 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

Print

public override void Print( StreamWriter output, CodeStyle style, int indent );

Prints the code element to the specified output stream.

Parameters:

output - the output stream

style - the code style to use

indent - the indentation level

ToString

public override string ToString();

Returns the variable name.

Returns:

the variable name