documentsourcekind - GroupDocs.Search for Java - API Reference

Packages

java.lang.Object
- java.lang.Enum<DocumentSourceKind>
- - com.groupdocs.search.common.DocumentSourceKind

All Implemented Interfaces:

Serializable, Comparable<DocumentSourceKind>
```
public enum DocumentSourceKind
extends Enum<DocumentSourceKind>
```
Defines the kinds of document sources.

Enum Constant Summary

Enum Constants
Enum Constant and Description

File
The file document source.

Stream
The stream document source.

Structure
The structure document source.

Method Summary

Methods
Modifier and Type	Method and Description
`static DocumentSourceKind`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static DocumentSourceKind[]`	`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
  - File
```
public static final DocumentSourceKind File
```
    The file document source.
  - Stream
```
public static final DocumentSourceKind Stream
```
    The stream document source.
  - Structure
```
public static final DocumentSourceKind Structure
```
    The structure document source.
- Method Detail
  - values
```
public static DocumentSourceKind[] 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 (DocumentSourceKind c : DocumentSourceKind.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DocumentSourceKind 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