org.itsallcode.openfasttrace.importer.markdown

Class MarkdownForwardingSpecificationItem

java.lang.Object

org.itsallcode.openfasttrace.importer.markdown.MarkdownForwardingSpecificationItem

public class MarkdownForwardingSpecificationItem
extends Object

The MarkdownForwardingSpecificationItem splits the textual representation of a specification item that forwards needed artifact coverage into is components.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORWARD_MARKER
static String	ORIGINAL_MARKER

Constructor Summary

Constructors

Constructor and Description
MarkdownForwardingSpecificationItem(String forward) Create an instance of MarkdownForwardingSpecificationItem

Method Summary

Modifier and Type	Method and Description
SpecificationItemId	getOriginalId() The ID of the specification item that originally required coverage
String	getSkippedArtifactType() The artifact type which forwards the needed coverage (in effect the one that is "skipped" during authoring)
SpecificationItemId	getSkippedId() The constructed ID of the specification item that gets "skipped" by forwarding the needed coverage
List<String>	getTargetArtifactTypes() The list of artifact types the needed coverage is forwarded to

Methods inherited from class java.lang.Object

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

Field Detail

ORIGINAL_MARKER

public static final String ORIGINAL_MARKER

See Also:

Constant Field Values

FORWARD_MARKER

public static final String FORWARD_MARKER

See Also:

Constant Field Values

Constructor Detail

MarkdownForwardingSpecificationItem

public MarkdownForwardingSpecificationItem(String forward)

Create an instance of MarkdownForwardingSpecificationItem

Parameters:

forward - the textual representation

Method Detail

getSkippedArtifactType

public String getSkippedArtifactType()

The artifact type which forwards the needed coverage (in effect the one that is "skipped" during authoring)

Returns:

the "skipped" artifact type

getOriginalId

public SpecificationItemId getOriginalId()

The ID of the specification item that originally required coverage

Returns:

the specification item ID

getSkippedId

public SpecificationItemId getSkippedId()

The constructed ID of the specification item that gets "skipped" by forwarding the needed coverage

Returns:

ID of the "skipped" item

getTargetArtifactTypes

public List<String> getTargetArtifactTypes()

The list of artifact types the needed coverage is forwarded to

Returns:

list of artifact types