Package org.sonar.plugins.python.api.types.v2

Class ClassType

java.lang.Object

org.sonar.plugins.python.api.types.v2.ClassType

All Implemented Interfaces:

PythonType

@Beta
public final class ClassType
extends Object
implements PythonType

ClassType

Field Summary

Fields inherited from interface org.sonar.plugins.python.api.types.v2.PythonType

UNKNOWN

Constructor Summary

Constructors

Constructor	Description
ClassType(String name, String fullyQualifiedName)
ClassType(String name, String fullyQualifiedName, Set<Member> members, List<PythonType> attributes, List<TypeWrapper> superClasses, List<PythonType> metaClasses, boolean hasDecorators, boolean isGeneric, LocationInFile locationInFile)

Method Summary

Modifier and Type	Method	Description
boolean	areAttributesCompatible(ClassType other)
List<PythonType>	attributes()
Optional<LocationInFile>	definitionLocation()
Optional<String>	displayName()
String	fullyQualifiedName()
boolean	hasDecorators()
TriBool	hasMember(String memberName)
boolean	hasMetaClass()
boolean	hasUnresolvedHierarchy()
Optional<PythonType>	inheritedMember(String memberName)
Optional<String>	instanceDisplayName()
TriBool	instancesHaveMember(String memberName)
boolean	isASubClassFrom(ClassType other)
boolean	isCompatibleWith(PythonType another)
boolean	isGeneric()
String	key()
Set<Member>	members()
List<PythonType>	metaClasses()
String	name()
Optional<PythonType>	resolveMember(String memberName)	Attempts to resolve a PythonType's member It should return Optional.empty() when the member doesn't exist, and PythonType.UNKNOWN when the member may exist but can't be resolved
List<TypeWrapper>	superClasses()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sonar.plugins.python.api.types.v2.PythonType

typeSource, unwrappedType

Constructor Details

ClassType

public ClassType(String name,
 String fullyQualifiedName,
 Set<Member> members,
 List<PythonType> attributes,
 List<TypeWrapper> superClasses,
 List<PythonType> metaClasses,
 boolean hasDecorators,
 boolean isGeneric,
 @Nullable
 LocationInFile locationInFile)

ClassType

public ClassType(String name,
 String fullyQualifiedName)

Method Details

displayName

public Optional<String> displayName()

Specified by:

displayName in interface PythonType

instanceDisplayName

public Optional<String> instanceDisplayName()

Specified by:

instanceDisplayName in interface PythonType

isCompatibleWith

public boolean isCompatibleWith(PythonType another)

Specified by:

isCompatibleWith in interface PythonType

isASubClassFrom

@Beta
public boolean isASubClassFrom(ClassType other)

areAttributesCompatible

@Beta
public boolean areAttributesCompatible(ClassType other)

key

public String key()

Specified by:

key in interface PythonType

resolveMember

public Optional<PythonType> resolveMember(String memberName)

Description copied from interface: PythonType

Attempts to resolve a PythonType's member It should return Optional.empty() when the member doesn't exist, and PythonType.UNKNOWN when the member may exist but can't be resolved

Specified by:

resolveMember in interface PythonType

inheritedMember

public Optional<PythonType> inheritedMember(String memberName)

hasUnresolvedHierarchy

public boolean hasUnresolvedHierarchy()

hasMember

public TriBool hasMember(String memberName)

Specified by:

hasMember in interface PythonType

hasMetaClass

public boolean hasMetaClass()

instancesHaveMember

public TriBool instancesHaveMember(String memberName)

definitionLocation

public Optional<LocationInFile> definitionLocation()

Specified by:

definitionLocation in interface PythonType

toString

public String toString()

Overrides:

toString in class Object

name

public String name()

Specified by:

name in interface PythonType

fullyQualifiedName

public String fullyQualifiedName()

members

public Set<Member> members()

attributes

public List<PythonType> attributes()

superClasses

public List<TypeWrapper> superClasses()

metaClasses

public List<PythonType> metaClasses()

hasDecorators

public boolean hasDecorators()

isGeneric

public boolean isGeneric()