GlueGen v2.6.0-rc-20250712
GlueGen, Native Binding Generator for Java™ (public API).
com.jogamp.gluegen.cgram.types.AliasedSymbol Interface Reference

Supports symbol aliasing, i.e. More...

Inheritance diagram for com.jogamp.gluegen.cgram.types.AliasedSymbol:
Collaboration diagram for com.jogamp.gluegen.cgram.types.AliasedSymbol:

Classes

class  AliasedSymbolImpl
 
class  NoneAliasedSymbol
 

Public Member Functions

void rename (final String newName)
 Rename this symbol with the given newName if not equal current-name. More...
 
void addAliasedName (final String origName)
 Add the given origName to the list of aliases if not equal current-name. More...
 
boolean hasAliases ()
 Returns true if this symbol has aliases, i.e. More...
 
Set< String > getAliasedNames ()
 Return all aliases for this symbol, i.e. More...
 
String getOrigName ()
 Return the original-name as set at creation. More...
 
String getName ()
 Return the current-name, which is the last renamed-name if issued, or the original-name. More...
 
String getAliasedString ()
 Return this object's toString() wrapped w/ the current-name and all aliases. More...
 

Detailed Description

Supports symbol aliasing, i.e.

renaming, while preserving all its original names, i.e. aliases.

Definition at line 37 of file AliasedSymbol.java.

Member Function Documentation

◆ addAliasedName()

void com.jogamp.gluegen.cgram.types.AliasedSymbol.addAliasedName ( final String  origName)

Add the given origName to the list of aliases if not equal current-name.

Operation will be ignored if newName is null.

Parameters
origNamethe new alias to be added, maybe null

Implemented in com.jogamp.gluegen.cgram.types.AliasedSymbol.AliasedSymbolImpl, com.jogamp.gluegen.cgram.types.AliasedSymbol.NoneAliasedSymbol, and com.jogamp.gluegen.cgram.types.CompoundType.

◆ getAliasedNames()

Set< String > com.jogamp.gluegen.cgram.types.AliasedSymbol.getAliasedNames ( )

Return all aliases for this symbol, i.e.

original names, for this symbol.

Inclusive original-name, if renamed,

Exclusive current-name.

May return null or a zero sized Set for no aliases.

Implemented in com.jogamp.gluegen.cgram.types.AliasedSymbol.AliasedSymbolImpl, com.jogamp.gluegen.cgram.types.AliasedSymbol.NoneAliasedSymbol, and com.jogamp.gluegen.cgram.types.CompoundType.

Here is the caller graph for this function:

◆ getAliasedString()

String com.jogamp.gluegen.cgram.types.AliasedSymbol.getAliasedString ( )

◆ getName()

String com.jogamp.gluegen.cgram.types.AliasedSymbol.getName ( )

Return the current-name, which is the last renamed-name if issued, or the original-name.

Implemented in com.jogamp.gluegen.cgram.types.AliasedSymbol.AliasedSymbolImpl, and com.jogamp.gluegen.cgram.types.AliasedSymbol.NoneAliasedSymbol.

Here is the caller graph for this function:

◆ getOrigName()

String com.jogamp.gluegen.cgram.types.AliasedSymbol.getOrigName ( )

◆ hasAliases()

boolean com.jogamp.gluegen.cgram.types.AliasedSymbol.hasAliases ( )

Returns true if this symbol has aliases, i.e.

either being renamed or aliases-added.

Otherwise false is being returned.

Implemented in com.jogamp.gluegen.cgram.types.AliasedSymbol.AliasedSymbolImpl, com.jogamp.gluegen.cgram.types.AliasedSymbol.NoneAliasedSymbol, and com.jogamp.gluegen.cgram.types.CompoundType.

◆ rename()

void com.jogamp.gluegen.cgram.types.AliasedSymbol.rename ( final String  newName)

Rename this symbol with the given newName if not equal current-name.

Before renaming the current-name will be added to the list of aliases. while the given newName will be removed.

Operation will be ignored if newName is null.

Parameters
newNamethe new current-name, maybe null

Implemented in com.jogamp.gluegen.cgram.types.AliasedSymbol.AliasedSymbolImpl, com.jogamp.gluegen.cgram.types.AliasedSymbol.NoneAliasedSymbol, and com.jogamp.gluegen.cgram.types.CompoundType.


The documentation for this interface was generated from the following file: