org.brains2b.struct.position

Class WithinPosition

java.lang.Object

org.brains2b.struct.position.RelativePosition

org.brains2b.struct.position.WithinPosition

All Implemented Interfaces:

Position

public class WithinPosition
extends RelativePosition

Within Position checks if a mark is within (before or after) a supplied anchor.

Version:

[version] [lastrevisiondate]

Author:

dennis@brains2b.nl

See Also:

RelativePosition

Constructor Summary

Constructors

Constructor and Description
WithinPosition(Position mark, Position anchor, int gap, boolean absoluteGap, boolean not) Constructor

Method Summary

Modifier and Type	Method and Description
int	getLength() get the length of the position returned by Position.getPosition(String, int)

Methods inherited from class org.brains2b.struct.position.RelativePosition

getPosition

Methods inherited from class java.lang.Object

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

Constructor Detail

WithinPosition

public WithinPosition(Position mark,
                      Position anchor,
                      int gap,
                      boolean absoluteGap,
                      boolean not)

Constructor

Parameters:

mark - Position, the mark to look for

anchor - Position, anchor to find the mark before or after

gap - int, number of seperable token-sequences between mark and anchor

absoluteGap - boolean, true if the gap should be absolute, false if mark should be within the gap from the anchor

not - boolean, true if the mark should only be returned if it is not after anchor

Method Detail

getLength

public int getLength()

get the length of the position returned by Position.getPosition(String, int)

Returns:

int length of the position, usually the length of the mark the position found, but can be 0