org.netbeans.lib.editor.util.swing
Class BlockCompare

java.lang.Object
  org.netbeans.lib.editor.util.swing.BlockCompare

public final class BlockCompare
extends Object

Comparing of position block X to position block Y. For example contains() means that block X fully contains Y.

Since:

1.6

Method Summary

boolean	after() Check if block X is after block Y.
boolean	before() Check if block X is before block Y.
boolean	contains() Check if block X contains block Y.
boolean	containsStrict() Check if X contains Y but X and Y are not equal.
boolean	emptyX() Check if block X is empty.
boolean	emptyY() Check if block Y is empty.
boolean	equal() Check if block X has the same boundaries as block Y.
boolean	equalEnd() Check if block X and Y have same end offset.
boolean	equalStart() Check if block X and Y have same start offset.
static BlockCompare	get(int xStartOffset, int xEndOffset, int yStartOffset, int yEndOffset) Compare block X and Y.
boolean	inside() Check if block X is contained in block Y.
boolean	insideStrict() Check if X is inside Y but X and Y are not equal.
boolean	lowerEnd() Check if block X ends lower than Y.
boolean	lowerStart() Check if block X starts lower than Y.
boolean	overlap() Check if there's an overlap at start or end.
boolean	overlapEnd() Check if block X overlaps block Y at its end.
boolean	overlapStart() Check if block X overlaps block Y at its begining.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

get

public static BlockCompare get(int xStartOffset,
                               int xEndOffset,
                               int yStartOffset,
                               int yEndOffset)

Compare block X and Y.

Parameters:

xStartOffset - start offset of block X.

xEndOffset - end offset of block X must be >=xStartOffset.

yStartOffset - start offset of block Y.

yEndOffset - end offset of block Y must be >=yStartOffset.

Returns:

instance of block comparing of X to Y.

before

public boolean before()

Check if block X is before block Y.

Returns:

true if end offset of block X is <= start offset of block Y i.e.
xEndOffset <= yStartOffset.

after

public boolean after()

Check if block X is after block Y.

Returns:

true if start offset of block X is >= end offset of block Y i.e.
xStartOffset >= yEndOffset.

inside

public boolean inside()

Check if block X is contained in block Y.

Returns:

true if block X is contained inside block Y.

insideStrict

public boolean insideStrict()

Check if X is inside Y but X and Y are not equal.

Returns:

true if X is inside Y but they are not equal.

contains

public boolean contains()

Check if block X contains block Y.

Returns:

true if block X contains block Y.

containsStrict

public boolean containsStrict()

Check if X contains Y but X and Y are not equal.

Returns:

true if X contains Y but they are not equal.

equal

public boolean equal()

Check if block X has the same boundaries as block Y.

Returns:

true if start and end offsets of block X are equal to start and end offsets of block Y.

overlap

public boolean overlap()

Check if there's an overlap at start or end.

Returns:

true overlapStart() || overlapEnd().

overlapStart

public boolean overlapStart()

Check if block X overlaps block Y at its begining.

Returns:

true if start offset of block X is before start offset of block Y and end offset of block X is inside block Y i.e.
xStartOffset < yStartOffset and
xEndOffset > yStartOffset and xEndOffset < yEndOffset.

overlapEnd

public boolean overlapEnd()

Check if block X overlaps block Y at its end.

Returns:

true if start offset of block X is inside block Y and end offset of block X is above end of block Y i.e.
xStartOffset > yStartOffset && xStartOffset < yEndOffset
xEndOffset > yEndOffset.

emptyX

public boolean emptyX()

Check if block X is empty.

Returns:

true if start offset of block X equals to end offset of block X.

emptyY

public boolean emptyY()

Check if block Y is empty.

Returns:

true if start offset of block Y equals to end offset of block Y.

equalStart

public boolean equalStart()

Check if block X and Y have same start offset.

Returns:

true if start offset of block X equals to start offset of block Y i.e. xStartOffset == yStartOffset.

Since:

1.44

equalEnd

public boolean equalEnd()

Check if block X and Y have same end offset.

Returns:

true if end offset of block X equals to end offset of block Y i.e. xEndOffset == yEndOffset.

Since:

1.44

lowerStart

public boolean lowerStart()

Check if block X starts lower than Y.

Returns:

true if start offset of block X is < start offset of block Y i.e. xStartOffset < yStartOffset.

Since:

1.44

lowerEnd

public boolean lowerEnd()

Check if block X ends lower than Y.

Returns:

true if end offset of block X is < end offset of block Y i.e. xEndOffset < yEndOffset.

Since:

1.44

toString

public String toString()

Overrides:

toString in class Object