DocCommand (groovy 2.2.0 API)

Overview

Package

Class

Deprecated

Index

Help

Groovy 2.2.0

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 String`	`ENV_BROWSER`
`static String`	`ENV_BROWSER_GROOVYSH`
`static int`	`TIMEOUT_CONN`
`static int`	`TIMEOUT_READ`
`static def`	`desktop`
`static boolean`	`hasAWTDesktopPlatformSupport`

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

Method Summary
`protected void`	`browse(List urls)`
`protected void`	`browseWithAWT(List urls)`
`protected void`	`browseWithNativeBrowser(String browser, List urls)`
`void`	`doc(String className)`
`Object`	`execute(List args)`
`protected String`	`getBrowserEnvironmentVariable()`
`Completer`	`getCompleter()`
`protected String`	`normalizeClassName(String className)`
`protected boolean`	`sendHEADRequest(URL url)`
`protected List`	`urlsFor(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 String ENV_BROWSER

ENV_BROWSER_GROOVYSH

static String ENV_BROWSER_GROOVYSH

TIMEOUT_CONN

static int TIMEOUT_CONN

TIMEOUT_READ

static int TIMEOUT_READ

desktop

static def 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(List urls)

browseWithAWT

protected void browseWithAWT(List urls)

browseWithNativeBrowser

protected void browseWithNativeBrowser(String browser, List urls)

doc

void doc(String className)

execute

Object execute(List args)

getBrowserEnvironmentVariable

protected String getBrowserEnvironmentVariable()

getCompleter

@Override
Completer getCompleter()

normalizeClassName

protected String normalizeClassName(String className)

sendHEADRequest

protected boolean sendHEADRequest(URL url)

urlsFor

protected List urlsFor(String className)

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