com.amazonaws.codesamples

Class CodeSample

java.lang.Object

com.amazonaws.codesamples.CodeSample

public class CodeSample
extends java.lang.Object

Represents an individual code sample.

Constructor Summary

Constructors

Constructor and Description
CodeSample(java.lang.String sampleId, java.lang.String serviceName) Ctor.

Method Summary

Modifier and Type	Method and Description
void	appendLine(java.lang.String line) Append a line of code to this sample.
java.lang.String	getDescription() Returns the description for this sample, or null if none was provided.
java.lang.String	getFormattedCode() Returns source code for this Sample.
java.lang.String	getId() Returns the ID of this sample.
java.lang.String	getServiceName() Returns the name of the service this sample was written for.
java.lang.String	getTitle() Returns the title of this sample.
void	setDescription(java.lang.String description) Set the description for this sample.
void	setTitle(java.lang.String title) Set the title for this sample.

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeSample

public CodeSample(java.lang.String sampleId,
                  java.lang.String serviceName)

Ctor.

Parameters:

sampleId - unique identifier for code sample

serviceName - service sample is associated with

Method Detail

getId

public java.lang.String getId()

Returns the ID of this sample.

Returns:

sample ID

getServiceName

public java.lang.String getServiceName()

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

Returns:

service name

getTitle

public java.lang.String getTitle()

Returns the title of this sample.

Returns:

sample title

getDescription

public java.lang.String getDescription()

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

Returns:

description if provided

getFormattedCode

public java.lang.String getFormattedCode()

Returns source code for this Sample. Code is formatted and shifted to avoid extraneous leading whitespace.

Returns:

formatted sample code

setTitle

public void setTitle(java.lang.String title)

Set the title for this sample.

Parameters:

title - sample title

setDescription

public void setDescription(java.lang.String description)

Set the description for this sample.

Parameters:

description - sample description

appendLine

public void appendLine(java.lang.String line)

Append a line of code to this sample.

Parameters:

line - line of code