SymtabEntry (Red Hat JBoss Enterprise Application Platform 7.4.0.GA public API)

java.lang.Object
- com.sun.tools.corba.se.idl.SymtabEntry

Direct Known Subclasses:

ConstEntry, EnumEntry, ForwardEntry, IncludeEntry, InterfaceEntry, MethodEntry, ModuleEntry, NativeEntry, ParameterEntry, PragmaEntry, PrimitiveEntry, SequenceEntry, StringEntry, StructEntry, TypedefEntry, UnionEntry
```
public class SymtabEntry
extends Object
```
This is the base class for all symbol table entries.

See Also:

AttributeEntry, ConstEntry, EnumEntry, ExceptionEntry, IncludeEntry, InterfaceEntry, MethodEntry, ModuleEntry, ParameterEntry, PragmaEntry, PrimitiveEntry, SequenceEntry, StructEntry, TypedefEntry, UnionEntry

Constructor Summary

Constructors
Constructor and Description

SymtabEntry()

Constructors
Constructor and Description
`SymtabEntry()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()` This is a shallow copy clone
`Comment`	`comment()`
`void`	`comment(Comment comment)`
`SymtabEntry`	`container()` This must be either an InterfaceEntry or a ModuleEntry.
`void`	`container(SymtabEntry newContainer)` This must be either an InterfaceEntry or a ModuleEntry.
`Object`	`dynamicVariable(int key)` Other variables besides the default ones can be dynamically placed into SymTabEntry (and therefore on all symbol table entries) by extenders.
`void`	`dynamicVariable(int key, Object value)` Other variables besides the default ones can be dynamically placed into SymTabEntry (and therefore on all symbol table entries) by extenders.
`boolean`	`emit()` Should this type be emitted?
`void`	`emit(boolean emit)`
`String`	`fullName()`
`void`	`generate(Hashtable symbolTable, PrintWriter stream)` Invoke a generator.
`Generator`	`generator()` Access a generator.
`static int`	`getVariableKey()` Other variables besides the default ones can be dynamically placed into SymTabEntry (and therefore on all symbol table entries) by extenders.
`boolean`	`isReferencable()`
`void`	`isReferencable(boolean value)`
`String`	`module()` Get the name of this entry's module.
`void`	`module(String newName)` Set the module for this entry.
`String`	`name()`
`void`	`name(String newName)` Set the name.
`RepositoryID`	`repositoryID()`
`void`	`repositoryID(RepositoryID id)` Set the repository ID for this entry.
`IncludeEntry`	`sourceFile()` The file name in which this entry was defined.
`void`	`sourceFile(IncludeEntry file)` The file name in which this entry was defined.
`SymtabEntry`	`type()`
`void`	`type(SymtabEntry newType)`
`String`	`typeName()`
`protected void`	`typeName(String typeName)`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SymtabEntry
```
public SymtabEntry()
```
- Method Detail
  - clone
```
public Object clone()
```
    This is a shallow copy clone
    
    Overrides:
    
    clone in class Object
  - fullName
```
public final String fullName()
```
    Returns:
    
    the concatenation of the module and the name, delimited by '/'.
  - module
```
public String module()
```
    Get the name of this entry's module. If there are modules within modules, each module name is separated by '/'.
  - module
```
public void module(String newName)
```
    Set the module for this entry.
    
    Parameters:
    
    newName - the new name of the module.
  - name
```
public String name()
```
    Returns:
    
    the name of this entry.
  - name
```
public void name(String newName)
```
    Set the name.
    
    Parameters:
    
    newName - the new name.
  - typeName
```
public String typeName()
```
    Returns:
    
    the type name of this entry.
  - typeName
```
protected void typeName(String typeName)
```
  - type
```
public SymtabEntry type()
```
    Returns:
    
    the type entry of this entry
  - type
```
public void type(SymtabEntry newType)
```
  - sourceFile
```
public IncludeEntry sourceFile()
```
    The file name in which this entry was defined.
  - sourceFile
```
public void sourceFile(IncludeEntry file)
```
    The file name in which this entry was defined.
  - container
```
public SymtabEntry container()
```
    This must be either an InterfaceEntry or a ModuleEntry. It can be nothing else.
  - container
```
public void container(SymtabEntry newContainer)
```
    This must be either an InterfaceEntry or a ModuleEntry. It can be nothing else.
  - repositoryID
```
public RepositoryID repositoryID()
```
    Returns:
    
    the repository ID for this entry.
  - repositoryID
```
public void repositoryID(RepositoryID id)
```
    Set the repository ID for this entry.
    
    Parameters:
    
    id - the new repository ID.
  - emit
```
public boolean emit()
```
    Should this type be emitted?
  - emit
```
public void emit(boolean emit)
```
  - comment
```
public Comment comment()
```
  - comment
```
public void comment(Comment comment)
```
  - isReferencable
```
public boolean isReferencable()
```
  - isReferencable
```
public void isReferencable(boolean value)
```
  - getVariableKey
```
public static int getVariableKey()
```
    Other variables besides the default ones can be dynamically placed into SymTabEntry (and therefore on all symbol table entries) by extenders. Before such a variable can exist, its key must be obtained by calling getVariableKey.
  - dynamicVariable
```
public void dynamicVariable(int key,
                            Object value)
                     throws NoSuchFieldException
```
    Other variables besides the default ones can be dynamically placed into SymTabEntry (and therefore on all symbol table entries) by extenders. This method assigns the value to the variable of the given key. A valid key must be obtained by calling the method getVariableKey. If the key is invalid, NoSuchFieldException is thrown.
    
    Throws:
    
    NoSuchFieldException
  - dynamicVariable
```
public Object dynamicVariable(int key)
                       throws NoSuchFieldException
```
    Other variables besides the default ones can be dynamically placed into SymTabEntry (and therefore on all symbol table entries) by extenders. This method gets the value of the variable of the given key. A valid key must be obtained by calling the method getVariableKey. If the key is invalid, NoSuchFieldException is thrown.
    
    Throws:
    
    NoSuchFieldException
  - generate
```
public void generate(Hashtable symbolTable,
                     PrintWriter stream)
```
    Invoke a generator. A call to this method is only meaningful for subclasses of SymtabEntry. If called on this class, it is a no-op.
    
    Parameters:
    
    symbolTable - the symbol table is a hash table whose key is a fully qualified type name and whose value is a SymtabEntry or a subclass of SymtabEntry.
    
    stream - the stream to which the generator should sent its output.
  - generator
```
public Generator generator()
```
    Access a generator. A call to this method is only meaningful for subclasses of SymtabEntry. If called on this class, it is a no-op.
    
    Returns:
    
    an object which implements the Generator interface.

Class SymtabEntry

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SymtabEntry

Method Detail

clone

fullName

module

module

name

name

typeName

typeName

type

type

sourceFile

sourceFile

container

container

repositoryID

repositoryID

emit

emit

comment

comment

isReferencable

isReferencable

getVariableKey

dynamicVariable

dynamicVariable

generate

generator