org.sourceflow.visualbasic
Class VisualBasicEnumeration

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

All Implemented Interfaces:

java.lang.Comparable

public class VisualBasicEnumeration

extends VisualBasicType

A class generating a Visual Basic enumeration 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	SHADOWS The shadows modifier constant.

Fields inherited from class org.sourceflow.visualbasic.VisualBasicType

comment, extendTypes, modifiers, name

Constructor Summary

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

VisualBasicEnumeration(java.lang.String name)
Creates a new enumeration code generator with public access.

Method Summary

void	addConstant(java.lang.String name) Adds a constant to the enumeration.
void	addConstant(java.lang.String name, java.lang.String value) Adds a constant to the enumeration.
void	addConstant(java.lang.String name, java.lang.String value, VisualBasicComment comment) Adds a constant to the enumeration.
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.

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 friend 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 friend 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

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

VisualBasicEnumeration

public VisualBasicEnumeration(java.lang.String name)

Creates a new enumeration code generator with public access.

Parameters:

name - the enumeration name

VisualBasicEnumeration

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

Creates a new enumeration code generator with the specified modifiers.

Parameters:

modifiers - the modifier flag constants

name - the enumeration name

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

addConstant

public void addConstant(java.lang.String name)

Adds a constant to the enumeration.

Parameters:

name - the constant name

addConstant

public void addConstant(java.lang.String name,
                        java.lang.String value)

Adds a constant to the enumeration.

Parameters:

name - the constant name

value - the constant value

addConstant

public void addConstant(java.lang.String name,
                        java.lang.String value,
                        VisualBasicComment comment)

Adds a constant to the enumeration.

Parameters:

name - the constant name

value - the constant value, or null

comment - the constant comment

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