Modifier and Type	Class and Description
public static class	Outliner.Branch An outline entry with children.
public abstract static class	Outliner.Entry
public static class	Outliner.Leaf An entry with no children.

Access	Constructor and Description
public	Outliner()

Modifier and Type	Method and Description
public List<Outliner.Entry>	Returns: a list of entries constituting the file outline. Returns an empty list if the indexer hasn't indexed that path. generate(Indexer index holding the file scope idx, String the file for which to build the outline abspath) Create an outline for a file in the index.
public List<Outliner.Entry>	Returns: a list of entries constituting the outline generate(Scope the file scope scope, String the file for which we're building the outline path) Create an outline for a symbol table.

Outliner	back to summary
public Outliner()

Method Detail

generate	back to summary
public List<Outliner.Entry> generate(Indexer idx, String abspath) throws Exception Create an outline for a file in the index. Parameters idx:Indexer index holding the file scope abspath:String the file for which to build the outline Returns:List<Outliner.Entry> a list of entries constituting the file outline. Returns an empty list if the indexer hasn't indexed that path.

generate

back to summary

public List<Outliner.Entry> generate(Indexer idx, String abspath) throws Exception

Create an outline for a file in the index.

Parameters

idx:Indexer: index holding the file scope
abspath:String: the file for which to build the outline

Returns:List<Outliner.Entry>

a list of entries constituting the file outline. Returns an empty list if the indexer hasn't indexed that path.

generate	back to summary
public List<Outliner.Entry> generate(Scope scope, String path) Create an outline for a symbol table. Parameters scope:Scope the file scope path:String the file for which we're building the outline Returns:List<Outliner.Entry> a list of entries constituting the outline

generate

back to summary

public List<Outliner.Entry> generate(Scope scope, String path)

Create an outline for a symbol table.

Parameters

scope:Scope: the file scope
path:String: the file for which we're building the outline

Returns:List<Outliner.Entry>

a list of entries constituting the outline

org.python.indexer back to summary

public Class Outliner.Branch

Class Inheritance

extends Entry

java.lang.Object
org.python.indexer.Outliner.Entry
org.python.indexer.Outliner.Branch

An outline entry with children.

Field Summary

Modifier and Type	Field and Description
private List<Outliner.Entry>	children

Inherited from org.python.indexer.Outliner.Entry:: kind offset qname

Constructor Summary

Access	Constructor and Description
public	Branch()
public	Branch(String qname, int start, NBinding.Kind kind)

Method Summary

Modifier and Type	Method and Description
public List<Outliner.Entry>	getChildren() Implements abstract org.python.indexer.Outliner.Entry.getChildren.
public boolean	hasChildren() Implements abstract org.python.indexer.Outliner.Entry.hasChildren.
public boolean	isBranch() Implements abstract org.python.indexer.Outliner.Entry.isBranch.
public boolean	isLeaf() Implements abstract org.python.indexer.Outliner.Entry.isLeaf.
public void	setChildren(List<Outliner.Entry> children) Implements abstract org.python.indexer.Outliner.Entry.setChildren.

Inherited from org.python.indexer.Outliner.Entry:: asBranch asLeaf getKind getName getOffset getQname setKind setOffset setQname toString toString

Field Detail

children	back to summary
private List<Outliner.Entry> children

Constructor Detail

Branch	back to summary
public Branch()

Branch	back to summary
public Branch(String qname, int start, NBinding.Kind kind)

Method Detail

getChildren	back to summary
public List<Outliner.Entry> getChildren() Implements abstract org.python.indexer.Outliner.Entry.getChildren. Annotations @Override

getChildren

back to summary

public List<Outliner.Entry> getChildren()

Implements abstract org.python.indexer.Outliner.Entry.getChildren.

Annotations

@Override

hasChildren	back to summary
public boolean hasChildren() Implements abstract org.python.indexer.Outliner.Entry.hasChildren. Annotations @Override

hasChildren

back to summary

public boolean hasChildren()

Implements abstract org.python.indexer.Outliner.Entry.hasChildren.

Annotations

@Override

isBranch	back to summary
public boolean isBranch() Implements abstract org.python.indexer.Outliner.Entry.isBranch. Annotations @Override

isBranch

back to summary

public boolean isBranch()

Implements abstract org.python.indexer.Outliner.Entry.isBranch.

Annotations

@Override

isLeaf	back to summary
public boolean isLeaf() Implements abstract org.python.indexer.Outliner.Entry.isLeaf. Annotations @Override

isLeaf

back to summary

public boolean isLeaf()

Implements abstract org.python.indexer.Outliner.Entry.isLeaf.

Annotations

@Override

setChildren	back to summary
public void setChildren(List<Outliner.Entry> children) Implements abstract org.python.indexer.Outliner.Entry.setChildren. Annotations @Override

setChildren

back to summary

public void setChildren(List<Outliner.Entry> children)

Implements abstract org.python.indexer.Outliner.Entry.setChildren.

Annotations

@Override

org.python.indexer back to summary

public abstract Class Outliner.Entry

Class Inheritance

extends Object

java.lang.Object
org.python.indexer.Outliner.Entry

Known Direct Subclasses

org.python.indexer.Outliner.Branch, org.python.indexer.Outliner.Leaf

Field Summary

Modifier and Type	Field and Description
protected NBinding.Kind	kind
protected int	offset
protected String	qname

Constructor Summary

Access	Constructor and Description
public	Entry()
public	Entry(String qname, int offset, NBinding.Kind kind)

Method Summary

Modifier and Type	Method and Description
public Outliner.Branch	asBranch()
public Outliner.Leaf	asLeaf()
public abstract List<Outliner.Entry>	getChildren()
public NBinding.Kind	getKind()
public String	getName() Returns the simple (unqualified) name of the identifier.
public int	getOffset() Returns the file offset of the beginning of the identifier referenced by this outline entry.
public String	getQname()
public abstract boolean	hasChildren()
public abstract boolean	isBranch()
public abstract boolean	isLeaf()
public abstract void	setChildren(List<Outliner.Entry> children)
public void	setKind(NBinding.Kind kind)
public void	setOffset(int offset)
public void	setQname(String qname)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	toString(StringBuilder sb, int depth)

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

Field Detail

kind	back to summary
protected NBinding.Kind kind

offset	back to summary
protected int offset

qname	back to summary
protected String qname

Constructor Detail

Entry	back to summary
public Entry()

Entry	back to summary
public Entry(String qname, int offset, NBinding.Kind kind)

Method Detail

asBranch	back to summary
public Outliner.Branch asBranch()

asLeaf	back to summary
public Outliner.Leaf asLeaf()

getChildren	back to summary
public abstract List<Outliner.Entry> getChildren()

getKind	back to summary
public NBinding.Kind getKind()

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

getOffset	back to summary
public int getOffset() Returns the file offset of the beginning of the identifier referenced by this outline entry.

getQname	back to summary
public String getQname()

hasChildren	back to summary
public abstract boolean hasChildren()

isBranch	back to summary
public abstract boolean isBranch()

isLeaf	back to summary
public abstract boolean isLeaf()

setChildren	back to summary
public abstract void setChildren(List<Outliner.Entry> children)

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

setOffset	back to summary
public void setOffset(int offset)

setQname	back to summary
public void setQname(String qname)

toString back to summary

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

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

toString	back to summary
public void toString(StringBuilder sb, int depth)

org.python.indexer back to summary

public Class Outliner.Leaf

Class Inheritance

extends Entry

java.lang.Object
org.python.indexer.Outliner.Entry
org.python.indexer.Outliner.Leaf

An entry with no children.

Field Summary

Inherited from org.python.indexer.Outliner.Entry:: kind offset qname

Constructor Summary

Access	Constructor and Description
public	Leaf()
public	Leaf(String qname, int start, NBinding.Kind kind)

Method Summary

Modifier and Type	Method and Description
public List<Outliner.Entry>	getChildren() Implements abstract org.python.indexer.Outliner.Entry.getChildren.
public boolean	hasChildren() Implements abstract org.python.indexer.Outliner.Entry.hasChildren.
public boolean	isBranch() Implements abstract org.python.indexer.Outliner.Entry.isBranch.
public boolean	isLeaf() Implements abstract org.python.indexer.Outliner.Entry.isLeaf.
public void	setChildren(List<Outliner.Entry> children) Implements abstract org.python.indexer.Outliner.Entry.setChildren.