FilteredTraverserBase (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.util.containers.FilteredTraverserBase<T,Self>

All Implemented Interfaces:: java.lang.Iterable<T>

Direct Known Subclasses:: JBTreeTraverser, SyntaxTraverser

public abstract class FilteredTraverserBase<T,Self extends FilteredTraverserBase<T,Self>>
extends java.lang.Object
implements java.lang.Iterable<T>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FilteredTraverserBase.EdgeFilter<T>

protected static class FilteredTraverserBase.Meta<T>

Nested Classes
Modifier and Type	Class and Description
`static class`	`FilteredTraverserBase.EdgeFilter<T>`
`protected static class`	`FilteredTraverserBase.Meta<T>`

Constructor Summary

Constructors
Modifier Constructor and Description

protected FilteredTraverserBase(FilteredTraverserBase.Meta<T> meta)

Constructors
Modifier	Constructor and Description
`protected`	`FilteredTraverserBase(FilteredTraverserBase.Meta<T> meta)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`JBIterable<T>`	`bfsTraversal()`
`JBIterable<T>`	`biOrderDfsTraversal()`
`Self`	`cached()` Configures the traverser to cache its structure.
`JBIterable<T>`	`children(T node)` Returns raw children of the specified node as seen by this traverser.
`Self`	`expand(Condition<? super T> c)` Restricts the nodes that can have children by the specified condition.
`Self`	`expandAndFilter(Condition<? super T> c)`
`Self`	`expandAndSkip(Condition<? super T> c)`
`<C> JBIterable<C>`	`filter(java.lang.Class<C> type)`
`Self`	`filter(Condition<? super T> c)`
`Self`	`forceDisregard(Condition<? super T> c)` Excludes the nodes by the specified condition while keeping their edges.
`Self`	`forceIgnore(Condition<? super T> c)` Excludes the nodes by the specified condition from any traversal completely.
`T`	`getRoot()` Not supported if `mapImpl(Function)` is applied.
`java.lang.Iterable<? extends T>`	`getRoots()` Not supported if `mapImpl(Function)` is applied.
`Function<? super T,? extends java.lang.Iterable<? extends T>>`	`getTree()`
`Self`	`interceptTraversal(Function<? super TreeTraversal,? extends TreeTraversal> transform)` Intercepts and alters traversal just before the walking.
`java.util.Iterator<T>`	`iterator()`
`protected <S,SelfS extends FilteredTraverserBase<S,?>> SelfS`	`mapImpl(Function<? super T,? extends S> function)` Returns a tree traverser that applies `function` to each element of this traverser.
`protected <S,SelfS extends FilteredTraverserBase<S,?>> SelfS`	`mapImpl(Function<? super T,? extends S> function, Function<? super S,? extends T> reverse)` Returns a tree traverser that applies `function` to each element of this traverser.
`protected abstract Self`	`newInstance(FilteredTraverserBase.Meta<T> meta)`
`Self`	`onRange(Condition<? super T> rangeCondition)` Configures the traverser to expand and return the nodes within the range only.
`JBIterable<T>`	`postOrderDfsTraversal()`
`JBIterable<T>`	`preOrderDfsTraversal()`
`Self`	`regard(Condition<? super T> c)` Restricts the nodes that can be children by the specified condition while keeping the edges.
`Self`	`reset()` Clears expand, regard and filter conditions, traversal while keeping roots and "forced" properties.
`java.util.List<T>`	`toList()`
`java.util.Set<T>`	`toSet()`
`java.lang.String`	`toString()`
`JBIterable<T>`	`tracingBfsTraversal()`
`JBIterable<T>`	`traverse()`
`JBIterable<T>`	`traverse(TreeTraversal traversal)`
`Self`	`unique()` Configures the traverser to skip already visited nodes.
`Self`	`unique(Function<? super T,java.lang.Object> identity)` Configures the traverser to skip already visited nodes.
`Self`	`withRoot(T root)`
`Self`	`withRoots(java.lang.Iterable<? extends T> roots)`
`Self`	`withRoots(T... roots)`
`Self`	`withTraversal(TreeTraversal type)`

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - FilteredTraverserBase
```
protected FilteredTraverserBase(FilteredTraverserBase.Meta<T> meta)
```
- Method Detail
  - getTree
```
public Function<? super T,? extends java.lang.Iterable<? extends T>> getTree()
```
  - getRoot
```
public final T getRoot()
```
    Not supported if mapImpl(Function) is applied.
  - getRoots
```
public final java.lang.Iterable<? extends T> getRoots()
```
    Not supported if mapImpl(Function) is applied.
  - iterator
```
public final java.util.Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<T>
  - newInstance
```
protected abstract Self newInstance(FilteredTraverserBase.Meta<T> meta)
```
  - traverse
```
public final JBIterable<T> traverse(TreeTraversal traversal)
```
  - traverse
```
public final JBIterable<T> traverse()
```
  - biOrderDfsTraversal
```
public final JBIterable<T> biOrderDfsTraversal()
```
  - preOrderDfsTraversal
```
public final JBIterable<T> preOrderDfsTraversal()
```
  - postOrderDfsTraversal
```
public final JBIterable<T> postOrderDfsTraversal()
```
  - bfsTraversal
```
public final JBIterable<T> bfsTraversal()
```
  - tracingBfsTraversal
```
public final JBIterable<T> tracingBfsTraversal()
```
  - reset
```
public final Self reset()
```
    Clears expand, regard and filter conditions, traversal while keeping roots and "forced" properties.
    
    See Also:
    
    forceIgnore(Condition), forceDisregard(Condition)
  - withRoot
```
public final Self withRoot(T root)
```
  - withRoots
```
public final Self withRoots(T... roots)
```
  - withRoots
```
public final Self withRoots(java.lang.Iterable<? extends T> roots)
```
  - withTraversal
```
public final Self withTraversal(TreeTraversal type)
```
  - expand
```
public final Self expand(Condition<? super T> c)
```
    Restricts the nodes that can have children by the specified condition. Subsequent calls will AND all the conditions.
  - regard
```
public final Self regard(Condition<? super T> c)
```
    Restricts the nodes that can be children by the specified condition while keeping the edges. Subsequent calls will AND all the conditions.
  - expandAndFilter
```
public final Self expandAndFilter(Condition<? super T> c)
```
  - expandAndSkip
```
public final Self expandAndSkip(Condition<? super T> c)
```
  - filter
```
public final Self filter(Condition<? super T> c)
```
  - filter
```
public final <C> JBIterable<C> filter(java.lang.Class<C> type)
```
  - unique
```
public final Self unique()
```
    Configures the traverser to skip already visited nodes.
    This property is not reset by reset() call.
    
    See Also:
    
    unique(Function), TreeTraversal.unique()
  - unique
```
public final Self unique(Function<? super T,java.lang.Object> identity)
```
    Configures the traverser to skip already visited nodes.
    This property is not reset by reset() call.
    
    See Also:
    
    TreeTraversal.unique(Function)
  - cached
```
public final Self cached()
```
    Configures the traverser to cache its structure.
    This property is not reset by reset() call.
    
    See Also:
    
    TreeTraversal#cached()
  - onRange
```
public Self onRange(Condition<? super T> rangeCondition)
```
    Configures the traverser to expand and return the nodes within the range only.
    This property is not reset by reset() call.
    
    See Also:
    
    TreeTraversal.onRange(Condition)
  - forceIgnore
```
public final Self forceIgnore(Condition<? super T> c)
```
    Excludes the nodes by the specified condition from any traversal completely.
    This property is not reset by reset() call.
    
    See Also:
    
    expand(Condition), filter(Condition), reset()
  - forceDisregard
```
public final Self forceDisregard(Condition<? super T> c)
```
    Excludes the nodes by the specified condition while keeping their edges.
    This property is not reset by reset() call.
    
    See Also:
    
    regard(Condition), reset()
  - interceptTraversal
```
public final Self interceptTraversal(Function<? super TreeTraversal,? extends TreeTraversal> transform)
```
    Intercepts and alters traversal just before the walking.
    This property is not reset by reset() call.
    
    See Also:
    
    unique(), onRange(Condition)
  - mapImpl
```
protected <S,SelfS extends FilteredTraverserBase<S,?>> SelfS mapImpl(Function<? super T,? extends S> function,
                                                                     Function<? super S,? extends T> reverse)
```
    Returns a tree traverser that applies function to each element of this traverser. A reverse transform is required if available, otherwise use mapImpl(Function). Subclasses shall provide their own public method to get a more strict return type.
    
    See Also:
    
    JBTreeTraverser.map(Function)
  - mapImpl
```
protected <S,SelfS extends FilteredTraverserBase<S,?>> SelfS mapImpl(Function<? super T,? extends S> function)
```
    Returns a tree traverser that applies function to each element of this traverser. The required reverse transform, a hash map, is built internally while traversing. Prefer mapImpl(Function, Function) if a cheap reverse transform is available. Subclasses shall provide their own public method to get a more strict return type.
    
    See Also:
    
    JBTreeTraverser.map(Function, Function)
  - children
```
public final JBIterable<T> children(T node)
```
    Returns raw children of the specified node as seen by this traverser. Shall be avoided as it circumvents normal traversal procedure. Not supported if mapImpl(Function) is applied.
    
    See Also:
    
    to obtain parents of a node during a traversal
  - toList
```
public final java.util.List<T> toList()
```
  - toSet
```
public final java.util.Set<T> toSet()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class FilteredTraverserBase<T,Self extends FilteredTraverserBase<T,Self>>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

FilteredTraverserBase

Method Detail

getTree

getRoot

getRoots

iterator

newInstance

traverse

traverse

biOrderDfsTraversal

preOrderDfsTraversal

postOrderDfsTraversal

bfsTraversal

tracingBfsTraversal

reset

withRoot

withRoots

withRoots

withTraversal

expand

regard

expandAndFilter

expandAndSkip

filter

filter

unique

unique

cached

onRange

forceIgnore

forceDisregard

interceptTraversal

mapImpl

mapImpl

children

toList

toSet

toString