Enum Class ImageMagickEnvironment
java.lang.Object
java.lang.Enum<ImageMagickEnvironment>
de.hybris.platform.mediaconversion.imagemagick.ImageMagickEnvironment
- All Implemented Interfaces:
Serializable,Comparable<ImageMagickEnvironment>,Constable
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 useMAGICK_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.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionSet path to search for configuration files in $HOME/.magick if the directory exists.Set path to the ImageMagick shareable libraries and other dependent libraries.Set the maximum width * height of an image that can reside in the pixel cache memory.Set search path to use when searching for filter process modules (invoked via -process).Set path where ImageMagick can locate its coder modules.Set path where ImageMagick can locate its configuration files Use this search path to search for configuration (.xml) files.Set debug options.Set maximum amount of disk space in bytes permitted for use by the pixel cache.Set maximum number of open pixel cache files.Set path ImageMagick searches for TrueType and Postscript Type1 font files.Set the path at the top of ImageMagick installation directory.Set maximum amount of memory map in bytes to allocate for the pixel cache.Set maximum amount of memory in bytes to allocate for the pixel cache from the heap.Set the maximum number of significant digits to be printed.Set to true to synchronize image to storage device.Set path to store temporary files.Set maximum parallel threads.Periodically yield the CPU for at least the time specified in milliseconds.Set maximum time in seconds. -
Method Summary
Modifier and TypeMethodDescriptionstatic ImageMagickEnvironmentReturns the enum constant of this class with the specified name.static ImageMagickEnvironment[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
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. Images that exceed the area limit are cached to disk (see MAGICK_DISK_LIMIT) and optionally memory-mapped. -
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
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
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
Set debug options. See -debug for a description of debugging options. -
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
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
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
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
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
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
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. 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
Periodically yield the CPU for at least the time specified in milliseconds. -
MAGICK_TIME_LIMIT
Set maximum time in seconds. When this limit is exceeded, an exception is thrown and processing stops.
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-