A C D E F G I L O P Q R S V W

A

addImage(File) - Method in class org.gm4java.im4java.GMOperation

Add image to operation.

addRawArg(String) - Method in class org.gm4java.im4java.GMOperation

Add raw text to the list of arguments.

asAnnotation() - Method in enum org.gm4java.im4java.GMOperation.GeometryAnnotation

Serializes option for GraphicsMagick command-line.

asAnnotation() - Method in enum org.gm4java.im4java.GMOperation.RotationAnnotation

Serializes option for GraphicsMagick command-line.

C

close() - Method in interface org.gm4java.engine.GMConnection

Close GMConnection and destroy the underlying GraphicsMagick process.

D

DEFAULT_EVICT_AFTER_NUMBER_OF_USE - Static variable in class org.gm4java.engine.support.GMConnectionPoolConfig

Default value for the number of times a GraphicsMagick process can be used to execute commands before it gets evicted from pool.

DEFAULT_GM_PATH - Static variable in class org.gm4java.engine.support.GMConnectionPoolConfig

Default path to GraphcisMagick executable.

DEFAULT_GM_PATH - Static variable in class org.gm4java.engine.support.SimpleGMService

Default path to GraphcisMagick executable is simply "gm".

drawText(String, int, int) - Method in class org.gm4java.im4java.GMOperation

Draws text overlay on image with the upper-right corner defined by the offsetX and offsetY parameters.

E

execute(String, String...) - Method in interface org.gm4java.engine.GMExecutor

Executes the command using the underlying GraphicsMagick process.

execute(List<String>) - Method in interface org.gm4java.engine.GMExecutor

Executes the command using the underlying GraphicsMagick process.

execute(String, String...) - Method in interface org.gm4java.engine.GMService

Executes the GraphisMagick command and return the result.

execute(List<String>) - Method in interface org.gm4java.engine.GMService

Executes the command using the underlying GraphicsMagick process.

execute(String, String...) - Method in class org.gm4java.engine.support.PooledGMService

Executes the GraphisMagick command and return the result.

execute(List<String>) - Method in class org.gm4java.engine.support.PooledGMService

execute(String, String...) - Method in class org.gm4java.engine.support.SimpleGMService

Executes the GraphisMagick command and return the result.

execute(List<String>) - Method in class org.gm4java.engine.support.SimpleGMService

Executes the command using the underlying GraphicsMagick process.

F

font(String, int, String) - Method in class org.gm4java.im4java.GMOperation

Defines font for text overlay.

G

getConnection() - Method in interface org.gm4java.engine.GMService

Gets an instance of GMConnection.

getConnection() - Method in class org.gm4java.engine.support.PooledGMService

Gets an instance of GMConnection.

getConnection() - Method in class org.gm4java.engine.support.SimpleGMService

Gets an instance of GMConnection.

getEvictAfterNumberOfUse() - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Get the number of times a GraphicsMagick process can be used to execute commands before it gets evicted and destroyed.

getGMPath() - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Gets the path to GraphicsMagick executable.

getGMPath() - Method in class org.gm4java.engine.support.SimpleGMService

Gets the path to GraphicsMagick executable set by SimpleGMService.setGMPath(String) or SimpleGMService.DEFAULT_GM_PATH if it was not explicitly set.

getMaxActive() - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Returns the maximum number of GMConnections that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time.

getMaxIdle() - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Returns the cap on the number of "idle" instances in the pool.

getMaxWait() - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Returns the maximum amount of time (in milliseconds) the PooledGMService.getConnection() method should block before throwing an exception when the pool is exhausted and the "when exhausted" action is WhenExhaustedAction.BLOCK.

getMinEvictableIdleTimeMillis() - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Returns the minimum amount of time an GMConnection may sit idle in the pool before it is eligible for eviction by the idle GMConnection evictor (if any).

getMinIdle() - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Returns the minimum number of GMConnections allowed in the pool before the evictor thread (if active) spawns new GMConnections.

getNumTestsPerEvictionRun() - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Returns the max number of GMConnections to examine during each run of the idle GMConnection evictor thread (if any).

getSoftMinEvictableIdleTimeMillis() - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Returns the minimum amount of time an GMConnection may sit idle in the pool before it is eligible for eviction by the idle GMConnection evictor (if any), with the extra condition that at least "minIdle" amount of GMConnection remain in the pool.

getTestOnGet() - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

When true, GMConnections will be validated} before being returned by the PooledGMService.getConnection() method.

getTestOnReturn() - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

When true, GMConnections will be validated before being returned to the pool within the #returnObject.

getTestWhileIdle() - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

When true, GMConnections will be validated by the idle GMConnection evictor (if any).

getTimeBetweenEvictionRunsMillis() - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Returns the number of milliseconds to sleep between runs of the idle GMConnection evictor thread.

getWhenExhaustedAction() - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Returns the action to take when the PooledGMService.getConnection() method is invoked when the pool is exhausted (the maximum number of "active" GMConnections has been reached).

GMBatchCommand - Class in org.gm4java.im4java

This class wraps the GM command in interactive or batch mode.

GMBatchCommand(GMExecutor, String) - Constructor for class org.gm4java.im4java.GMBatchCommand

Construct a new instance of GMBatchCommand that uses given executor to execute specified command.

GMConnection - Interface in org.gm4java.engine

Encapsulates a connection to the GraphicsMagick process.

GMConnectionPoolConfig - Class in org.gm4java.engine.support

Configuration of PooledGMService that provides a number of configuration parameters.

GMConnectionPoolConfig() - Constructor for class org.gm4java.engine.support.GMConnectionPoolConfig

GMException - Exception in org.gm4java.engine

Captures the error returned from GraphicsMagick process.

GMException(String) - Constructor for exception org.gm4java.engine.GMException

Construct a new instance of exception.

GMExecutor - Interface in org.gm4java.engine

An interface to execute command using the underlying GraphicsMagick Process.

GMOperation - Class in org.gm4java.im4java

This class extends the im4java version of GMOperation and provide a list of convenience methods to ease the construction of the image command for GraphicsMagick.

GMOperation() - Constructor for class org.gm4java.im4java.GMOperation

GMOperation.GeometryAnnotation - Enum in org.gm4java.im4java

Options which modify the behavior of the 'width X height' specification for geometry-based settings.

GMOperation.Gravity - Enum in org.gm4java.im4java

Used in conjunction with other settings, generally defines how to interpret the offset for geometry-based options.

GMOperation.RotationAnnotation - Enum in org.gm4java.im4java

Options which modify the behavior of the 'degrees' specification for rotation-based settings.

GMService - Interface in org.gm4java.engine

Defines the GraphicsMagick service interface.

GMServiceException - Exception in org.gm4java.engine

Indicates error communicating with the GraphicsMagick process.

GMServiceException(String) - Constructor for exception org.gm4java.engine.GMServiceException

Constructs a new exception with given message.

GMServiceException(String, Throwable) - Constructor for exception org.gm4java.engine.GMServiceException

Constructs a new exception with given message and cause.

gravity(GMOperation.Gravity) - Method in class org.gm4java.im4java.GMOperation

Defines the gravity for geometry-based operations.

grayscale(int) - Method in class org.gm4java.im4java.GMOperation

Convert the image to grayscale (i.e.

I

isLifo() - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Whether or not the idle pool acts as a LIFO queue.

L

limitThreads(int) - Method in class org.gm4java.im4java.GMOperation

Limits the number of threads used by the GraphicsMagick process during execution.

O

org.gm4java.engine - package org.gm4java.engine

Defines the API of the gm4java engine.

org.gm4java.engine.support - package org.gm4java.engine.support

Provide implementations of GMService and GMConnection.

org.gm4java.im4java - package org.gm4java.im4java

Provides the integration between gm4java and im4java.

P

PooledGMService - Class in org.gm4java.engine.support

A GMService that manages and uses a pool of GraphicsMagick instances.

PooledGMService(GMConnectionPoolConfig) - Constructor for class org.gm4java.engine.support.PooledGMService

Construct a new instance of PooledGMService with given pool configuration.

Q

quality(double) - Method in class org.gm4java.im4java.GMOperation

Add option -quality to the GraphicsMagick commandline (see the documentation of GraphicsMagick for details).

R

resize(int, int, Collection<GMOperation.GeometryAnnotation>) - Method in class org.gm4java.im4java.GMOperation

Resize source to desired target dimensions, using default resizing filter algorithm.

rotate(double, GMOperation.RotationAnnotation) - Method in class org.gm4java.im4java.GMOperation

Rotates the image, with empty triangles back-filled using default background color.

run(LinkedList<String>) - Method in class org.gm4java.im4java.GMBatchCommand

This implementation uses GMExecutor to execute the command.

S

scale(int, int, Collection<GMOperation.GeometryAnnotation>) - Method in class org.gm4java.im4java.GMOperation

Scale source to desired target dimensions, using simplified resizing algorithm with pixel averaging.

setErrorConsumer(ErrorConsumer) - Method in class org.gm4java.im4java.GMBatchCommand

setEvictAfterNumberOfUse(int) - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Set the number of times a GraphicsMagick process can be used to execute commands before it gets evicted and destroyed.

setGMPath(String) - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Sets the path to GraphicsMagick executable.

setGMPath(String) - Method in class org.gm4java.engine.support.SimpleGMService

Sets the path to GraphicsMagick executable.

setLifo(boolean) - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Sets the LIFO property of the pool.

setMaxActive(int) - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Sets the cap on the number of GMConnections that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time.

setMaxIdle(int) - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Sets the cap on the number of "idle" instances in the pool.

setMaxWait(long) - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Sets the maximum amount of time (in milliseconds) the PooledGMService.getConnection() method should block before throwing an exception when the pool is exhausted and the "when exhausted" action is WhenExhaustedAction.BLOCK.

setMinEvictableIdleTimeMillis(long) - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Sets the minimum amount of time an GMConnection may sit idle in the pool before it is eligible for eviction by the idle GMConnection evictor (if any).

setMinIdle(int) - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Sets the minimum number of GMConnections allowed in the pool before the evictor thread (if active) spawns new GMConnections.

setNumTestsPerEvictionRun(int) - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Sets the max number of GMConnections to examine during each run of the idle GMConnection evictor thread (if any).

setOutputConsumer(OutputConsumer) - Method in class org.gm4java.im4java.GMBatchCommand

setSearchPath(String) - Method in class org.gm4java.im4java.GMBatchCommand

Deprecated.

setSoftMinEvictableIdleTimeMillis(long) - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Sets the minimum amount of time an GMConnection may sit idle in the pool before it is eligible for eviction by the idle GMConnection evictor (if any), with the extra condition that at least "minIdle" GMConnection instances remain in the pool.

setTestOnGet(boolean) - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

When true, GMConnections will be validated before being returned by the PooledGMService.getConnection() method.

setTestOnReturn(boolean) - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

When true, GMConnections will be validated before being returned to the pool within the #returnObject.

setTestWhileIdle(boolean) - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

When true, GMConnections will be validated by the idle GMConnection evictor (if any).

setTimeBetweenEvictionRunsMillis(long) - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Sets the number of milliseconds to sleep between runs of the idle GMConnection evictor thread.

setWhenExhaustedAction(WhenExhaustedAction) - Method in class org.gm4java.engine.support.GMConnectionPoolConfig

Sets the action to take when the PooledGMService.getConnection() method is invoked when the pool is exhausted (the maximum number of "active" GMConnections has been reached).

SimpleGMService - Class in org.gm4java.engine.support

Implementation of GMService that creates a new GraphicsMagick process every time SimpleGMService.getConnection() is called.

SimpleGMService() - Constructor for class org.gm4java.engine.support.SimpleGMService

source(File, Integer, Integer) - Method in class org.gm4java.im4java.GMOperation

Specifies the source image to convert.

stripProfiles() - Method in class org.gm4java.im4java.GMOperation

Strips out ICC profiles.

V

valueOf(String) - Static method in enum org.gm4java.engine.support.WhenExhaustedAction

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.gm4java.im4java.GMOperation.GeometryAnnotation

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.gm4java.im4java.GMOperation.Gravity

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.gm4java.im4java.GMOperation.RotationAnnotation

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.gm4java.engine.support.WhenExhaustedAction

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

values() - Static method in enum org.gm4java.im4java.GMOperation.GeometryAnnotation

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

values() - Static method in enum org.gm4java.im4java.GMOperation.Gravity

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

values() - Static method in enum org.gm4java.im4java.GMOperation.RotationAnnotation

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

W

WhenExhaustedAction - Enum in org.gm4java.engine.support

Defines the behavior of the PooledGMService.getConnection() method when the pool is exhausted.

A C D E F G I L O P Q R S V W