com.amazonaws.codegen.internal

Class DocumentationUtils

java.lang.Object

com.amazonaws.codegen.internal.DocumentationUtils

public class DocumentationUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONSTRUCTOR_DOC
static String	DEFAULT_ASYNC_RETURN
static String	DEFAULT_FLUENT_RETURN
static String	DEFAULT_GETTER
static String	DEFAULT_GETTER_PARAM
static String	DEFAULT_SETTER
static String	DEFAULT_SETTER_PARAM
static String	DEFAULT_SYNC_RETURN
static String	LIST_VARARG_ADDITIONAL_DOC

Constructor Summary

Constructors

Constructor and Description
DocumentationUtils()

Method Summary

Modifier and Type	Method and Description
static String	createLinkToServiceDocumentation(Metadata metadata, ShapeModel shapeModel) Create the HTML for a link to the operation/shape core AWS docs site
static String	createLinkToServiceDocumentation(Metadata metadata, String name) Create the HTML for a link to the operation/shape core AWS docs site
static String	escapeIllegalCharacters(String documentation) Escapes Java comment breaking illegal character sequences.
static String	generateGetterDocumentation()
static String	generateSetterDocumentation()
static String	generateWitherDocumentation()
static String	removeFromEnd(String string, String stringToRemove)
static String	stripHTMLTags(String documentation) Returns a documentation with HTML tags prefixed and suffixed removed, or returns empty string if the input is empty or null.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ASYNC_RETURN

public static final String DEFAULT_ASYNC_RETURN

See Also:

Constant Field Values

DEFAULT_SYNC_RETURN

public static final String DEFAULT_SYNC_RETURN

See Also:

Constant Field Values

DEFAULT_SETTER

public static final String DEFAULT_SETTER

See Also:

Constant Field Values

DEFAULT_SETTER_PARAM

public static final String DEFAULT_SETTER_PARAM

See Also:

Constant Field Values

DEFAULT_GETTER

public static final String DEFAULT_GETTER

See Also:

Constant Field Values

DEFAULT_GETTER_PARAM

public static final String DEFAULT_GETTER_PARAM

See Also:

Constant Field Values

DEFAULT_FLUENT_RETURN

public static final String DEFAULT_FLUENT_RETURN

See Also:

Constant Field Values

CONSTRUCTOR_DOC

public static final String CONSTRUCTOR_DOC

See Also:

Constant Field Values

LIST_VARARG_ADDITIONAL_DOC

public static final String LIST_VARARG_ADDITIONAL_DOC

See Also:

Constant Field Values

Constructor Detail

DocumentationUtils

public DocumentationUtils()

Method Detail

generateSetterDocumentation

public static String generateSetterDocumentation()

generateGetterDocumentation

public static String generateGetterDocumentation()

generateWitherDocumentation

public static String generateWitherDocumentation()

stripHTMLTags

public static String stripHTMLTags(String documentation)

Returns a documentation with HTML tags prefixed and suffixed removed, or returns empty string if the input is empty or null. This method is to be used when constructing documentation for method parameters.

Parameters:

documentation - unprocessed input documentation

Returns:

HTML tag stripped documentation or empty string if input was null.

escapeIllegalCharacters

public static String escapeIllegalCharacters(String documentation)

Escapes Java comment breaking illegal character sequences.

Parameters:

documentation - unprocessed input documentation

Returns:

escaped documentation, or empty string if input was null

createLinkToServiceDocumentation

public static String createLinkToServiceDocumentation(Metadata metadata,
                                                      String name)

Create the HTML for a link to the operation/shape core AWS docs site

Parameters:

metadata - the UID for the service from that services metadata

name - the name of the shape/request/operation

Returns:

a '@see also' HTML link to the doc

createLinkToServiceDocumentation

public static String createLinkToServiceDocumentation(Metadata metadata,
                                                      ShapeModel shapeModel)

Create the HTML for a link to the operation/shape core AWS docs site

Parameters:

metadata - the UID for the service from that services metadata

shapeModel - the model of the shape

Returns:

a '@see also' HTML link to the doc

removeFromEnd

public static String removeFromEnd(String string,
                                   String stringToRemove)