com.google.api.server.spi.tools

Class GenClientLibAction

java.lang.Object

com.google.appengine.tools.util.Action

com.google.api.server.spi.tools.EndpointsToolAction

com.google.api.server.spi.tools.GenClientLibAction

public class GenClientLibAction
extends EndpointsToolAction

Command to generated a client library from a Discovery document.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.server.spi.tools.EndpointsToolAction

EndpointsToolAction.EndpointsOption

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from class com.google.api.server.spi.tools.EndpointsToolAction

OPTION_BASE_PATH_LONG, OPTION_BASE_PATH_SHORT, OPTION_BUILD_SYSTEM_LONG, OPTION_BUILD_SYSTEM_SHORT, OPTION_CLASS_PATH_LONG, OPTION_CLASS_PATH_SHORT, OPTION_DEBUG, OPTION_FORMAT_LONG, OPTION_FORMAT_SHORT, OPTION_HOSTNAME_LONG, OPTION_HOSTNAME_SHORT, OPTION_LANGUAGE_LONG, OPTION_LANGUAGE_SHORT, OPTION_OUTPUT_DIR_LONG, OPTION_OUTPUT_DIR_SHORT, OPTION_WAR_LONG, OPTION_WAR_SHORT

Fields inherited from class com.google.appengine.tools.util.Action

extraOptions, shortDescription

Constructor Summary

Constructors

Constructor and Description
GenClientLibAction()

Method Summary

Modifier and Type	Method and Description
boolean	execute() Executes the command with the given arguments.
java.lang.Object	genClientLib(java.lang.String language, java.lang.String outputDirPath, java.lang.String discoveryDoc, java.lang.String buildSystem) Generates a client library for an API.
java.lang.Object	genClientLibFromFile(java.lang.String language, java.lang.String outputDirPath, java.lang.String discoveryDocPath, java.lang.String buildSystem) Generates a client library for an API.
java.lang.String	getUsageString() Returns a usage string for help output.

Methods inherited from class com.google.api.server.spi.tools.EndpointsToolAction

apply, computeClassPath, getBasePath, getBuildSystem, getClassPath, getDebug, getExampleString, getFormat, getHelpLines, getHostname, getLanguage, getOpenApiOutputPath, getOptionOrDefault, getOutputPath, getServiceClassNames, getWarOutputPath, getWarPath, isHelpDisplayNeeded, makeBasePathOption, makeBuildSystemOption, makeClassPathOption, makeDebugOption, makeFormatOption, makeHostnameOption, makeLanguageOption, makeOpenApiOutputOption, makeOutputOption, makeWarOption, makeWarOutputOption, setExampleString, setHelpDisplayNeeded

Methods inherited from class com.google.appengine.tools.util.Action

getArgs, getHelpString, getNames, getNameString, getOptions, getShortDescription, setArgs, setOptions, setShortDescription

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

GenClientLibAction

public GenClientLibAction()

Method Detail

execute

public boolean execute()
                throws java.io.IOException

Description copied from class: EndpointsToolAction

Executes the command with the given arguments.

Specified by:

execute in class EndpointsToolAction

Returns:

whether or not all required arguments were provided

Throws:

java.io.IOException

genClientLibFromFile

public java.lang.Object genClientLibFromFile(java.lang.String language,
                                             java.lang.String outputDirPath,
                                             java.lang.String discoveryDocPath,
                                             java.lang.String buildSystem)
                                      throws java.io.IOException

Generates a client library for an API.

Parameters:

language - Language of the client library.

outputDirPath - Directory to write generated client library into

discoveryDocPath - Path to Discovery doc file

buildSystem - The build system to use for the client library

Throws:

java.io.IOException

genClientLib

public java.lang.Object genClientLib(java.lang.String language,
                                     java.lang.String outputDirPath,
                                     java.lang.String discoveryDoc,
                                     java.lang.String buildSystem)
                              throws java.io.IOException

Generates a client library for an API.

Parameters:

language - Language of the client library.

outputDirPath - Directory to write generated client library into

discoveryDoc - Discovery doc text.

buildSystem - The build system to use for the client library

Throws:

java.io.IOException

getUsageString

public java.lang.String getUsageString()

Description copied from class: EndpointsToolAction

Returns a usage string for help output.

Specified by:

getUsageString in class EndpointsToolAction