py4j
Class HelpPageCommand

java.lang.Object
  extended by py4j.AbstractCommand
      extended by py4j.HelpPageCommand
All Implemented Interfaces:
Command

public class HelpPageCommand
extends AbstractCommand

A HelpPageCommand is responsible for generating a help page for a Java object or Java class. The help page typically list the signature of the members declared in the object/class.

Author:
Barthelemy Dagenais

Field Summary
static String HELP_CLASS_SUB_COMMAND_NAME
           
static String HELP_COMMAND_NAME
           
static String HELP_OBJECT_SUB_COMMAND_NAME
           
 
Fields inherited from class py4j.AbstractCommand
gateway
 
Constructor Summary
HelpPageCommand()
           
 
Method Summary
 void execute(String commandName, BufferedReader reader, BufferedWriter writer)
           
 
Methods inherited from class py4j.AbstractCommand
getArguments, getStringArguments, init, invokeMethod
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HELP_COMMAND_NAME

public static final String HELP_COMMAND_NAME
See Also:
Constant Field Values

HELP_OBJECT_SUB_COMMAND_NAME

public static final String HELP_OBJECT_SUB_COMMAND_NAME
See Also:
Constant Field Values

HELP_CLASS_SUB_COMMAND_NAME

public static final String HELP_CLASS_SUB_COMMAND_NAME
See Also:
Constant Field Values
Constructor Detail

HelpPageCommand

public HelpPageCommand()
Method Detail

execute

public void execute(String commandName,
                    BufferedReader reader,
                    BufferedWriter writer)
             throws Py4JException,
                    IOException
Specified by:
execute in interface Command
Specified by:
execute in class AbstractCommand
Parameters:
commandName - The command name that was extracted of the command.
reader - The reader from which to read the command parts. Each command part are expected to be on a separate line and readable through BufferedReader.readLine().
writer - The writer to which the return value should be written.
Throws:
Py4JException - If an error occurs while executing the command. All exceptions except IOException caused by the reader and the writer should be wrapper in a Py4JException instance.
IOException - If an error occurs while using the reader or the writer.