Overview   Project   Class   Tree   Deprecated   Index 
SourceFlow 1.0.beta API Documentation
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

Org.SourceFlow.VisualBasic
Class VisualBasicMethod

IComparable
   |
   +--CodeElement
         |
         +--VisualBasicMethod

   in VisualBasicMethod.cs

public class VisualBasicMethod
extends CodeElement

A class generating a Visual Basic method declaration.


Field Summary
 override int Category
          Returns a numeric category number for the code element.
 const int FRIEND
          The friend access modifier constant.
 const int MUST_OVERRIDE
          The must override modifier constant.
 const int NOT_OVERRIDABLE
          The not overridable modifier constant.
 const int OVERLOADS
          The overloads modifier constant.
 const int OVERRIDABLE
          The overridable modifier constant.
 const int OVERRIDES
          The overrides modifier constant.
 bool PrintCode
          The print method source code property.
 const int PRIVATE
          The private access modifier constant.
 const int PROTECTED
          The protected access modifier constant.
 const int PROTECTED_FRIEND
          The protected friend access modifier constant.
 const int PUBLIC
          The public access modifier constant.
 const int SHADOWS
          The shadows modifier constant.
 const int SHARED
          The shared modifier constant.
   
Fields inherited from class CodeElement
Category
 
Constructor Summary
VisualBasicMethod( string name )
          Creates a new method with the specified name.
VisualBasicMethod( string name, string args )
          Creates a new method with the specified name and arguments.
VisualBasicMethod( string name, string args, string returnType )
          Creates a new method with the specified arguments.
VisualBasicMethod( int modifiers, string name, string args, string returnType )
          Creates a new method with the specified arguments.
 
Method Summary
 void AddCode( string codeLines )
          Adds one or more lines of actual code.
 virtual void AddComment( VisualBasicComment comment )
          Sets a comment for this method.
 override void Print( StreamWriter output, CodeStyle style, int indent )
          Prints the code element to the specified output stream.
 override string ToString()
          Returns the method name.
   
Methods inherited from class CodeElement
CompareTo, Print, PrintSeparator
 

Field Detail

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

FRIEND

public const int FRIEND;
The friend access modifier constant.

MUST_OVERRIDE

public const int MUST_OVERRIDE;
The must override modifier constant. Cannot be combined with private, shared, overridable, not overridable, or extern.

NOT_OVERRIDABLE

public const int NOT_OVERRIDABLE;
The not overridable modifier constant. Cannot be combined with must override.

OVERLOADS

public const int OVERLOADS;
The overloads modifier constant.

OVERRIDABLE

public const int OVERRIDABLE;
The overridable modifier constant. Cannot be combined with private, shared, overrides, or must override.

OVERRIDES

public const int OVERRIDES;
The overrides modifier constant. Cannot be combined with private, shared, overridable, or shadows.

PrintCode

public bool PrintCode;
The print method source code property. This flag is false if the method is must override or if it has explicitly been set to false.

PRIVATE

public const int PRIVATE;
The private access modifier constant. Cannot be combined with virtual, overrides, or must override.

PROTECTED

public const int PROTECTED;
The protected access modifier constant.

PROTECTED_FRIEND

public const int PROTECTED_FRIEND;
The protected friend access modifier constant.

PUBLIC

public const int PUBLIC;
The public access modifier constant.

SHADOWS

public const int SHADOWS;
The shadows modifier constant. Cannot be combined with overrides.

SHARED

public const int SHARED;
The shared modifier constant. Cannot be combined with overridable, overrides, or must override.


Constructor Detail

VisualBasicMethod

public VisualBasicMethod( string name );
Creates a new method with the specified name. The method will not take any arguments and will return void.
Parameters:
name - the method name

VisualBasicMethod

public VisualBasicMethod( string name, string args );
Creates a new method with the specified name and arguments. The method will return void.
Parameters:
name - the method name
args - the argument list, excluding parenthesis

VisualBasicMethod

public VisualBasicMethod( string name, string args, string returnType );
Creates a new method with the specified arguments.
Parameters:
name - the method name
args - the argument list, excluding parenthesis
returnType - the return type

VisualBasicMethod

public VisualBasicMethod( int modifiers, string name, string args, string returnType );
Creates a new method with the specified arguments.
Parameters:
modifiers - the modifier flags to use
name - the method name
args - the argument list, excluding parenthesis
returnType - the return type


Method Detail

AddCode

public void AddCode( string codeLines );
Adds one or more lines of actual code.
Parameters:
codeLines - the lines of Java code to add

AddComment

public virtual void AddComment( VisualBasicComment comment );
Sets a comment for this method.
Parameters:
comment - the new method comment

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 method name.
Returns:
the method name

 Overview   Project   Class   Tree   Deprecated   Index 
SourceFlow 1.0.beta API Documentation
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD