org.apache.avro.tool
Class TetherTool

java.lang.Object
  extended by org.apache.avro.tool.TetherTool
All Implemented Interfaces:
Tool

public class TetherTool
extends Object
implements Tool


Field Summary
 TetherJob job
           
 
Constructor Summary
TetherTool()
           
 
Method Summary
 String getName()
          Name of tool, to be used in listings.
 String getShortDescription()
          1-line description to be used in command listings.
 int run(InputStream ins, PrintStream outs, PrintStream err, List<String> args)
          Runs the tool with supplied arguments.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

job

public TetherJob job
Constructor Detail

TetherTool

public TetherTool()
Method Detail

getName

public String getName()
Description copied from interface: Tool
Name of tool, to be used in listings.

Specified by:
getName in interface Tool

getShortDescription

public String getShortDescription()
Description copied from interface: Tool
1-line description to be used in command listings.

Specified by:
getShortDescription in interface Tool

run

public int run(InputStream ins,
               PrintStream outs,
               PrintStream err,
               List<String> args)
        throws Exception
Description copied from interface: Tool
Runs the tool with supplied arguments. Input and output streams are customizable for easier testing.

Specified by:
run in interface Tool
Parameters:
ins - Input stream to read data (typically System.in).
outs - Output of tool (typically System.out).
err - Error stream (typically System.err).
args - Non-null list of arguments.
Returns:
result code (0 for success)
Throws:
Exception - Just like main(), tools may throw Exception.


Copyright © 2011 The Apache Software Foundation. All Rights Reserved.