org.gm4java.engine.GMConnection Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gm4java Show documentation

GraphicsMagick interactive mode Java integration

There is a newer version: 1.1.1

/*
 * Copyright (c) 2011 Original Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.gm4java.engine;

/**
 * Encapsulates a connection to the GraphicsMagick process. An instance of {@linkplain GMConnection} is associated with
 * one and only one physical GraphicsMagick process. Client can call {@link #execute(String)} method many times during
 * the life cycle {@linkplain GMConnection} instance. Client is required to call {@link #close()} method in the end of
 * the life cycle to terminate the physical GraphicsMagick process quickly.
 * 
 * Implementations of this interface are typical not thread safe in nature unless otherwise stated.
 * 
 * @author Kenneth Xu
 * 
 */
public interface GMConnection extends GMExecutor {
    /**
     * Close {@linkplain GMConnection} and destroy the underlying GraphicsMagick process.
     * 
     * @throws GMServiceException
     *             when there is error communicating with the underlying GraphicsMagick process
     */
    void close() throws GMServiceException;
}