org.sdmlib.storyboards

Class Storyboard

java.lang.Object

org.sdmlib.storyboards.Storyboard

public class Storyboard
extends java.lang.Object

A StoryPage allows the use of the most important functionalities of Storyboards.

See Also:

StoryboardImpl

Constructor Summary

Constructors

Constructor and Description
Storyboard() Constructor for StoryPage, that creates a Storyboard by calling its standard constructor, in order to use the necessary functionalities of the Storyboard class.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String string) Adds a string to the current step of the storyboard.
void	addClassDiagram(ClassModel model) Adds a diagram of an classmodel to the storyboard.
void	addCode() Adds a portion of code, to the storyboard, that has been marked beforehand.
void	addImage(java.lang.String imageFile) Adds an image to the current step of the storyboard.
void	addObjectDiagram(java.lang.Object... elems) Adds an object diagram to the storyboard, that contains the given objects.
void	addObjectDiagramOnlyWith(java.lang.Object... elems) Adds an object diagram to the storyboard, that only consists of the given objects.
void	addPattern(Pattern pattern, boolean showMatch) Adds a pattern to the storyboard.
void	addPattern(PatternObject<?,?> pattern, boolean showMatch) Adds a pattern to the storyboard.
void	addPreformatted(java.lang.String expandedText) Adds a new step, with an preformatted text.
StoryboardImpl	addStep(java.lang.String txt) Adds a new Step to the current Storyboard.
void	addSystemOut() Adds the output of System.out, to the storyboard, after it has been recorded.
void	addTable(Table table)
void	assertEquals(java.lang.String message, double expected, double actual, double delta) Asserts, that an expected and actual value are equal and adds the result to the storyboard.
void	assertEquals(java.lang.String message, int expected, int actual) Asserts, that an expected and actual value are equal and adds the result to the storyboard.
void	assertEquals(java.lang.String message, java.lang.Object expected, java.lang.Object actual) Asserts, that an expected and actual value are equal and adds the result to the storyboard.
void	assertFalse(java.lang.String message, boolean condition) Asserts, that a condition is not fulfilled and adds the result to the storyboard.
void	assertNotNull(java.lang.String message, java.lang.Object obj) Asserts, that an object does not equal null and adds the result to the storyboard.
void	assertNull(java.lang.String message, java.lang.Object obj) Asserts, that an object does equals null and adds the result to the storyboard.
void	assertTrue(java.lang.String message, boolean condition) Asserts, that a condition is fulfilled and adds the result to the storyboard.
void	dumpHTML() Creates an html file, that contains the storyboard.
java.lang.String	getMethodText(java.lang.String rootDir, java.lang.String className, java.lang.String methodSignature) Returns the code of a specified method.
StoryboardImpl	getStoryboard()
void	markCodeStart() Marks the current position within the code.
void	recordSystemOut() Records the output of System.out.
Storyboard	withDocDirName(java.lang.String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

Storyboard

public Storyboard()

Constructor for StoryPage, that creates a Storyboard by calling its standard constructor, in order to use the necessary functionalities of the Storyboard class.

Method Detail

getStoryboard

public StoryboardImpl getStoryboard()

addStep

public StoryboardImpl addStep(java.lang.String txt)

Adds a new Step to the current Storyboard.

"Start:" + txt, for first step
stepcount + "." + txt, for every following step.

Parameters:

txt - text, that is added to the new step

Returns:

return the Storyboard

withDocDirName

public Storyboard withDocDirName(java.lang.String name)

addPreformatted

public void addPreformatted(java.lang.String expandedText)

Adds a new step, with an preformatted text.

Parameters:

expandedText - this is the text, that the method is going to preformat

add

public void add(java.lang.String string)

Adds a string to the current step of the storyboard.

Parameters:

string - a string, that will be added to the storyboard

addImage

public void addImage(java.lang.String imageFile)

Adds an image to the current step of the storyboard.

Parameters:

imageFile - name of the file, that contains the image

addClassDiagram

public void addClassDiagram(ClassModel model)

Adds a diagram of an classmodel to the storyboard.

Parameters:

model - object of the classmodel, that will be displayed as a diagram

addObjectDiagram

public void addObjectDiagram(java.lang.Object... elems)

Adds an object diagram to the storyboard, that contains the given objects.

Parameters:

elems - the elements, that the diagram will contain

addObjectDiagramOnlyWith

public void addObjectDiagramOnlyWith(java.lang.Object... elems)

Adds an object diagram to the storyboard, that only consists of the given objects.

Parameters:

elems - the elements, that the diagram will only consist of

addPattern

public void addPattern(PatternObject<?,?> pattern,
                       boolean showMatch)

Adds a pattern to the storyboard.

Parameters:

pattern - the pattern, that will be added storyboard

showMatch - flag, that specifies, if the matches of the pattern will be shown

addPattern

public void addPattern(Pattern pattern,
                       boolean showMatch)

Adds a pattern to the storyboard.

Parameters:

pattern - the pattern, that will be added storyboard

showMatch - flag, that specifies, if the matches of the pattern will be shown

markCodeStart

public void markCodeStart()

Marks the current position within the code.

addCode

public void addCode()

Adds a portion of code, to the storyboard, that has been marked beforehand.

getMethodText

public java.lang.String getMethodText(java.lang.String rootDir,
                                      java.lang.String className,
                                      java.lang.String methodSignature)

Returns the code of a specified method.

Parameters:

rootDir - the root directory of the file, that contains the specified method

className - name of the class, that contains the specified method

methodSignature - signature of the specified method.

Returns:

the code of the specified method

recordSystemOut

public void recordSystemOut()

Records the output of System.out.

addSystemOut

public void addSystemOut()

Adds the output of System.out, to the storyboard, after it has been recorded.

dumpHTML

public void dumpHTML()

Creates an html file, that contains the storyboard.

assertEquals

public void assertEquals(java.lang.String message,
                         double expected,
                         double actual,
                         double delta)

Asserts, that an expected and actual value are equal and adds the result to the storyboard.
If this is not the case, a message will be printed.

Parameters:

message - the message, that will be displayed, in case, that the assertion failed

expected - the expected value

actual - the actual value

delta - allowed deviation between the two values

assertEquals

public void assertEquals(java.lang.String message,
                         java.lang.Object expected,
                         java.lang.Object actual)

Asserts, that an expected and actual value are equal and adds the result to the storyboard.
If the assertion fails, a corresponding message will be printed.

Parameters:

message - the message, that will be displayed, in case, that the assertion faile

expected - the expected value

actual - the actual value

assertTrue

public void assertTrue(java.lang.String message,
                       boolean condition)

Asserts, that a condition is fulfilled and adds the result to the storyboard.
If the assertion fails, a corresponding message will be printed.

Parameters:

message - the message, that will be displayed, in case, that the assertion faile

condition - the condition, that is used for the assertion

assertFalse

public void assertFalse(java.lang.String message,
                        boolean condition)

Asserts, that a condition is not fulfilled and adds the result to the storyboard.
If the assertion fails, a corresponding message will be printed.

Parameters:

message - the message, that will be displayed, in case, that the assertion faile

condition - the condition, that is used for the assertion

assertEquals

public void assertEquals(java.lang.String message,
                         int expected,
                         int actual)

Asserts, that an expected and actual value are equal and adds the result to the storyboard.
If the assertion fails, a corresponding message will be printed.

Parameters:

message - the message, that will be displayed, in case, that the assertion faile

expected - the expected value

actual - the actual value

assertNotNull

public void assertNotNull(java.lang.String message,
                          java.lang.Object obj)

Asserts, that an object does not equal null and adds the result to the storyboard.
If the assertion fails, a corresponding message will be printed.

Parameters:

message - the message, that will be displayed, in case, that the assertion faile

obj - the object, that is used for the assertion

assertNull

public void assertNull(java.lang.String message,
                       java.lang.Object obj)

Asserts, that an object does equals null and adds the result to the storyboard.
If the assertion fails, a corresponding message will be printed.

Parameters:

message - the message, that will be displayed, in case, that the assertion faile

obj - the object, that is used for the assertion

addTable

public void addTable(Table table)