eve.util

Interface StringCollator

All Known Implementing Classes:

SimpleCollator

public interface StringCollator

A StringCollator is used to compare, order and search Strings.

Author:

Mike

Field Summary

Fields

Modifier and Type	Field and Description
static int	OPTION_IGNORE_CASE An option for any compare() operation.
static int	OPTION_STARTS_WITH An option for the compare() method that compares two character arrays.

Method Summary

Modifier and Type	Method and Description
int	compare(char[] one, int oneOffset, int oneLength, char[] two, int twoOffset, int twoLength, int options) Compare two arrays of characters - or check if the second string starts with the first one.
int	compare(char one, char two, int options) Compare two characters.

Field Detail

OPTION_IGNORE_CASE

static final int OPTION_IGNORE_CASE

An option for any compare() operation.

See Also:

Constant Field Values

OPTION_STARTS_WITH

static final int OPTION_STARTS_WITH

An option for the compare() method that compares two character arrays. It indicates that the comparison should return zero if the two parameter starts with the one parameter.

See Also:

Constant Field Values

Method Detail

compare

int compare(char[] one,
            int oneOffset,
            int oneLength,
            char[] two,
            int twoOffset,
            int twoLength,
            int options)

Compare two arrays of characters - or check if the second string starts with the first one.

Parameters:

one - the first array of characters.

oneOffset - the start of the characters in the first array.

oneLength - the number of characters in the first array.

two - the second array of characters.

twoOffset - the start of the characters in the second array.

twoLength - the number of characters in the second array.

options - any of the OPTION_XXX values OR'ed together.

Returns:

a positive value if one compares to be greater than two, a negative value if one compares to be less than two and 0 if one is considered equal to two OR if two starts with one and the OPTION_STARTS_WITH option is set.

compare

int compare(char one,
            char two,
            int options)

Compare two characters.

Parameters:

one - the first character.

two - the second character.

options - any of the OPTION_XXX values OR'ed together.

Returns:

0 if the characters are considered equal, a positive value if one is greater than two, a negative value if two is greater than one.