Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD DETAIL: FIELD | PROPERTY | CONSTR | METHOD

org.codehaus.groovy.tools.shell.commands
[Groovy] Class DocCommand

java.lang.Object
  org.codehaus.groovy.tools.shell.CommandSupport
      org.codehaus.groovy.tools.shell.commands.DocCommand

class DocCommand
extends CommandSupport

The 'doc' command.

Authors:
Masato Nagai
Andre Steingress
Since:
2.2.0

Field Summary
 
Fields inherited from class CommandSupport
NEWLINE, io, log, messages, registry, shell
 
Property Summary
static java.lang.String ENV_BROWSER

static java.lang.String ENV_BROWSER_GROOVYSH

static int TIMEOUT_CONN

static int TIMEOUT_READ

static java.lang.Object desktop

static boolean hasAWTDesktopPlatformSupport

 
Constructor Summary
DocCommand(Shell shell)

Check for java.awt.Desktop#browse platform support
 
Method Summary
protected void browse(java.util.List urls)

protected void browseWithAWT(java.util.List urls)

protected void browseWithNativeBrowser(java.lang.String browser, java.util.List urls)

void doc(java.lang.String className)

java.lang.Object execute(java.util.List args)

protected java.lang.String getBrowserEnvironmentVariable()

jline.console.completer.Completer getCompleter()

protected java.lang.String normalizeClassName(java.lang.String className)

protected boolean sendHEADRequest(java.net.URL url)

protected java.util.List urlsFor(java.lang.String className)

 
Methods inherited from class CommandSupport
alias, assertNoArguments, createCompleters, fail, fail, getBinding, getBuffer, getBuffers, getClassLoader, getCompleter, getDescription, getHelp, getHistory, getImports, getUsage, getVariables
 

Property Detail

ENV_BROWSER

static java.lang.String ENV_BROWSER

ENV_BROWSER_GROOVYSH

static java.lang.String ENV_BROWSER_GROOVYSH

TIMEOUT_CONN

static int TIMEOUT_CONN

TIMEOUT_READ

static int TIMEOUT_READ

desktop

static java.lang.Object desktop

hasAWTDesktopPlatformSupport

static boolean hasAWTDesktopPlatformSupport

 
Constructor Detail

DocCommand

DocCommand(Shell shell)
Check for java.awt.Desktop#browse platform support

 
Method Detail

browse

protected void browse(java.util.List urls)

browseWithAWT

protected void browseWithAWT(java.util.List urls)

browseWithNativeBrowser

protected void browseWithNativeBrowser(java.lang.String browser, java.util.List urls)

doc

void doc(java.lang.String className)

execute

java.lang.Object execute(java.util.List args)

getBrowserEnvironmentVariable

protected java.lang.String getBrowserEnvironmentVariable()

getCompleter

@java.lang.Override
jline.console.completer.Completer getCompleter()

normalizeClassName

protected java.lang.String normalizeClassName(java.lang.String className)

sendHEADRequest

protected boolean sendHEADRequest(java.net.URL url)

urlsFor

protected java.util.List urlsFor(java.lang.String className)

 

Groovy Documentation