Packages

com.groupdocs.viewer.fonts

Interfaces

FontSource

Classes

Enums

SearchOption

Skip navigation links

java.lang.Object
- java.lang.Enum<SearchOption>
- - com.groupdocs.viewer.fonts.SearchOption

All Implemented Interfaces:

Serializable, Comparable<SearchOption>
```
public enum SearchOption
extends Enum<SearchOption>
```
Specifies whether to search the current folder, or the current folder and all subfolders.

Enum Constant Summary

Enum Constants
Enum Constant and Description

ALL_FOLDERS
Includes the current folder and all the subfolders in a search.

TOP_FOLDER_ONLY
Includes only the current folder in a search.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static SearchOption`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SearchOption[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ALL_FOLDERS
```
public static final SearchOption ALL_FOLDERS
```
    Includes the current folder and all the subfolders in a search.
  - TOP_FOLDER_ONLY
```
public static final SearchOption TOP_FOLDER_ONLY
```
    Includes only the current folder in a search.
- Method Detail
  - valueOf
```
public static SearchOption valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - values
```
public static SearchOption[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (SearchOption c : SearchOption.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared