startClass

Description

With this configuration parameter you have to specifiy the name of the class where the sequence diagram should start the call flow. This parameter is mandatory.

Default Value

There is no default value.

Example

Here is an example of the usage where the call sequence starts in the class de.elnarion.maven.plugin.plantuml.generator.test.domain.ChildA:

			<plugin>
				<artifactId>@project.artifactId@</artifactId>
				<groupId>@project.groupId@</groupId>
				<version>@project.version@</version>
				<executions>
					<execution>
						<id>generate-simple-diagram</id>
						<goals>
							<goal>generateSequenceDiagram</goal>
						</goals>
						<phase>generate-test-sources</phase>
						<configuration>
							<outputFilename>testsequencediagram1.txt</outputFilename>
							<startClass>de.elnarion.maven.plugin.plantuml.generator.test.domain.ChildA</startClass>
							<startMethod>doSomethingSpecial</startMethod>
							<enableAsciidocWrapper>true</enableAsciidocWrapper>
						</configuration>
					</execution>
				</executions>
			</plugin>

which is rendered this way:

testsequencediagram1.txt.png

which produces this PlantUML diagram text:

[plantuml,testsequencediagram1.txt.png,png]
----
@startuml

participant ChildA
participant ChildB
participant BaseAbstractClass

activate ChildA
	ChildA -> ChildB : getUtil
	activate ChildB
		ChildB --> ChildA
	deactivate ChildB
	ChildA -> BaseAbstractClass : doSomethingWithReturnValue
	activate BaseAbstractClass
		BaseAbstractClass --> ChildA
	deactivate BaseAbstractClass
	ChildA -> BaseAbstractClass : doSomethingWithParameter
	activate BaseAbstractClass
		BaseAbstractClass --> ChildA
	deactivate BaseAbstractClass
deactivate ChildA

@enduml

----