NBinding (jython-slim 2.7.3rc1 API)

java.lang.Object
- org.python.indexer.NBinding

All Implemented Interfaces:

java.lang.Comparable<java.lang.Object>
```
public class NBinding
extends java.lang.Object
implements java.lang.Comparable<java.lang.Object>
```
An NBinding collects information about a fully qualified name (qname) in the code graph.
Each qname has an associated NType. When a particular qname is assigned values of different types at different locations, its type is represented as a NUnionType.
Each qname has a set of one or more definitions, and a set of zero or more references. Definitions and references correspond to code locations.

Nested Class Summary

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

Constructor Summary

Constructors
Constructor and Description
`NBinding(java.lang.String id, Def def, NType type, NBinding.Kind kind)`
`NBinding(java.lang.String id, NNode node, NType type, NBinding.Kind kind)`

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - NBinding
```
public NBinding(java.lang.String id,
                NNode node,
                NType type,
                NBinding.Kind kind)
```
  - NBinding
```
public NBinding(java.lang.String id,
                Def def,
                NType type,
                NBinding.Kind kind)
```
- Method Detail
  - setName
```
public void setName(java.lang.String name)
```
    Sets the binding's simple (unqualified) name.
  - getName
```
public java.lang.String getName()
```
    Returns the unqualified name.
  - setQname
```
public void setQname(java.lang.String qname)
```
    Sets the binding's qualified name. This should in general be the same as binding.getType().getTable().getPath().
  - getQname
```
public java.lang.String getQname()
```
    Returns the qualified name.
  - addDef
```
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.
  - addDefs
```
public void addDefs(java.util.Collection<NNode> nodes)
```
  - addDef
```
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.
  - addRef
```
public void addRef(NNode node)
```
  - addRef
```
public void addRef(Ref ref)
```
  - removeRef
```
public void removeRef(Ref node)
```
  - getSignatureNode
```
public Def getSignatureNode()
```
    Returns the first definition, which by convention is treated as the one that introduced the binding.
  - setType
```
public void setType(NType type)
```
  - getType
```
public NType getType()
```
  - followType
```
public NType followType()
```
    Returns the type, first calling NUnknownType.follow(org.python.indexer.types.NType) on it. For external consumers of the index, this is usually preferable to calling getType().
  - setKind
```
public void setKind(NBinding.Kind kind)
```
  - getKind
```
public NBinding.Kind getKind()
```
  - markStatic
```
public void markStatic()
```
  - isStatic
```
public boolean isStatic()
```
  - markSynthetic
```
public void markSynthetic()
```
  - isSynthetic
```
public boolean isSynthetic()
```
  - markReadOnly
```
public void markReadOnly()
```
  - isReadOnly
```
public boolean isReadOnly()
```
  - isDeprecated
```
public boolean isDeprecated()
```
  - markDeprecated
```
public void markDeprecated()
```
  - isBuiltin
```
public boolean isBuiltin()
```
  - markBuiltin
```
public void markBuiltin()
```
  - setProvisional
```
public void setProvisional(boolean isProvisional)
```
  - isProvisional
```
public boolean isProvisional()
```
  - compareTo
```
public int compareTo(java.lang.Object o)
```
    Bindings can be sorted by their location for outlining purposes.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<java.lang.Object>
  - getDefs
```
public java.util.List<Def> getDefs()
```
    Return the (possibly empty) set of definitions for this binding.
    
    Returns:
    
    the defs
  - getNumDefs
```
public int getNumDefs()
```
    Returns the number of definitions found for this binding.
  - hasRefs
```
public boolean hasRefs()
```
  - getNumRefs
```
public int getNumRefs()
```
  - getRefs
```
public java.util.Set<Ref> getRefs()
```
    Returns the set of references to this binding.
  - getFirstFile
```
public java.lang.String getFirstFile()
```
    Returns a filename associated with this binding, for debug messages.
    
    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.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class NBinding

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NBinding

NBinding

Method Detail

setName

getName

setQname

getQname

addDef

addDefs

addDef

addRef

addRef

removeRef

getSignatureNode

setType

getType

followType

setKind

getKind

markStatic

isStatic

markSynthetic

isSynthetic

markReadOnly

isReadOnly

isDeprecated

markDeprecated

isBuiltin

markBuiltin

setProvisional

isProvisional

compareTo

getDefs

getNumDefs

hasRefs

getNumRefs

getRefs

getFirstFile

toString