org.apache.avro.tool
Class IdlTool

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

public class IdlTool
extends Object
implements Tool

Tool implementation for generating Avro JSON schemata from idl format files.


Constructor Summary
IdlTool()
           
 
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 in, PrintStream out, 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
 

Constructor Detail

IdlTool

public IdlTool()
Method Detail

run

public int run(InputStream in,
               PrintStream out,
               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:
in - Input stream to read data (typically System.in).
out - 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.

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


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