libjava/classpath/tools/gnu/classpath/tools/HelpPrinter.java

   1 /* HelpPrinter -- help message printer
   2    Copyright (C) 2006 Free Software Foundation
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package gnu.classpath.tools;
  39
  40 import java.io.BufferedReader;
  41 import java.io.IOException;
  42 import java.io.InputStream;
  43 import java.io.InputStreamReader;
  44
  45 /**
  46  * The shared class to print the help message and exit, when applicable.
  47  * Support the --help key.
  48  *
  49  * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
  50  */
  51 public class HelpPrinter
  52 {
  53   /**
  54    * Check for the --help, -help and -? keys. If one is found, print help and
  55    * exit the program.
  56    *
  57    * @param args the program arguments.
  58    * @param helpResourcePath the path to the help resource, related to the
  59    *          HelpPrinter class.
  60    */
  61   public static void checkHelpKey(String[] args, String helpResourcePath)
  62   {
  63     for (int i = 0; i < args.length; i++)
  64       {
  65         String a = args[i];
  66         if (a.equals("-?") || a.equalsIgnoreCase("-help")
  67             || a.equalsIgnoreCase("--help"))
  68           printHelpAndExit(helpResourcePath);
  69       }
  70   }
  71
  72   /**
  73    * Prints the contents of the resource specified by the designated path.
  74    *
  75    * @param helpResourcePath the path to a help resource, related to the
  76    *          HelpPrinter class.
  77    */
  78   public static void printHelp(String helpResourcePath)
  79   {
  80     InputStream in = HelpPrinter.class.getResourceAsStream(helpResourcePath);
  81     BufferedReader br = new BufferedReader(new InputStreamReader(in));
  82     try
  83       {
  84         String s;
  85         while ((s = br.readLine()) != null)
  86           System.out.println(s);
  87       }
  88     catch (IOException x)
  89       {
  90         System.err.print("Resource loading is broken:");
  91         x.printStackTrace(System.err);
  92       }
  93     finally
  94       {
  95         try
  96           {
  97             br.close();
  98           }
  99         catch (IOException ignored)
 100           {
 101           }
 102       }
 103   }
 104
 105   /**
 106    * Prints the help message and terminates.
 107    *
 108    * @param helpResourcePath the path to the help resource, related to the
 109    *          HelpPrinter class.
 110    */
 111   public static void printHelpAndExit(String helpResourcePath)
 112   {
 113     printHelp(helpResourcePath);
 114     System.exit(0);
 115   }
 116 }