Modifier and Type	Class and Description
public static enum	NBinding.Kind In addition to its type, each binding has a `Kind` enumeration that attempts to represent the structural role the name plays in the code.

Modifier and Type	Field and Description
private static final int	BUILTIN
private static final int	DEF_SET_INITIAL_CAPACITY
private List<Def>	defs
private static final int	DEPRECATED
pack-priv NBinding.Kind	kind
pack-priv int	modifiers
private String	name
private static final int	PROVISIONAL
private String	qname
private static final int	READONLY
private static final int	REF_SET_INITIAL_CAPACITY
private Set<Ref>	refs
private static final int	STATIC
private static final int	SYNTHETIC
private NType	type

Access	Constructor and Description
public	NBinding(String id, NNode node, NType type, NBinding.Kind kind)
public	NBinding(String id, Def def, NType type, NBinding.Kind kind)

Method Summary

Modifier and Type	Method and Description
public void	addDef(NNode node) Adds `node` as a definition for this binding.
public void	addDef(Def def) Adds `def` as a definition for this binding.
public void	addDefs(Collection<NNode> nodes)
public void	addRef(NNode node)
public void	addRef(Ref ref)
public int	compareTo(Object the object to be compared. o) Implements java.lang.Comparable.compareTo. Bindings can be sorted by their location for outlining purposes.
public NType	followType() Returns the type, first calling `NUnknownType#follow` on it.
public List<Def>	Returns: the defs getDefs() Return the (possibly empty) set of definitions for this binding.
public String	Returns: the filename associated with the type (if present) or the first definition (if present), otherwise a string describing what is known about the binding's source. getFirstFile() Returns a filename associated with this binding, for debug messages.
public NBinding.Kind	getKind()
public String	getName() Returns the unqualified name.
public int	getNumDefs() Returns the number of definitions found for this binding.
public int	getNumRefs()
public String	getQname() Returns the qualified name.
public Set<Ref>	getRefs() Returns the set of references to this binding.
public Def	getSignatureNode() Returns the first definition, which by convention is treated as the one that introduced the binding.
public NType	getType()
public boolean	hasRefs()
public boolean	isBuiltin()
public boolean	isDeprecated()
public boolean	isProvisional()
public boolean	isReadOnly()
public boolean	isStatic()
public boolean	isSynthetic()
public void	markBuiltin()
public void	markDeprecated()
public void	markReadOnly()
public void	markStatic()
public void	markSynthetic()
public void	removeRef(Ref node)
public void	setKind(NBinding.Kind kind)
public void	setName(String name) Sets the binding's simple (unqualified) name.
public void	setProvisional(boolean isProvisional)
public void	setQname(String qname) Sets the binding's qualified name.
public void	setType(NType type)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

BUILTIN	back to summary
private static final int BUILTIN

DEF_SET_INITIAL_CAPACITY	back to summary
private static final int DEF_SET_INITIAL_CAPACITY

defs	back to summary
private List<Def> defs

DEPRECATED	back to summary
private static final int DEPRECATED

kind	back to summary
pack-priv NBinding.Kind kind

modifiers	back to summary
pack-priv int modifiers

name	back to summary
private String name

PROVISIONAL	back to summary
private static final int PROVISIONAL

qname	back to summary
private String qname

READONLY	back to summary
private static final int READONLY

REF_SET_INITIAL_CAPACITY	back to summary
private static final int REF_SET_INITIAL_CAPACITY

refs	back to summary
private Set<Ref> refs

STATIC	back to summary
private static final int STATIC

SYNTHETIC	back to summary
private static final int SYNTHETIC

type	back to summary
private NType type

Constructor Detail

NBinding	back to summary
public NBinding(String id, NNode node, NType type, NBinding.Kind kind)

NBinding	back to summary
public NBinding(String id, Def def, NType type, NBinding.Kind kind)

Method Detail

addDef	back to summary
public void addDef(NNode node) Adds `node` as a definition for this binding. This is called automatically (when appropriate) by adding the binding to a `Scope`.

addDef	back to summary
public void addDef(Def def) Adds `def` as a definition for this binding. This is called automatically (when appropriate) by adding the binding to a `Scope`. If `node` is an `NUrl`, and this is the binding's only definition, it will be marked as a builtin.

addDefs	back to summary
public void addDefs(Collection<NNode> nodes)

addRef	back to summary
public void addRef(NNode node)

addRef	back to summary
public void addRef(Ref ref)

compareTo	back to summary
public int compareTo(Object o) Implements java.lang.Comparable.compareTo. Bindings can be sorted by their location for outlining purposes. Parameters o:Object Doc from java.lang.Comparable.compareTo. the object to be compared. Returns:int Doc from java.lang.Comparable.compareTo. a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

compareTo

back to summary

public int compareTo(Object o)

Implements java.lang.Comparable.compareTo.

Bindings can be sorted by their location for outlining purposes.

Parameters

o:Object

Doc from java.lang.Comparable.compareTo.

the object to be compared.

Returns:int

Doc from java.lang.Comparable.compareTo.

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

followType	back to summary
public NType followType() Returns the type, first calling `NUnknownType#follow` on it. For external consumers of the index, this is usually preferable to calling `getType`.

getDefs	back to summary
public List<Def> getDefs() Return the (possibly empty) set of definitions for this binding. Returns:List<Def> the defs

getDefs

back to summary

public List<Def> getDefs()

Return the (possibly empty) set of definitions for this binding.

Returns:List<Def>: the defs

getFirstFile	back to summary
public String getFirstFile() Returns a filename associated with this binding, for debug messages. Returns:String the filename associated with the type (if present) or the first definition (if present), otherwise a string describing what is known about the binding's source.

getFirstFile

back to summary

public String getFirstFile()

Returns a filename associated with this binding, for debug messages.

Returns:String: the filename associated with the type (if present) or the first definition (if present), otherwise a string describing what is known about the binding's source.

getKind	back to summary
public NBinding.Kind getKind()

getName	back to summary
public String getName() Returns the unqualified name.

getNumDefs	back to summary
public int getNumDefs() Returns the number of definitions found for this binding.

getNumRefs	back to summary
public int getNumRefs()

getQname	back to summary
public String getQname() Returns the qualified name.

getRefs	back to summary
public Set<Ref> getRefs() Returns the set of references to this binding.

getSignatureNode	back to summary
public Def getSignatureNode() Returns the first definition, which by convention is treated as the one that introduced the binding.

getType	back to summary
public NType getType()

hasRefs	back to summary
public boolean hasRefs()

isBuiltin	back to summary
public boolean isBuiltin()

isDeprecated	back to summary
public boolean isDeprecated()

isProvisional	back to summary
public boolean isProvisional()

isReadOnly	back to summary
public boolean isReadOnly()

isStatic	back to summary
public boolean isStatic()

isSynthetic	back to summary
public boolean isSynthetic()

markBuiltin	back to summary
public void markBuiltin()

markDeprecated	back to summary
public void markDeprecated()

markReadOnly	back to summary
public void markReadOnly()

markStatic	back to summary
public void markStatic()

markSynthetic	back to summary
public void markSynthetic()

removeRef	back to summary
public void removeRef(Ref node)

setKind	back to summary
public void setKind(NBinding.Kind kind)

setName	back to summary
public void setName(String name) Sets the binding's simple (unqualified) name.

setProvisional	back to summary
public void setProvisional(boolean isProvisional)

setQname	back to summary
public void setQname(String qname) Sets the binding's qualified name. This should in general be the same as `binding.getType().getTable().getPath()`.

setType	back to summary
public void setType(NType type)

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

org.python.indexer back to summary

public final Enum NBinding.Kind

Class Inheritance

extends Enum<NBinding.Kind>

java.lang.Object
java.lang.Enum
org.python.indexer.NBinding.Kind

In addition to its type, each binding has a Kind enumeration that attempts to represent the structural role the name plays in the code. This is a rough categorization that takes into account type information, structural (AST) information, and possibly other semantics. It can help IDEs with presentation decisions, and can be useful to expose to users as a parameter for filtering queries on the graph.

Field Summary

Modifier and Type	Field and Description
public static final NBinding.Kind	ATTRIBUTE
public static final NBinding.Kind	CLASS
public static final NBinding.Kind	CONSTRUCTOR
public static final NBinding.Kind	FUNCTION
public static final NBinding.Kind	METHOD
public static final NBinding.Kind	MODULE
public static final NBinding.Kind	PARAMETER
public static final NBinding.Kind	SCOPE
public static final NBinding.Kind	VARIABLE

Constructor Summary

Access	Constructor and Description
private	Kind()

Method Summary

Modifier and Type	Method and Description
public static NBinding.Kind	valueOf(String name)
public static NBinding.Kind[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ATTRIBUTE	back to summary
public static final NBinding.Kind ATTRIBUTE

CLASS	back to summary
public static final NBinding.Kind CLASS

CONSTRUCTOR	back to summary
public static final NBinding.Kind CONSTRUCTOR

FUNCTION	back to summary
public static final NBinding.Kind FUNCTION

METHOD	back to summary
public static final NBinding.Kind METHOD

MODULE	back to summary
public static final NBinding.Kind MODULE

PARAMETER	back to summary
public static final NBinding.Kind PARAMETER

SCOPE	back to summary
public static final NBinding.Kind SCOPE

VARIABLE	back to summary
public static final NBinding.Kind VARIABLE

Constructor Detail

Kind	back to summary
private Kind()

Method Detail

valueOf	back to summary
public static NBinding.Kind valueOf(String name)

values	back to summary
public static NBinding.Kind[] values()

public Class NBinding

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum NBinding.Kind

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail