Top Description Inners Methods
com.jogamp.gluegen.cgram.types

public Interface AliasedSymbol

Known Direct Subinterfaces
com.jogamp.gluegen.cgram.types.TypeComparator.AliasedSemanticSymbol
Known Direct Implementers
com.jogamp.gluegen.cgram.types.AliasedSymbol.AliasedSymbolImpl, com.jogamp.gluegen.cgram.types.AliasedSymbol.NoneAliasedSymbol, com.jogamp.gluegen.cgram.types.CompoundType
Imports
java.util.HashSet, .Set
Supports symbol aliasing, i.e. renaming, while preserving all its original names, i.e. aliases.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
AliasedSymbol.AliasedSymbolImpl

public static class
AliasedSymbol.NoneAliasedSymbol

Method Summary

Modifier and TypeMethod and Description
public void
addAliasedName(final String
the new alias to be added, maybe null
origName)

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

public Set<String>
getAliasedNames()

Return all aliases for this symbol, i.e. original names, for this symbol.

public String
getAliasedString()

Return this object's toString() wrapped w/ the current-name and all aliases.

public String
getName()

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

public String
getOrigName()

Return the original-name as set at creation.

public boolean
hasAliases()

Returns true if this symbol has aliases, i.e. either being renamed or aliases-added.

public void
rename(final String
the new current-name, maybe null
newName)

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

Method Detail

addAliasedNameback to summary
public void 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
origName:String

the new alias to be added, maybe null

getAliasedNamesback to summary
public Set<String> 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.

getAliasedStringback to summary
public String getAliasedString()

Return this object's toString() wrapped w/ the current-name and all aliases.

getNameback to summary
public String getName()

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

getOrigNameback to summary
public String getOrigName()

Return the original-name as set at creation.

hasAliasesback to summary
public boolean hasAliases()

Returns true if this symbol has aliases, i.e. either being renamed or aliases-added.

Otherwise false is being returned.

renameback to summary
public void 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
newName:String

the new current-name, maybe null

com.jogamp.gluegen.cgram.types back to summary

public Class AliasedSymbol.AliasedSymbolImpl

extends Object
implements AliasedSymbol
Class Inheritance
  • java.lang.Object
  • com.jogamp.gluegen.cgram.types.AliasedSymbol.AliasedSymbolImpl
All Implemented Interfaces
com.jogamp.gluegen.cgram.types.AliasedSymbol
Known Direct Subclasses
com.jogamp.gluegen.cgram.types.FunctionSymbol, com.jogamp.gluegen.ConstantDefinition

Field Summary

Modifier and TypeField and Description
private final HashSet<String>
aliasedNames

private String
name

private final String
origName

Constructor Summary

AccessConstructor and Description
public
AliasedSymbolImpl(final String origName)

public
AliasedSymbolImpl(final AliasedSymbol.AliasedSymbolImpl o)

Method Summary

Modifier and TypeMethod and Description
public void
addAliasedName(final String
the new alias to be added, maybe null
origName)

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.addAliasedName.

Add the given origName to the list of aliases if not equal current-name.
public Set<String>
getAliasedNames()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getAliasedNames.

Return all aliases for this symbol, i.e. original names, for this symbol.
public String
getAliasedString()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getAliasedString.

Return this object's toString() wrapped w/ the current-name and all aliases.
public String
getName()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getName.

Return the current-name, which is the last renamed-name if issued, or the original-name.
public String
getOrigName()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getOrigName.

Return the original-name as set at creation.
public boolean
hasAliases()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.hasAliases.

Returns true if this symbol has aliases, i.e. either being renamed or aliases-added.
public void
rename(final String
the new current-name, maybe null
newName)

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.rename.

Rename this symbol with the given newName if not equal current-name.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

aliasedNamesback to summary
private final HashSet<String> aliasedNames
nameback to summary
private String name
origNameback to summary
private final String origName

Constructor Detail

AliasedSymbolImplback to summary
public AliasedSymbolImpl(final String origName)
AliasedSymbolImplback to summary
public AliasedSymbolImpl(final AliasedSymbol.AliasedSymbolImpl o)

Method Detail

addAliasedNameback to summary
public void addAliasedName(final String origName)

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.addAliasedName.

Doc from com.jogamp.gluegen.cgram.types.AliasedSymbol.addAliasedName.

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

Operation will be ignored if newName is null.

Parameters
origName:String

the new alias to be added, maybe null

Annotations
@Override
getAliasedNamesback to summary
public Set<String> getAliasedNames()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getAliasedNames.

Doc from 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.

Annotations
@Override
getAliasedStringback to summary
public String getAliasedString()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getAliasedString.

Doc from com.jogamp.gluegen.cgram.types.AliasedSymbol.getAliasedString.

Return this object's toString() wrapped w/ the current-name and all aliases.

Annotations
@Override
getNameback to summary
public String getName()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getName.

Doc from com.jogamp.gluegen.cgram.types.AliasedSymbol.getName.

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

Annotations
@Override
getOrigNameback to summary
public String getOrigName()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getOrigName.

Doc from com.jogamp.gluegen.cgram.types.AliasedSymbol.getOrigName.

Return the original-name as set at creation.

Annotations
@Override
hasAliasesback to summary
public boolean hasAliases()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.hasAliases.

Doc from 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.

Annotations
@Override
renameback to summary
public void rename(final String newName)

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.rename.

Doc from com.jogamp.gluegen.cgram.types.AliasedSymbol.rename.

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
newName:String

the new current-name, maybe null

Annotations
@Override
com.jogamp.gluegen.cgram.types back to summary

public Class AliasedSymbol.NoneAliasedSymbol

extends Object
implements AliasedSymbol
Class Inheritance
  • java.lang.Object
  • com.jogamp.gluegen.cgram.types.AliasedSymbol.NoneAliasedSymbol
All Implemented Interfaces
com.jogamp.gluegen.cgram.types.AliasedSymbol

Field Summary

Modifier and TypeField and Description
private final String
name

Constructor Summary

AccessConstructor and Description
public
NoneAliasedSymbol(final String origName)

Method Summary

Modifier and TypeMethod and Description
public void
addAliasedName(final String
the new alias to be added, maybe null
origName)

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.addAliasedName.

Add the given origName to the list of aliases if not equal current-name.
public Set<String>
getAliasedNames()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getAliasedNames.

Return all aliases for this symbol, i.e. original names, for this symbol.
public String
getAliasedString()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getAliasedString.

Return this object's toString() wrapped w/ the current-name and all aliases.
public String
getName()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getName.

Return the current-name, which is the last renamed-name if issued, or the original-name.
public String
getOrigName()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getOrigName.

Return the original-name as set at creation.
public boolean
hasAliases()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.hasAliases.

Returns true if this symbol has aliases, i.e. either being renamed or aliases-added.
public void
rename(final String
the new current-name, maybe null
newName)

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.rename.

Rename this symbol with the given newName if not equal current-name.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

nameback to summary
private final String name

Constructor Detail

NoneAliasedSymbolback to summary
public NoneAliasedSymbol(final String origName)

Method Detail

addAliasedNameback to summary
public void addAliasedName(final String origName)

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.addAliasedName.

Doc from com.jogamp.gluegen.cgram.types.AliasedSymbol.addAliasedName.

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

Operation will be ignored if newName is null.

Parameters
origName:String

the new alias to be added, maybe null

Annotations
@Override
getAliasedNamesback to summary
public Set<String> getAliasedNames()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getAliasedNames.

Doc from 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.

Annotations
@Override
getAliasedStringback to summary
public String getAliasedString()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getAliasedString.

Doc from com.jogamp.gluegen.cgram.types.AliasedSymbol.getAliasedString.

Return this object's toString() wrapped w/ the current-name and all aliases.

Annotations
@Override
getNameback to summary
public String getName()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getName.

Doc from com.jogamp.gluegen.cgram.types.AliasedSymbol.getName.

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

Annotations
@Override
getOrigNameback to summary
public String getOrigName()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getOrigName.

Doc from com.jogamp.gluegen.cgram.types.AliasedSymbol.getOrigName.

Return the original-name as set at creation.

Annotations
@Override
hasAliasesback to summary
public boolean hasAliases()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.hasAliases.

Doc from 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.

Annotations
@Override
renameback to summary
public void rename(final String newName)

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.rename.

Doc from com.jogamp.gluegen.cgram.types.AliasedSymbol.rename.

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
newName:String

the new current-name, maybe null

Annotations
@Override