Package com.norconex.crawler.web.doc.operations.image.impl

Enum Class FeaturedImageResolverConfig.Storage

java.lang.Object

java.lang.Enum<FeaturedImageResolverConfig.Storage>

com.norconex.crawler.web.doc.operations.image.impl.FeaturedImageResolverConfig.Storage

All Implemented Interfaces:

Serializable, Comparable<FeaturedImageResolverConfig.Storage>, Constable

Enclosing class:

FeaturedImageResolverConfig

public static enum FeaturedImageResolverConfig.Storage
extends Enum<FeaturedImageResolverConfig.Storage>

Type of featured image storages.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISK	Stores the scaled image on the file system, in the format and directory specified.
INLINE	Stores a Base64 string of the scaled image, in the format specified, in a "crawler.featured-image-inline" metadata field.
URL	Default storages.

Method Summary

Modifier and Type	Method	Description
static FeaturedImageResolverConfig.Storage	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FeaturedImageResolverConfig.Storage[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

URL

public static final FeaturedImageResolverConfig.Storage URL

Default storages. The absolute image URL is stored in a "crawler.featured-image-url" metadata field. When only this storages option is set, scaling options and image format have no effect.

INLINE

public static final FeaturedImageResolverConfig.Storage INLINE

Stores a Base64 string of the scaled image, in the format specified, in a "crawler.featured-image-inline" metadata field. The string is ready to be used inline, in a <img src="..."> tag (as an example).

DISK

public static final FeaturedImageResolverConfig.Storage DISK

Stores the scaled image on the file system, in the format and directory specified. A reference to the file on disk is stored in a "crawler.featured-image-path" metadata field.

Method Details

values

public static FeaturedImageResolverConfig.Storage[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static FeaturedImageResolverConfig.Storage valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null