/*

 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package jdk.internal.jimage.decompressor;

import java.io.IOException;

import java.util.Properties;

/**

 *

 * JImage Resource Decompressor factory

 */

public abstract class ResourceDecompressorFactory {

    private final String name;

    private final String description;

    private final String arguments;

    protected ResourceDecompressorFactory(String name, String description,

            String arguments) {

        this.name = name;

        this.description = description;

        this.arguments = arguments;

    }

    /**

     * The Factory name.

     * @return The name.

     */

    public String getName() {

        return name;

    }

    /**

     * The Factory description.

     * @return The description.

     */

    public String getDescription() {

        return description;

    }

    /**

     * The Factory arguments description.

     * @return The arguments description.

     */

    public String getArgumentsDescription() {

        return arguments;

    }

    /**

     * To build a new decompressor.

     * @param properties Contains configuration.

     * @return A new decompressor.

     * @throws IOException

     */

    public abstract ResourceDecompressor newDecompressor(Properties properties)

            throws IOException;

}