1 /*
   2  * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 package jdk.internal.jimage.decompressor;
  26 
  27 import java.io.IOException;
  28 import java.util.Properties;
  29 
  30 /**
  31  *
  32  * JImage Resource Decompressor factory
  33  */
  34 public abstract class ResourceDecompressorFactory {
  35     private final String name;
  36     private final String description;
  37     private final String arguments;
  38 
  39     protected ResourceDecompressorFactory(String name, String description,
  40             String arguments) {
  41         this.name = name;
  42         this.description = description;
  43         this.arguments = arguments;
  44     }
  45 
  46     /**
  47      * The Factory name.
  48      * @return The name.
  49      */
  50     public String getName() {
  51         return name;
  52     }
  53 
  54     /**
  55      * The Factory description.
  56      * @return The description.
  57      */
  58     public String getDescription() {
  59         return description;
  60     }
  61 
  62     /**
  63      * The Factory arguments description.
  64      * @return The arguments description.
  65      */
  66     public String getArgumentsDescription() {
  67         return arguments;
  68     }
  69 
  70     /**
  71      * To build a new decompressor.
  72      * @param properties Contains configuration.
  73      * @return A new decompressor.
  74      * @throws IOException
  75      */
  76     public abstract ResourceDecompressor newDecompressor(Properties properties)
  77             throws IOException;
  78 
  79 }
  80