com.amazonaws.codesamples.util

Class SampleHTMLTemplates

java.lang.Object

com.amazonaws.codesamples.util.SampleHTMLTemplates

public class SampleHTMLTemplates
extends java.lang.Object

Templates used to insert raw code samples into Javadoc HTML blocks.

Constructor Summary

Constructors

Constructor and Description
SampleHTMLTemplates()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getSampleHTML(java.lang.String title, java.lang.String description, java.lang.String content) Parses a given raw code sample into a HTML sample block.
static java.lang.String	getSampleSectionHTML(java.util.List<RetrievedCodeSample> samples) Injects HTML formatted samples into an outer samples HTML block.

Methods inherited from class java.lang.Object

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

Constructor Detail

SampleHTMLTemplates

public SampleHTMLTemplates()

Method Detail

getSampleHTML

public static java.lang.String getSampleHTML(java.lang.String title,
                                             java.lang.String description,
                                             java.lang.String content)

Parses a given raw code sample into a HTML sample block.

Parameters:

title - code sample title

description - code sample description

content - code sample content

Returns:

formatted HTML code sample block

getSampleSectionHTML

public static java.lang.String getSampleSectionHTML(java.util.List<RetrievedCodeSample> samples)

Injects HTML formatted samples into an outer samples HTML block.

Parameters:

samples - HTML formatted samples

Returns:

formatted outer HTML samples block