A C E F G P S T W

A

appendLine(String) - Method in class com.amazonaws.codesamples.CodeSample

Append a line of code to this sample.

assertFieldHasContent(String, String) - Static method in class com.amazonaws.util.ParsingUtils

Asserts that a specified field contains a non-null, non-empty value.

C

checkAndLogIfNoContent(String, String, String) - Static method in class com.amazonaws.util.ParsingUtils

Checks if the specified sample property value is null or empty, and logs it as missing if it is.

CodeSample - Class in com.amazonaws.codesamples

Represents an individual code sample.

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

Ctor.

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

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

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

E

execute() - Method in class com.amazonaws.codesamples.SampleCodeExtractor

Plugin entry point.

F

fileMatchesExtension(File, String) - Static method in class com.amazonaws.util.ParsingUtils

Determine if a given file matches the target extension.

formatSampleText(List<String>, int) - Static method in class com.amazonaws.util.ParsingUtils

Formats a section of sample text by removing leading whitespace characters up to a given maximum and by flattening lines into a single string.

G

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

Returns the description for this sample, or null if none was provided.

getFormattedCode() - Method in class com.amazonaws.codesamples.CodeSample

Returns source code for this Sample.

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

Returns the ID of this sample.

getLeadingWhitespace(String) - Static method in class com.amazonaws.util.ParsingUtils

Returns the number of leading whitespace characters in a given string.

getMinWhitespace(List<String>) - Static method in class com.amazonaws.util.ParsingUtils

Gets the minimum amount of leading whitespace in a text block.

getSamples(File[], String) - Static method in class com.amazonaws.codesamples.SamplesParser

Returns a list of samples parsed from input files.

getSamples(File) - Static method in class com.amazonaws.codesamples.SamplesParser

Returns a list of samples parsed from a file.

getServiceName() - Method in class com.amazonaws.codesamples.CodeSample

Returns the name of the service this sample was written for.

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

Returns the title of this sample.

P

ParsingUtils - Class in com.amazonaws.util

Utility methods to assist in sample parsing.

ParsingUtils() - Constructor for class com.amazonaws.util.ParsingUtils

S

SampleCodeExtractor - Class in com.amazonaws.codesamples

Maven mojo that is responsible for scanning input source files and extracting sections marked up as code samples.

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

SampleParsingException - Exception in com.amazonaws.codesamples.exception

Exception thrown when an error occurs while parsing a source file for code samples.

SampleParsingException(String, File, int) - Constructor for exception com.amazonaws.codesamples.exception.SampleParsingException

Constructs a SampleParsingException with a specified message and referencing a file and line number being processed when the error occurred.

SampleParsingException(String) - Constructor for exception com.amazonaws.codesamples.exception.SampleParsingException

Constructs a SampleParsingException with a specified message.

SamplesParser - Class in com.amazonaws.codesamples

Parser that parses out marked up samples from source code files.

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

SamplesWriter - Class in com.amazonaws.codesamples

Sample writer which takes samples and writes them out to XML files.

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

setDescription(String) - Method in class com.amazonaws.codesamples.CodeSample

Set the description for this sample.

setTitle(String) - Method in class com.amazonaws.codesamples.CodeSample

Set the title for this sample.

T

trimLeadingWhitespace(String, int) - Static method in class com.amazonaws.util.ParsingUtils

Trims up to a certain number of leading whitespace characters from a string.

W

writeSamples(List<CodeSample>, String) - Static method in class com.amazonaws.codesamples.SamplesWriter

Writes samples.

A C E F G P S T W