de.hybris.platform.mediaconversion.imagemagick

Enum ImageMagickEnvironment

java.lang.Object

java.lang.Enum<ImageMagickEnvironment>

de.hybris.platform.mediaconversion.imagemagick.ImageMagickEnvironment

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ImageMagickEnvironment>

public enum ImageMagickEnvironment
extends java.lang.Enum<ImageMagickEnvironment>

ImageMagick environment variables as defined on Customize ImageMagick With Resources. All relevant environment variables currently set (for the process of the JVM) will be set to the environment of the image magick executable as well. By default only two environment variables will be set:

• MAGICK_CONFIGURE_PATH: to the configuration path to use
• MAGICK_TEMPORARY_PATH: to the temporary path of the hybris platform

Note: the environment variables take precedence!

Tip: you can restrict the maximum conversion time by setting the MAGICK_TIME_LIMIT environment variable.

See Also:

Customize ImageMagick With Resources, System.getenv()

Enum Constant Summary

Enum Constants

Enum Constant and Description
HOME Set path to search for configuration files in $HOME/.magick if the directory exists.
LD_LIBRARY_PATH Set path to the ImageMagick shareable libraries and other dependent libraries.
MAGICK_AREA_LIMIT Set the maximum width * height of an image that can reside in the pixel cache memory.
MAGICK_CODER_FILTER_PATH Set search path to use when searching for filter process modules (invoked via -process).
MAGICK_CODER_MODULE_PATH Set path where ImageMagick can locate its coder modules.
MAGICK_CONFIGURE_PATH Set path where ImageMagick can locate its configuration files Use this search path to search for configuration (.xml) files.
MAGICK_DEBUG Set debug options.
MAGICK_DISK_LIMIT Set maximum amount of disk space in bytes permitted for use by the pixel cache.
MAGICK_FILE_LIMIT Set maximum number of open pixel cache files.
MAGICK_FONT_PATH Set path ImageMagick searches for TrueType and Postscript Type1 font files.
MAGICK_HOME Set the path at the top of ImageMagick installation directory.
MAGICK_MAP_LIMIT Set maximum amount of memory map in bytes to allocate for the pixel cache.
MAGICK_MEMORY_LIMIT Set maximum amount of memory in bytes to allocate for the pixel cache from the heap.
MAGICK_PRECISION Set the maximum number of significant digits to be printed.
MAGICK_SYNCHRONIZE Set to true to synchronize image to storage device.
MAGICK_TEMPORARY_PATH Set path to store temporary files.
MAGICK_THREAD_LIMIT Set maximum parallel threads.
MAGICK_THROTTLE Periodically yield the CPU for at least the time specified in milliseconds.
MAGICK_TIME_LIMIT Set maximum time in seconds.

Method Summary

Modifier and Type	Method and Description
static ImageMagickEnvironment	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ImageMagickEnvironment[]	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

HOME

public static final ImageMagickEnvironment HOME

Set path to search for configuration files in $HOME/.magick if the directory exists.

LD_LIBRARY_PATH

public static final ImageMagickEnvironment LD_LIBRARY_PATH

Set path to the ImageMagick shareable libraries and other dependent libraries.

MAGICK_AREA_LIMIT

public static final ImageMagickEnvironment MAGICK_AREA_LIMIT

Set the maximum width * height of an image that can reside in the pixel cache memory. Images that exceed the area limit are cached to disk (see MAGICK_DISK_LIMIT) and optionally memory-mapped.

MAGICK_CODER_FILTER_PATH

public static final ImageMagickEnvironment MAGICK_CODER_FILTER_PATH

Set search path to use when searching for filter process modules (invoked via -process). This path permits the user to extend ImageMagick's image processing functionality by adding loadable modules to a preferred location rather than copying them into the ImageMagick installation directory. The formatting of the search path is similar to operating system search paths (i.e. colon delimited for Unix, and semi-colon delimited for Microsoft Windows). This user specified search path is searched before trying the default search path.

MAGICK_CODER_MODULE_PATH

public static final ImageMagickEnvironment MAGICK_CODER_MODULE_PATH

Set path where ImageMagick can locate its coder modules. This path permits the user to arbitrarily extend the image formats supported by ImageMagick by adding loadable coder modules from an preferred location rather than copying them into the ImageMagick installation directory. The formatting of the search path is similar to operating system search paths (i.e. colon delimited for Unix, and semi-colon delimited for Microsoft Windows). This user specified search path is searched before trying the default search path.

MAGICK_CONFIGURE_PATH

public static final ImageMagickEnvironment MAGICK_CONFIGURE_PATH

Set path where ImageMagick can locate its configuration files Use this search path to search for configuration (.xml) files. The formatting of the search path is similar to operating system search paths (i.e. colon delimited for Unix, and semi-colon delimited for Microsoft Windows). This user specified search path is searched before trying the default search path.

MAGICK_DEBUG

public static final ImageMagickEnvironment MAGICK_DEBUG

Set debug options. See -debug for a description of debugging options.

MAGICK_DISK_LIMIT

public static final ImageMagickEnvironment MAGICK_DISK_LIMIT

Set maximum amount of disk space in bytes permitted for use by the pixel cache. When this limit is exceeded, the pixel cache is not be created and an error message is returned.

MAGICK_FILE_LIMIT

public static final ImageMagickEnvironment MAGICK_FILE_LIMIT

Set maximum number of open pixel cache files. When this limit is exceeded, any subsequent pixels cached to disk are closed and reopened on demand. This behavior permits a large number of images to be accessed simultaneously on disk, but with a speed penalty due to repeated open/close calls.

MAGICK_FONT_PATH

public static final ImageMagickEnvironment MAGICK_FONT_PATH

Set path ImageMagick searches for TrueType and Postscript Type1 font files. This path is only consulted if a particular font file is not found in the current directory.

MAGICK_HOME

public static final ImageMagickEnvironment MAGICK_HOME

Set the path at the top of ImageMagick installation directory. This path is consulted by uninstalled builds of ImageMagick which do not have their location hard-coded or set by an installer.

MAGICK_MAP_LIMIT

public static final ImageMagickEnvironment MAGICK_MAP_LIMIT

Set maximum amount of memory map in bytes to allocate for the pixel cache. When this limit is exceeded, the image pixels are cached to disk (see MAGICK_DISK_LIMIT).

MAGICK_MEMORY_LIMIT

public static final ImageMagickEnvironment MAGICK_MEMORY_LIMIT

Set maximum amount of memory in bytes to allocate for the pixel cache from the heap. When this limit is exceeded, the image pixels are cached to memory-mapped disk (see MAGICK_MAP_LIMIT).

MAGICK_PRECISION

public static final ImageMagickEnvironment MAGICK_PRECISION

Set the maximum number of significant digits to be printed.

MAGICK_SYNCHRONIZE

public static final ImageMagickEnvironment MAGICK_SYNCHRONIZE

Set to true to synchronize image to storage device.

MAGICK_TEMPORARY_PATH

public static final ImageMagickEnvironment MAGICK_TEMPORARY_PATH

Set path to store temporary files.

MAGICK_THREAD_LIMIT

public static final ImageMagickEnvironment MAGICK_THREAD_LIMIT

Set maximum parallel threads. Many ImageMagick algorithms run in parallel on multi-processor systems. Use this environment variable to set the maximum number of threads that are permitted to run in parallel.

MAGICK_THROTTLE

public static final ImageMagickEnvironment MAGICK_THROTTLE

Periodically yield the CPU for at least the time specified in milliseconds.

MAGICK_TIME_LIMIT

public static final ImageMagickEnvironment MAGICK_TIME_LIMIT

Set maximum time in seconds. When this limit is exceeded, an exception is thrown and processing stops.

Method Detail

values

public static ImageMagickEnvironment[] 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 (ImageMagickEnvironment c : ImageMagickEnvironment.values())
    System.out.println(c);

Returns:

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

valueOf

public static ImageMagickEnvironment valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null