JavaEWAH 1.2.3 · com.googlecode.javaewah.EWAHIterator

Modifier and Type	Field and Description
private int	pointer The pointer represent the location of the current running length word in the array of words (embedded in the rlw attribute).
pack-priv final RunningLengthWord	rlw The current running length word.
private final int	size The size in words.

Access	Constructor and Description
public	EWAHIterator(final Buffer the buffer buffer) Instantiates a new EWAH iterator.
private	EWAHIterator(int pointer, RunningLengthWord rlw, int size)

Method Summary

Modifier and Type	Method and Description
public Buffer	Returns: the buffer buffer() Access to the buffer
public EWAHIterator	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public static EWAHIterator	Returns: an iterator getEWAHIterator(EWAHCompressedBitmap we want to iterate over bitmap) Allow expert developers to instantiate an EWAHIterator.
public boolean	Returns: true, if successful hasNext() Checks for next.
public int	Returns: the int literalWords() Position of the literal words represented by this running length word.
public RunningLengthWord	Returns: the running length word next() Next running length word.

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

pointer	back to summary
private int pointer The pointer represent the location of the current running length word in the array of words (embedded in the rlw attribute).

rlw	back to summary
pack-priv final RunningLengthWord rlw The current running length word.

size	back to summary
private final int size The size in words.

EWAHIterator	back to summary
public EWAHIterator(final Buffer buffer) Instantiates a new EWAH iterator. Parameters buffer:Buffer the buffer

EWAHIterator	back to summary
private EWAHIterator(int pointer, RunningLengthWord rlw, int size)

Method Detail

buffer	back to summary
public Buffer buffer() Access to the buffer Returns:Buffer the buffer

buffer

back to summary

public Buffer buffer()

Access to the buffer

Returns:Buffer: the buffer

clone back to summary

clone	back to summary
public EWAHIterator clone() throws CloneNotSupportedException Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:EWAHIterator a clone of this instance. Annotations @Override Exceptions CloneNotSupportedException: if the object's class does not support the `Cloneable` interface. Subclasses that override the `clone` method can also throw this exception to indicate that an instance cannot be cloned.

public EWAHIterator clone() throws CloneNotSupportedException

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:EWAHIterator

a clone of this instance.

Annotations

@Override

Exceptions

CloneNotSupportedException:: if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

getEWAHIterator	back to summary
public static EWAHIterator getEWAHIterator(EWAHCompressedBitmap bitmap) Allow expert developers to instantiate an EWAHIterator. Parameters bitmap:EWAHCompressedBitmap we want to iterate over Returns:EWAHIterator an iterator

getEWAHIterator

back to summary

public static EWAHIterator getEWAHIterator(EWAHCompressedBitmap bitmap)

Allow expert developers to instantiate an EWAHIterator.

Parameters

bitmap:EWAHCompressedBitmap: we want to iterate over

Returns:EWAHIterator

an iterator

hasNext	back to summary
public boolean hasNext() Checks for next. Returns:boolean true, if successful

hasNext

back to summary

public boolean hasNext()

Checks for next.

Returns:boolean: true, if successful

literalWords	back to summary
public int literalWords() Position of the literal words represented by this running length word. Returns:int the int

literalWords

back to summary

public int literalWords()

Position of the literal words represented by this running length word.

Returns:int: the int

next	back to summary
public RunningLengthWord next() Next running length word. Returns:RunningLengthWord the running length word

back to summary

public RunningLengthWord next()

Next running length word.

Returns:RunningLengthWord: the running length word

public final Class EWAHIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail