Package com.helger.commons.text.codepoint

Class AbstractCodepointIterator

java.lang.Object

com.helger.commons.text.codepoint.AbstractCodepointIterator

All Implemented Interfaces:

ICodepointIterator, Iterator<Codepoint>

Direct Known Subclasses:

CodepointIteratorCharArray, CodepointIteratorCharBuffer, CodepointIteratorCharSequence

public abstract class AbstractCodepointIterator
extends Object
implements ICodepointIterator

Provides an iterator over Unicode Codepoints

Author:

Apache Abdera, Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_nLimit
protected int	m_nPosition

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCodepointIterator(int nPosition, int nLimit)

Method Summary

Modifier and Type	Method	Description
protected abstract char	get()
protected abstract char	get(int nIndex)
boolean	isHigh(int index)	Returns true if the char at the specified index is a high surrogate
boolean	isLow(int index)	Returns true if the char at the specified index is a low surrogate
int	lastPosition()
int	limit()
Codepoint	next()
char[]	nextChars()
Codepoint	peek()
Codepoint	peek(int nIndex)
char[]	peekChars()
int	position()
void	position(int n)	Set the iterator position
int	remaining()
CodepointIteratorRestricted	restrict(IntPredicate aFilter, boolean bScanning, boolean bInvert)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.text.codepoint.ICodepointIterator

hasNext, restrict, restrict

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Field Detail

m_nPosition

protected int m_nPosition

m_nLimit

protected int m_nLimit

Constructor Detail

AbstractCodepointIterator

protected AbstractCodepointIterator(@Nonnegative
                                    int nPosition,
                                    @Nonnegative
                                    int nLimit)

Method Detail

get

protected abstract char get()

Returns:

Get the next char

get

protected abstract char get(int nIndex)

Parameters:

nIndex - Index to be retrieved

Returns:

Get the specified char

lastPosition

@CheckForSigned
public int lastPosition()

Specified by:

lastPosition in interface ICodepointIterator

Returns:

the final index position

nextChars

@Nullable
public char[] nextChars()

Specified by:

nextChars in interface ICodepointIterator

Returns:

the next chars. If the codepoint is not supplemental, the char array will have a single member. If the codepoint is supplemental, the char array will have two members, representing the high and low surrogate chars

peekChars

@Nullable
public char[] peekChars()

Specified by:

peekChars in interface ICodepointIterator

Returns:

Peek the next chars in the iterator. If the codepoint is not supplemental, the char array will have a single member. If the codepoint is supplemental, the char array will have two members, representing the high and low surrogate chars

next

@Nonnull
public Codepoint next()

Specified by:

next in interface ICodepointIterator

Specified by:

next in interface Iterator<Codepoint>

Returns:

the next codepoint

peek

@Nullable
public Codepoint peek()

Specified by:

peek in interface ICodepointIterator

Returns:

Peek the next codepoint

peek

@Nullable
public Codepoint peek(int nIndex)

Specified by:

peek in interface ICodepointIterator

Parameters:

nIndex - index

Returns:

Peek the specified codepoint

position

public void position(@Nonnegative
                     int n)

Description copied from interface: ICodepointIterator

Set the iterator position

Specified by:

position in interface ICodepointIterator

Parameters:

n - new position

position

@Nonnegative
public final int position()

Specified by:

position in interface ICodepointIterator

Returns:

the iterator position

limit

@Nonnegative
public final int limit()

Specified by:

limit in interface ICodepointIterator

Returns:

the iterator limit

remaining

@Nonnegative
public int remaining()

Specified by:

remaining in interface ICodepointIterator

Returns:

the remaining iterator size

isHigh

public boolean isHigh(@Nonnegative
                      int index)

Returns true if the char at the specified index is a high surrogate

Specified by:

isHigh in interface ICodepointIterator

Parameters:

index - index

Returns:

true if the char at the specified index is a high surrogate

isLow

public boolean isLow(@Nonnegative
                     int index)

Returns true if the char at the specified index is a low surrogate

Specified by:

isLow in interface ICodepointIterator

Parameters:

index - index

Returns:

true if the char at the specified index is a low surrogate

restrict

@Nonnull
public CodepointIteratorRestricted restrict(@Nonnull
                                            IntPredicate aFilter,
                                            boolean bScanning,
                                            boolean bInvert)

Specified by:

restrict in interface ICodepointIterator