CursorImpl (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.imglib.cursor.CursorImpl<T>

Type Parameters:

T -

All Implemented Interfaces:

Iterator<T>, Cursor<T>, Iterable, Dimensionality

Direct Known Subclasses:

ArrayCursor, CellCursor, ConstantCursor, ConstantLocalizableByDimCursor, DynamicCursor, LocalNeighborhoodCursor, PlanarCursor, RegionOfInterestCursor, ShapeListLocalizableByDimCursor
```
public abstract class CursorImpl<T extends Type<T>>
extends Object
implements Cursor<T>
```
We use the class CursorImpl instead of implementing methods here so that other classes can only implement Cursor and extend other classes instead. As each CursorImpl is also a Cursor there are no disadvantages for the Cursor implementations.

Author:

Stephan Preibisch, Stephan Saalfeld, Stephan

Field Summary

Fields
Modifier and Type Field and Description

protected Container<T> container

protected boolean debug

protected Image<T> image

protected boolean isClosed

Fields
Modifier and Type	Field and Description
`protected Container<T>`	`container`
`protected boolean`	`debug`
`protected Image<T>`	`image`
`protected boolean`	`isClosed`

Constructor Summary

Constructors
Constructor and Description

CursorImpl(Container<T> container, Image<T> image)

Constructors
Constructor and Description
`CursorImpl(Container<T> container, Image<T> image)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int[]`	`createPositionArray()`
`void`	`fwd(long steps)`
`int`	`getArrayIndex()`
`int[]`	`getDimensions()`
`void`	`getDimensions(int[] position)`
`Image<T>`	`getImage()`
`int`	`getNumDimensions()`
`Container<T>`	`getStorageContainer()`
`boolean`	`isActive()`
`Iterator<T>`	`iterator()`
`T`	`next()`
`void`	`remove()`
`void`	`setDebug(boolean debug)`

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

Methods inherited from interface mpicbg.imglib.cursor.Cursor
close, getStorageIndex, getType, reset

Methods inherited from interface java.util.Iterator
forEachRemaining, hasNext

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

Methods inherited from interface mpicbg.imglib.cursor.Iterable
fwd

- Field Detail
  - image
```
protected final Image<T extends Type<T>> image
```
  - container
```
protected final Container<T extends Type<T>> container
```
  - isClosed
```
protected boolean isClosed
```
  - debug
```
protected boolean debug
```
- Constructor Detail
  - CursorImpl
```
public CursorImpl(Container<T> container,
                  Image<T> image)
```
- Method Detail
  - iterator
```
public Iterator<T> iterator()
```
  - getArrayIndex
```
public int getArrayIndex()
```
    Specified by:
    
    getArrayIndex in interface Cursor<T extends Type<T>>
  - getImage
```
public Image<T> getImage()
```
    Specified by:
    
    getImage in interface Cursor<T extends Type<T>>
  - getStorageContainer
```
public Container<T> getStorageContainer()
```
    Specified by:
    
    getStorageContainer in interface Cursor<T extends Type<T>>
  - isActive
```
public boolean isActive()
```
    Specified by:
    
    isActive in interface Cursor<T extends Type<T>>
  - setDebug
```
public void setDebug(boolean debug)
```
    Specified by:
    
    setDebug in interface Cursor<T extends Type<T>>
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface Iterator<T extends Type<T>>
  - next
```
public T next()
```
    Specified by:
    
    next in interface Iterator<T extends Type<T>>
  - fwd
```
public void fwd(long steps)
```
    Specified by:
    
    fwd in interface Iterable
  - createPositionArray
```
public int[] createPositionArray()
```
    Specified by:
    
    createPositionArray in interface Cursor<T extends Type<T>>
  - getNumDimensions
```
public int getNumDimensions()
```
    Specified by:
    
    getNumDimensions in interface Dimensionality
  - getDimensions
```
public int[] getDimensions()
```
    Specified by:
    
    getDimensions in interface Dimensionality
  - getDimensions
```
public void getDimensions(int[] position)
```
    Specified by:
    
    getDimensions in interface Dimensionality

Class CursorImpl<T extends Type<T>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface mpicbg.imglib.cursor.Cursor

Methods inherited from interface java.util.Iterator

Methods inherited from interface java.lang.Iterable

Methods inherited from interface mpicbg.imglib.cursor.Iterable

Field Detail

image

container

isClosed

debug

Constructor Detail

CursorImpl

Method Detail

iterator

getArrayIndex

getImage

getStorageContainer

isActive

setDebug

remove

next

fwd

createPositionArray

getNumDimensions

getDimensions

getDimensions