com.tokenautocomplete

Interface Tokenizer

All Superinterfaces:

android.os.Parcelable

All Known Implementing Classes:

CharacterTokenizer, TagTokenizer

public interface Tokenizer
extends android.os.Parcelable

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
boolean	containsTokenTerminator(java.lang.CharSequence charSequence) Return true if there is a character in the charSequence that should trigger token detection
java.util.List<com.tokenautocomplete.Range>	findTokenRanges(java.lang.CharSequence charSequence, int start, int end) Find all ranges that can be tokenized.
java.lang.CharSequence	wrapTokenValue(java.lang.CharSequence unwrappedTokenValue) Return a complete string representation of the token.

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Method Detail

findTokenRanges

@NonNull
java.util.List<com.tokenautocomplete.Range> findTokenRanges(java.lang.CharSequence charSequence,
                                                                     int start,
                                                                     int end)

Find all ranges that can be tokenized. This system should detect possible tokens both with and without having had wrapTokenValue called on the token string representation

Parameters:

charSequence - the string to search in

start - where the tokenizer should start looking for tokens

end - where the tokenizer should stop looking for tokens

Returns:

all ranges of characters that are valid tokens

wrapTokenValue

@NonNull
java.lang.CharSequence wrapTokenValue(java.lang.CharSequence unwrappedTokenValue)

Return a complete string representation of the token. Often used to add commas after email addresses when creating tokens This value must NOT include any leading or trailing whitespace

Parameters:

unwrappedTokenValue - the value to wrap

Returns:

the token value with any expected delimiter characters

containsTokenTerminator

boolean containsTokenTerminator(java.lang.CharSequence charSequence)

Return true if there is a character in the charSequence that should trigger token detection

Parameters:

charSequence - source text to look at

Returns:

true if charSequence contains a value that should end a token