Package py4j.commands

Class HelpPageCommand

java.lang.Object
py4j.commands.AbstractCommand
py4j.commands.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 Details

  • Constructor Details

    • HelpPageCommand

      public HelpPageCommand()
  • Method Details

    • 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.