imagelocation - GroupDocs.Search for Java - API Reference

Packages

java.lang.Object
- java.lang.Enum<ImageLocation>
- - com.groupdocs.search.options.ImageLocation

All Implemented Interfaces:

Serializable, Comparable<ImageLocation>
```
public enum ImageLocation
extends Enum<ImageLocation>
```
Specifies an image location.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ContainerItem` An image that is an element in a container file.
`Embedded` An image embedded in another document.
`Separate` An image in separate file.

Method Summary

Methods
Modifier and Type	Method and Description
`static ImageLocation`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ImageLocation[]`	`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
  - Separate
```
public static final ImageLocation Separate
```
    An image in separate file.
  - Embedded
```
public static final ImageLocation Embedded
```
    An image embedded in another document.
  - ContainerItem
```
public static final ImageLocation ContainerItem
```
    An image that is an element in a container file.
- Method Detail
  - values
```
public static ImageLocation[] 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 (ImageLocation c : ImageLocation.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ImageLocation 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