zserio.ast

Class SymbolReference

java.lang.Object

zserio.ast.SymbolReference

public final class SymbolReference
extends java.lang.Object

The class represents symbol reference. Symbol reference can be for example - reference to constant ('packageName.FooConstant') - reference to enumeration item ('package_name.FooEnumeration.BAR_ENUM_ITEM') - reference to compound field ('package_name.FooCompoundType.field') - reference to package ('root_package.sub_package') Symbol reference is not AST node because it is used by unparsed texts in the following situation: - documentation comment tag see token (@see)

Constructor Summary

Constructors

Constructor and Description
SymbolReference(AstNode ownerNode, java.lang.String symbolReferenceText) Constructor from owner token and text.

Method Summary

Modifier and Type	Method and Description
Package	getReferencedPackage() Gets referenced package.
PackageSymbol	getReferencedPackageSymbol() Gets referenced package symbol.
ScopeSymbol	getReferencedScopeSymbol() Gets referenced scope symbol.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SymbolReference

public SymbolReference(AstNode ownerNode,
                       java.lang.String symbolReferenceText)

Constructor from owner token and text.

Parameters:

ownerNode - AST token which owns the symbol reference test.

symbolReferenceText - Symbol reference in unparsed text format.

Method Detail

getReferencedPackage

public Package getReferencedPackage()

Gets referenced package.

Returns:

Referenced package or null if the reference cannot be resolved.

getReferencedPackageSymbol

public PackageSymbol getReferencedPackageSymbol()

Gets referenced package symbol.

Returns:

Referenced package symbol or null if the reference is a package.

getReferencedScopeSymbol

public ScopeSymbol getReferencedScopeSymbol()

Gets referenced scope symbol.

Returns:

Referenced scope symbol or null if the reference is a package or a package symbol.