A C E G I R S T V

A

areNullOrEmpty(String...) - Static method in class com.amazonaws.codesamples.util.ValidationUtils

assertInputNotEmpty(String, String) - Static method in class com.amazonaws.codesamples.util.ValidationUtils

assertResultNotEmpty(String, String, String, String) - Static method in class com.amazonaws.codesamples.util.ValidationUtils

C

characters(char[], int, int) - Method in class com.amazonaws.codesamples.SampleCodeXMLParser

com.amazonaws.codesamples - package com.amazonaws.codesamples

com.amazonaws.codesamples.exception - package com.amazonaws.codesamples.exception

com.amazonaws.codesamples.util - package com.amazonaws.codesamples.util

E

endElement(String, String, String) - Method in class com.amazonaws.codesamples.SampleCodeXMLParser

G

getContent() - Method in class com.amazonaws.codesamples.RetrievedCodeSample

Returns the code sample content

getDescription() - Method in class com.amazonaws.codesamples.RetrievedCodeSample

Returns the description of the sample.

getId() - Method in class com.amazonaws.codesamples.RetrievedCodeSample

Returns the id of the sample.

getName() - Method in class com.amazonaws.codesamples.SampleCodeTaglet

getSampleContent() - Method in class com.amazonaws.codesamples.SampleCodeXMLParser

getSampleDescription() - Method in class com.amazonaws.codesamples.SampleCodeXMLParser

getSampleHTML(String, String, String) - Static method in class com.amazonaws.codesamples.util.SampleHTMLTemplates

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

getSampleSectionHTML(List<RetrievedCodeSample>) - Static method in class com.amazonaws.codesamples.util.SampleHTMLTemplates

Injects HTML formatted samples into an outer samples HTML block.

getSampleTitle() - Method in class com.amazonaws.codesamples.SampleCodeXMLParser

getService() - Method in class com.amazonaws.codesamples.RetrievedCodeSample

Returns the name of the service the sample is associated with.

getTitle() - Method in class com.amazonaws.codesamples.RetrievedCodeSample

Returns the title of the sample.

I

inConstructor() - Method in class com.amazonaws.codesamples.SampleCodeTaglet

inField() - Method in class com.amazonaws.codesamples.SampleCodeTaglet

inMethod() - Method in class com.amazonaws.codesamples.SampleCodeTaglet

inOverview() - Method in class com.amazonaws.codesamples.SampleCodeTaglet

inPackage() - Method in class com.amazonaws.codesamples.SampleCodeTaglet

inType() - Method in class com.amazonaws.codesamples.SampleCodeTaglet

isInlineTag() - Method in class com.amazonaws.codesamples.SampleCodeTaglet

isNullOrEmpty(String) - Static method in class com.amazonaws.codesamples.util.ValidationUtils

R

readSample(String, String) - Method in class com.amazonaws.codesamples.SampleCodeReader

Retrieves a specified code sample.

register(Map<String, Taglet>) - Static method in class com.amazonaws.codesamples.SampleCodeTaglet

RetrievedCodeSample - Class in com.amazonaws.codesamples

Represents a code sample retrieved from an XML code samples file.

RetrievedCodeSample(String, String, String, String, String) - Constructor for class com.amazonaws.codesamples.RetrievedCodeSample

Ctor.

S

SampleCodeReader - Class in com.amazonaws.codesamples

Reads code samples from a source directory containing processed sample code XML files.

SampleCodeReader(String) - Constructor for class com.amazonaws.codesamples.SampleCodeReader

Ctor.

SampleCodeTaglet - Class in com.amazonaws.codesamples

Taglet that retrieves and injects sample code blocks into sections of Javadocs marked with @sample tags.

SampleCodeTaglet() - Constructor for class com.amazonaws.codesamples.SampleCodeTaglet

SampleCodeXMLParser - Class in com.amazonaws.codesamples

SAX handler for parsing XML formatted Javadoc sample files.

SampleCodeXMLParser(String) - Constructor for class com.amazonaws.codesamples.SampleCodeXMLParser

SampleHTMLTemplates - Class in com.amazonaws.codesamples.util

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

SampleHTMLTemplates() - Constructor for class com.amazonaws.codesamples.util.SampleHTMLTemplates

SampleRetrievalException - Exception in com.amazonaws.codesamples.exception

Exception thrown when an error occurs while retrieving a code sample.

SampleRetrievalException(String, String, String) - Constructor for exception com.amazonaws.codesamples.exception.SampleRetrievalException

Constructs a SampleRetrievalException with the specified message.

SampleRetrievalException(String, String, String, Throwable) - Constructor for exception com.amazonaws.codesamples.exception.SampleRetrievalException

Constructs a SampleRetrievalException with the specified message and cause.

startElement(String, String, String, Attributes) - Method in class com.amazonaws.codesamples.SampleCodeXMLParser

T

toString(Tag) - Method in class com.amazonaws.codesamples.SampleCodeTaglet

toString(Tag[]) - Method in class com.amazonaws.codesamples.SampleCodeTaglet

V

ValidationUtils - Class in com.amazonaws.codesamples.util

Sample retrieval validation helper methods.

ValidationUtils() - Constructor for class com.amazonaws.codesamples.util.ValidationUtils

A C E G I R S T V