com.vgrs.xcode.common
Interface Filter

All Known Implementing Classes:

UnicodeFilter

public interface Filter

Interface to be implemented by the UnicodeFilter class.

Author:

jcolosi

Method Summary

void	add(java.util.Collection<Range> aRanges) Stores the collection of Range objects in the filter
void	add(int aPoint) Adds the given code point to the filter
void	add(Range aRange) Adds the given range to the filter
void	add(Range[] aRanges) Adds an array of Range objects to the filter
void	assertAll(int[] aPoints) Asserts that the input array of code points exist in the filter.
void	assertNone(int[] aPoints) Asserts that none of the input array of code points exist in the filter.
boolean	has(int aPoint) Check that the input code point exists in the filter.
boolean	hasAll(int[] aPoints) Check that the input array of code points exist in the filter.
boolean	hasNone(int[] aPoints) Check that the input array of code points do not exist in the filter.

Method Detail

add

void add(int aPoint)
         throws XcodeException

Adds the given code point to the filter

Parameters:

aPoint - the code point to add to the filter

Throws:

XcodeException

add

void add(java.util.Collection<Range> aRanges)
         throws XcodeException

Stores the collection of Range objects in the filter

Parameters:

aRanges - collection of Range objects to add to the filter

Throws:

XcodeException

add

void add(Range aRange)
         throws XcodeException

Adds the given range to the filter

Parameters:

aRange - the range to add to the filter

Throws:

XcodeException

add

void add(Range[] aRanges)
         throws XcodeException

Adds an array of Range objects to the filter

Parameters:

aRanges - Array of Range objects to add to the filter

Throws:

XcodeException

assertAll

void assertAll(int[] aPoints)
               throws XcodeException

Asserts that the input array of code points exist in the filter. Even if a single code point does not exist in the filter, an XcodeException is thrown.

Parameters:

aPoints - input array of code points to check if they are in the filter

Throws:

XcodeException

assertNone

void assertNone(int[] aPoints)
                throws XcodeException

Asserts that none of the input array of code points exist in the filter. Even if a single code point exists in the filter, an XcodeException is thrown.

Parameters:

aPoints - input array of code points to check if they are not present in the filter

Throws:

XcodeException

has

boolean has(int aPoint)

Check that the input code point exists in the filter. If the code point does not exist in the filter, a value of

Parameters:

aPoint - code point to check for existence in the filter

Returns:

If the code point does not exist in the filter, a value of false is returned. Otherwise, a value of true is returned.

hasAll

boolean hasAll(int[] aPoints)

Check that the input array of code points exist in the filter.

Parameters:

aPoints - code point to check for existence in the filter

Returns:

If a code point does not exist in the filter, a value of false is returned. Otherwise, a value of true is returned.

hasNone

boolean hasNone(int[] aPoints)

Check that the input array of code points do not exist in the filter.

Parameters:

aPoints - code point to check for non existence in the filter

Returns:

If a code point exists in the filter, a value of false is returned. Otherwise, a value of true is returned.