Package org.sonar.python.semantic

Class ClassSymbolImpl

java.lang.Object

org.sonar.python.semantic.SymbolImpl

org.sonar.python.semantic.ClassSymbolImpl

All Implemented Interfaces:

ClassSymbol, Symbol

public class ClassSymbolImpl
extends SymbolImpl
implements ClassSymbol

Nested Class Summary

Nested classes/interfaces inherited from interface org.sonar.plugins.python.api.symbols.Symbol

Symbol.Kind

Field Summary

Fields inherited from class org.sonar.python.semantic.SymbolImpl

validForPythonVersions

Constructor Summary

Constructors

Constructor	Description
ClassSymbolImpl(String name, String fullyQualifiedName)
ClassSymbolImpl(String name, String fullyQualifiedName, LocationInFile location)
ClassSymbolImpl(ClassDef classDef, String fullyQualifiedName, PythonFile pythonFile)
ClassSymbolImpl(ClassDescriptor classDescriptor, String symbolName)
ClassSymbolImpl(SymbolsProtos.ClassSymbol classSymbolProto, String moduleName)

Method Summary

Modifier and Type	Method	Description
void	addMembers(Collection<Symbol> members)
void	addSuperClass(Symbol symbol)
boolean	canBeOrExtend(String fullyQualifiedClassName)
boolean	canHaveMember(String memberName)
static ClassSymbol	copyFrom(String name, ClassSymbol classSymbol)
ClassSymbolImpl	copyWithoutUsages()
Set<Symbol>	declaredMembers()
LocationInFile	definitionLocation()
boolean	hasDecorators()
boolean	hasEvaluatedSuperClasses()	Precomputed typeshed class symbols might be "lazily evaluated", i.e. only information about super classes fqn is stored, without having created the actual type hierarchy.
boolean	hasMetaClass()
boolean	hasSuperClassWithoutSymbol()
boolean	hasSuperClassWithUnknownMetaClass()
boolean	hasUnresolvedTypeHierarchy()
boolean	hasUnresolvedTypeHierarchy(boolean includeAmbiguousSymbols)
boolean	isOrExtends(String fullyQualifiedClassName)
boolean	isOrExtends(ClassSymbol other)
String	metaclassFQN()
void	removeUsages()
Optional<Symbol>	resolveMember(String memberName)
void	setHasMetaClass()
void	setHasSuperClassWithoutSymbol()
void	setMetaclassFQN(String metaclassFQN)
void	setSupportsGenerics(boolean supportsGenerics)
boolean	shouldSearchHierarchyInTypeshed()
List<Symbol>	superClasses()
List<String>	superClassesFqn()
boolean	supportsGenerics()

Methods inherited from class org.sonar.python.semantic.SymbolImpl

addChildSymbol, annotatedTypeName, copyWithoutUsages, fullyQualifiedName, getChildrenSymbolByName, inferredType, is, kind, name, setAnnotatedTypeName, setInferredType, setKind, usages, validForPythonVersions

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sonar.plugins.python.api.symbols.Symbol

annotatedTypeName, fullyQualifiedName, is, kind, name, usages

Constructor Details

ClassSymbolImpl

public ClassSymbolImpl(ClassDef classDef,
 @Nullable
 String fullyQualifiedName,
 PythonFile pythonFile)

ClassSymbolImpl

public ClassSymbolImpl(String name,
 @Nullable
 String fullyQualifiedName)

ClassSymbolImpl

public ClassSymbolImpl(String name,
 @Nullable
 String fullyQualifiedName,
 LocationInFile location)

ClassSymbolImpl

public ClassSymbolImpl(ClassDescriptor classDescriptor,
 String symbolName)

ClassSymbolImpl

public ClassSymbolImpl(SymbolsProtos.ClassSymbol classSymbolProto,
 String moduleName)

Method Details

copyFrom

public static ClassSymbol copyFrom(String name,
 ClassSymbol classSymbol)

copyWithoutUsages

public ClassSymbolImpl copyWithoutUsages()

Overrides:

copyWithoutUsages in class SymbolImpl

superClassesFqn

public List<String> superClassesFqn()

Specified by:

superClassesFqn in interface ClassSymbol

shouldSearchHierarchyInTypeshed

public boolean shouldSearchHierarchyInTypeshed()

superClasses

public List<Symbol> superClasses()

Specified by:

superClasses in interface ClassSymbol

addSuperClass

public void addSuperClass(Symbol symbol)

hasUnresolvedTypeHierarchy

public boolean hasUnresolvedTypeHierarchy()

Specified by:

hasUnresolvedTypeHierarchy in interface ClassSymbol

hasUnresolvedTypeHierarchy

public boolean hasUnresolvedTypeHierarchy(boolean includeAmbiguousSymbols)

declaredMembers

public Set<Symbol> declaredMembers()

Specified by:

declaredMembers in interface ClassSymbol

resolveMember

public Optional<Symbol> resolveMember(String memberName)

Specified by:

resolveMember in interface ClassSymbol

hasMetaClass

public boolean hasMetaClass()

Specified by:

hasMetaClass in interface ClassSymbol

canHaveMember

public boolean canHaveMember(String memberName)

Specified by:

canHaveMember in interface ClassSymbol

hasSuperClassWithUnknownMetaClass

public boolean hasSuperClassWithUnknownMetaClass()

definitionLocation

public LocationInFile definitionLocation()

Specified by:

definitionLocation in interface ClassSymbol

isOrExtends

public boolean isOrExtends(String fullyQualifiedClassName)

Specified by:

isOrExtends in interface ClassSymbol

isOrExtends

public boolean isOrExtends(ClassSymbol other)

Specified by:

isOrExtends in interface ClassSymbol

canBeOrExtend

public boolean canBeOrExtend(String fullyQualifiedClassName)

Specified by:

canBeOrExtend in interface ClassSymbol

hasDecorators

public boolean hasDecorators()

Specified by:

hasDecorators in interface ClassSymbol

addMembers

public void addMembers(Collection<Symbol> members)

setHasSuperClassWithoutSymbol

public void setHasSuperClassWithoutSymbol()

setHasMetaClass

public void setHasMetaClass()

setMetaclassFQN

public void setMetaclassFQN(String metaclassFQN)

metaclassFQN

@CheckForNull
public String metaclassFQN()

removeUsages

public void removeUsages()

Overrides:

removeUsages in class SymbolImpl

hasSuperClassWithoutSymbol

public boolean hasSuperClassWithoutSymbol()

supportsGenerics

public boolean supportsGenerics()

setSupportsGenerics

public void setSupportsGenerics(boolean supportsGenerics)

hasEvaluatedSuperClasses

public boolean hasEvaluatedSuperClasses()

Precomputed typeshed class symbols might be "lazily evaluated", i.e. only information about super classes fqn is stored, without having created the actual type hierarchy. This method is used to know if super classes have been already created and added to superClasses. This might happen in the following cases: - Super classes have been already read, hence class symbol is not lazy anymore - superClassesFqns is empty, meaning either this isn't a precomputed typeshed symbol or the class have no superclass.