Package com.helger.commons.text.codepoint

Class DelegatingCodepointIterator

java.lang.Object

com.helger.commons.text.codepoint.DelegatingCodepointIterator

All Implemented Interfaces:

ICodepointIterator, Iterator<Codepoint>

Direct Known Subclasses:

CodepointIteratorRestricted

public class DelegatingCodepointIterator
extends Object
implements ICodepointIterator

Base implementation of a CodepointIterator that filters the output of another ICodepointIterator

Author:

Apache Abdera

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DelegatingCodepointIterator(AbstractCodepointIterator aInternal)

Method Summary

Modifier and Type	Method	Description
protected char	get()
protected char	get(int index)
AbstractCodepointIterator	getInternalIterator()
boolean	hasNext()
boolean	isHigh(int index)
boolean	isLow(int index)
int	lastPosition()
int	limit()
Codepoint	next()
char[]	nextChars()
Codepoint	peek()
Codepoint	peek(int index)
char[]	peekChars()
int	position()
void	position(int position)	Set the iterator position
int	remaining()
void	remove()
CodepointIteratorRestricted	restrict(IntPredicate aFilter)
CodepointIteratorRestricted	restrict(IntPredicate aFilter, boolean bScanning)
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 java.util.Iterator

forEachRemaining

Constructor Detail

DelegatingCodepointIterator

protected DelegatingCodepointIterator(@Nonnull
                                      AbstractCodepointIterator aInternal)

Method Detail

getInternalIterator

@Nonnull
public AbstractCodepointIterator getInternalIterator()

get

protected char get()

get

protected char get(int index)

hasNext

public boolean hasNext()

Specified by:

hasNext in interface ICodepointIterator

Specified by:

hasNext in interface Iterator<Codepoint>

Returns:

true if there are codepoints remaining

lastPosition

public int lastPosition()

Specified by:

lastPosition in interface ICodepointIterator

Returns:

the final index position

isHigh

public boolean isHigh(int index)

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(int index)

Specified by:

isLow in interface ICodepointIterator

Parameters:

index - index

Returns:

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

limit

public int limit()

Specified by:

limit in interface ICodepointIterator

Returns:

the iterator limit

next

@Nullable
public Codepoint next()

Specified by:

next in interface ICodepointIterator

Specified by:

next in interface Iterator<Codepoint>

Returns:

the next codepoint

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

peek

@Nullable
public Codepoint peek()

Specified by:

peek in interface ICodepointIterator

Returns:

Peek the next codepoint

peek

@Nullable
public Codepoint peek(int index)

Specified by:

peek in interface ICodepointIterator

Parameters:

index - index

Returns:

Peek the specified codepoint

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

position

public int position()

Specified by:

position in interface ICodepointIterator

Returns:

the iterator position

remaining

public int remaining()

Specified by:

remaining in interface ICodepointIterator

Returns:

the remaining iterator size

position

public void position(int position)

Description copied from interface: ICodepointIterator

Set the iterator position

Specified by:

position in interface ICodepointIterator

Parameters:

position - new position

remove

public void remove()

Specified by:

remove in interface Iterator<Codepoint>

restrict

@Nonnull
public CodepointIteratorRestricted restrict(@Nonnull
                                            IntPredicate aFilter)

Specified by:

restrict in interface ICodepointIterator

restrict

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

Specified by:

restrict in interface ICodepointIterator

restrict

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

Specified by:

restrict in interface ICodepointIterator