ToolRunner.java
上传用户:quxuerui
上传日期:2018-01-08
资源大小:41811k
文件大小:3k
源码类别:

网格计算

开发平台:

Java

  1. /**
  2.  * Licensed to the Apache Software Foundation (ASF) under one
  3.  * or more contributor license agreements.  See the NOTICE file
  4.  * distributed with this work for additional information
  5.  * regarding copyright ownership.  The ASF licenses this file
  6.  * to you under the Apache License, Version 2.0 (the
  7.  * "License"); you may not use this file except in compliance
  8.  * with the License.  You may obtain a copy of the License at
  9.  *
  10.  *     http://www.apache.org/licenses/LICENSE-2.0
  11.  *
  12.  * Unless required by applicable law or agreed to in writing, software
  13.  * distributed under the License is distributed on an "AS IS" BASIS,
  14.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15.  * See the License for the specific language governing permissions and
  16.  * limitations under the License.
  17.  */
  18. package org.apache.hadoop.util;
  19. import java.io.PrintStream;
  20. import org.apache.hadoop.conf.Configuration;
  21. /**
  22.  * A utility to help run {@link Tool}s.
  23.  * 
  24.  * <p><code>ToolRunner</code> can be used to run classes implementing 
  25.  * <code>Tool</code> interface. It works in conjunction with 
  26.  * {@link GenericOptionsParser} to parse the 
  27.  * <a href="{@docRoot}/org/apache/hadoop/util/GenericOptionsParser.html#GenericOptions">
  28.  * generic hadoop command line arguments</a> and modifies the 
  29.  * <code>Configuration</code> of the <code>Tool</code>. The 
  30.  * application-specific options are passed along without being modified.
  31.  * </p>
  32.  * 
  33.  * @see Tool
  34.  * @see GenericOptionsParser
  35.  */
  36. public class ToolRunner {
  37.  
  38.   /**
  39.    * Runs the given <code>Tool</code> by {@link Tool#run(String[])}, after 
  40.    * parsing with the given generic arguments. Uses the given 
  41.    * <code>Configuration</code>, or builds one if null.
  42.    * 
  43.    * Sets the <code>Tool</code>'s configuration with the possibly modified 
  44.    * version of the <code>conf</code>.  
  45.    * 
  46.    * @param conf <code>Configuration</code> for the <code>Tool</code>.
  47.    * @param tool <code>Tool</code> to run.
  48.    * @param args command-line arguments to the tool.
  49.    * @return exit code of the {@link Tool#run(String[])} method.
  50.    */
  51.   public static int run(Configuration conf, Tool tool, String[] args) 
  52.     throws Exception{
  53.     if(conf == null) {
  54.       conf = new Configuration();
  55.     }
  56.     GenericOptionsParser parser = new GenericOptionsParser(conf, args);
  57.     //set the configuration back, so that Tool can configure itself
  58.     tool.setConf(conf);
  59.     
  60.     //get the args w/o generic hadoop args
  61.     String[] toolArgs = parser.getRemainingArgs();
  62.     return tool.run(toolArgs);
  63.   }
  64.   
  65.   /**
  66.    * Runs the <code>Tool</code> with its <code>Configuration</code>.
  67.    * 
  68.    * Equivalent to <code>run(tool.getConf(), tool, args)</code>.
  69.    * 
  70.    * @param tool <code>Tool</code> to run.
  71.    * @param args command-line arguments to the tool.
  72.    * @return exit code of the {@link Tool#run(String[])} method.
  73.    */
  74.   public static int run(Tool tool, String[] args) 
  75.     throws Exception{
  76.     return run(tool.getConf(), tool, args);
  77.   }
  78.   
  79.   /**
  80.    * Prints generic command-line argurments and usage information.
  81.    * 
  82.    *  @param out stream to write usage information to.
  83.    */
  84.   public static void printGenericCommandUsage(PrintStream out) {
  85.     GenericOptionsParser.printGenericCommandUsage(out);
  86.   }
  87.   
  88. }