public final enum

CompareOptions

extends Enum<E extends Enum<E>>
java.lang.Object
   ↳ java.lang.Enum<E extends java.lang.Enum<E>>
     ↳ com.pspdfkit.document.search.CompareOptions

Class Overview

Flags for SearchOptions

Summary

Enum Values
CompareOptions  CASE_INSENSITIVE  If specified, text search ignores case. 
CompareOptions  DIACRITIC_INSENSITIVE  If specified, text search ignores diacritics (for example o-umlaut == o). 
CompareOptions  REGULAR_EXPRESSION 

If specified, regular expression search is enabled. 

CompareOptions  SMART_SEARCH  If specified, smart search is enabled. 
Public Methods
static CompareOptions valueOf(String name)
final static CompareOptions[] values()
[Expand]
Inherited Methods
From class java.lang.Enum
From class java.lang.Object
From interface java.lang.Comparable

Enum Values

public static final CompareOptions CASE_INSENSITIVE

If specified, text search ignores case.

public static final CompareOptions DIACRITIC_INSENSITIVE

If specified, text search ignores diacritics (for example o-umlaut == o).

public static final CompareOptions REGULAR_EXPRESSION

If specified, regular expression search is enabled. When using this flag, SMART_SEARCH flag is ignored.


Note: TextSearch makes use of java.util.regex.Pattern API for regex search. Refer to its javadoc for a summary of supported regular expression constructs.

public static final CompareOptions SMART_SEARCH

If specified, smart search is enabled. This includes the following behavior:

  • White-spaces are ignored
  • Hyphens are ignored
  • Searching for quotes or apostrophes matches typographic quotes (“”«»„“) and apostrophes (‘’) too.
This flag is ignored when using REGULAR_EXPRESSION flag.

Public Methods

public static CompareOptions valueOf (String name)

public static final CompareOptions[] values ()