net.percederberg.grammatica.code.csharp
Class CSharpEnumeration

java.lang.Object
  |
  +--net.percederberg.grammatica.code.CodeElement
        |
        +--net.percederberg.grammatica.code.CodeElementContainer
              |
              +--net.percederberg.grammatica.code.csharp.CSharpType
                    |
                    +--net.percederberg.grammatica.code.csharp.CSharpEnumeration
All Implemented Interfaces:
java.lang.Comparable

public class CSharpEnumeration
extends net.percederberg.grammatica.code.csharp.CSharpType

A class generating a C# enumeration declaration.


Field Summary
static int INTERNAL
          The internal access modifier constant.
static int NEW
          The new modifier constant.
static int PRIVATE
          The private access modifier constant.
static int PROTECTED
          The protected access modifier constant.
static int PROTECTED_INTERNAL
          The protected internal access modifier constant.
static int PUBLIC
          The public access modifier constant.
 
Constructor Summary
CSharpEnumeration(int modifiers, java.lang.String name)
          Creates a new enumeration code generator with the specified modifiers.
CSharpEnumeration(java.lang.String name)
          Creates a new enumeration code generator with public access.
 
Method Summary
 void addComment(CSharpComment comment)
          Sets the type comment.
 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, CSharpComment 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.
protected  void print(java.io.PrintWriter out, CodeStyle style, int indent, java.lang.String type)
          Prints the type to the specified stream.
protected  void printSeparator(java.io.PrintWriter out, CodeStyle style, CodeElement prev, CodeElement next)
          Prints the lines separating two elements.
 java.lang.String toString()
          Returns the type name.
 
Methods inherited from class net.percederberg.grammatica.code.CodeElementContainer
addElement, printContents
 
Methods inherited from class net.percederberg.grammatica.code.CodeElement
compareTo
 
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_INTERNAL

public static final int PROTECTED_INTERNAL
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

INTERNAL

public static final int INTERNAL
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

NEW

public static final int NEW
The new modifier constant. May only be used when declared inside another type.

See Also:
Constant Field Values
Constructor Detail

CSharpEnumeration

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

Parameters:
name - the enumeration name

CSharpEnumeration

public CSharpEnumeration(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,
                        CSharpComment 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

printSeparator

protected void printSeparator(java.io.PrintWriter out,
                              CodeStyle style,
                              CodeElement prev,
                              CodeElement next)
Prints the lines separating two elements. By default this method prints a newline before the first element, and between elements with different category numbers.

Overrides:
printSeparator in class net.percederberg.grammatica.code.csharp.CSharpType
Parameters:
out - the output stream
style - the code style to use
prev - the previous element, or null if first
next - the next element, or null if last

toString

public java.lang.String toString()
Returns the type name.

Overrides:
toString in class java.lang.Object
Returns:
the type name

addComment

public void addComment(CSharpComment comment)
Sets the type comment. This method will remove any previous type comment.

Parameters:
comment - the new type comment

print

protected void print(java.io.PrintWriter out,
                     CodeStyle style,
                     int indent,
                     java.lang.String type)
Prints the type to the specified stream.

Parameters:
out - the output stream
style - the code style to use
indent - the indentation level
type - the type name