org.eclipse.lsp4j.util

Class DocumentSymbols

java.lang.Object

org.eclipse.lsp4j.util.DocumentSymbols

public final class DocumentSymbols
extends java.lang.Object

Utilities for document symbols.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DocumentSymbols.BreadthFirstIterator<T>
protected static class	DocumentSymbols.DocumentSymbolIterator

Method Summary

Modifier and Type	Method and Description
static java.util.Iterator<DocumentSymbol>	asIterator(DocumentSymbol documentSymbol) Returns an unmodifiable iterator over the document symbols using the breath-first traversal.

Methods inherited from class java.lang.Object

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

Method Detail

asIterator

public static java.util.Iterator<DocumentSymbol> asIterator(DocumentSymbol documentSymbol)

Returns an unmodifiable iterator over the document symbols using the breath-first traversal. That is, all the symbols of depth 0 are returned, then depth 1, then 2, and so on.

It does not guarantee a well defined behavior of the resulting iterator if you modify the structure while the iteration is in progress.