org.sourceflow.visualbasic
Class VisualBasicClass

java.lang.Object
  org.sourceflow.CodeElement
      org.sourceflow.CodeContainer
          org.sourceflow.visualbasic.VisualBasicType
              org.sourceflow.visualbasic.VisualBasicClass

All Implemented Interfaces:

java.lang.Comparable

public class VisualBasicClass

extends VisualBasicType

A class generating a Visual Basic class declaration.

Field Summary

static int	FRIEND The internal access modifier constant.
static int	MUST_INHERIT The must inherit modifier constant.
static int	NOT_INHERITABLE The not inheritable modifier constant.
static int	PRIVATE The private access modifier constant.
static int	PROTECTED The protected access modifier constant.
static int	PROTECTED_FRIEND The protected internal access modifier constant.
static int	PUBLIC The public access modifier constant.
static int	SHADOWS The shadows modifier constant.

Fields inherited from class org.sourceflow.visualbasic.VisualBasicType

comment, extendTypes, modifiers, name

Constructor Summary

VisualBasicClass(int modifiers, java.lang.String name)
Creates a new class code generator with the specified modifiers.

VisualBasicClass(int modifiers, java.lang.String name, java.lang.String extendsClass)
Creates a new class code generator with the specified access modifier that extends the specified class.

VisualBasicClass(int modifiers, java.lang.String name, java.lang.String[] extendClasses)
Creates a new class code generator with the specified access modifier that extends and implements the specified classes or interfaces.

VisualBasicClass(java.lang.String name)
Creates a new class code generator with a public access modifier.

Method Summary

void	addClass(VisualBasicClass member) Adds an inner class as a member.
void	addConstructor(VisualBasicConstructor member) Adds a constructor to the class.
void	addEnumeration(VisualBasicEnumeration member) Adds an enumeration as a member.
void	addMethod(VisualBasicMethod member) Adds a method to the class.
int	category() Returns a numeric category number for the code element.
void	print(java.io.PrintWriter out, CodeStyle style, int indent) Prints the class to the specified stream.

Methods inherited from class org.sourceflow.visualbasic.VisualBasicType

addComment, print, toString

Methods inherited from class org.sourceflow.CodeContainer

addElement, printContents, size

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 internal access modifier constant. May only be used when declared inside another type.

See Also:

Constant Field Values

PROTECTED

public static final int PROTECTED

The protected access modifier constant. May only be used when declared inside another type.

See Also:

Constant Field Values

FRIEND

public static final int FRIEND

The internal access modifier constant.

See Also:

Constant Field Values

PRIVATE

public static final int PRIVATE

The private access modifier constant. May only be used when declared inside another type.

See Also:

Constant Field Values

MUST_INHERIT

public static final int MUST_INHERIT

The must inherit modifier constant.

See Also:

Constant Field Values

NOT_INHERITABLE

public static final int NOT_INHERITABLE

The not inheritable modifier constant.

See Also:

Constant Field Values

SHADOWS

public static final int SHADOWS

The shadows modifier constant. May only be used when declared inside another type.

See Also:

Constant Field Values

Constructor Detail

VisualBasicClass

public VisualBasicClass(java.lang.String name)

Creates a new class code generator with a public access modifier.

Parameters:

name - the class name

VisualBasicClass

public VisualBasicClass(int modifiers,
                        java.lang.String name)

Creates a new class code generator with the specified modifiers.

Parameters:

modifiers - the modifier flag constants

name - the class name

VisualBasicClass

public VisualBasicClass(int modifiers,
                        java.lang.String name,
                        java.lang.String extendsClass)

Creates a new class code generator with the specified access modifier that extends the specified class.

Parameters:

modifiers - the modifier flag constants

name - the class name

extendsClass - the class to extend or implement

VisualBasicClass

public VisualBasicClass(int modifiers,
                        java.lang.String name,
                        java.lang.String[] extendClasses)

Creates a new class code generator with the specified access modifier that extends and implements the specified classes or interfaces.

Parameters:

modifiers - the modifier flag constants

name - the class name

extendClasses - the classes to extend or implement

Method Detail

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

addClass

public void addClass(VisualBasicClass member)

Adds an inner class as a member.

Parameters:

member - the inner class to add

addEnumeration

public void addEnumeration(VisualBasicEnumeration member)

Adds an enumeration as a member.

Parameters:

member - the enumeration to add

addConstructor

public void addConstructor(VisualBasicConstructor member)

Adds a constructor to the class.

Parameters:

member - the member to add

addMethod

public void addMethod(VisualBasicMethod member)

Adds a method to the class.

Parameters:

member - the member to add

print

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

Prints the class to the specified stream.

Specified by:

print in class CodeElement

Parameters:

out - the output stream

style - the code style to use

indent - the indentation level