Class BlockTag.Segment

java.lang.Object

com.github.chhorz.javadoc.tags.BlockTag.Segment

Enclosing interface:

BlockTag

public static class BlockTag.Segment
extends Object

Representation for a javadoc segment of a given tag.

Author:

chhorz

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SEGMENT_NAME_PATTERN

Constructor Summary

Constructors

Constructor	Description
Segment(String name)
Segment(String segmentName, boolean required)

Method Summary

Modifier and Type	Method	Description
String	getSegmentName()
boolean	isRequired()
String	toString()

Methods inherited from class Object

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

Field Details

SEGMENT_NAME_PATTERN

public static final String SEGMENT_NAME_PATTERN

See Also:

• Constant Field Values

Constructor Details

Segment

public Segment(String name)

Segment

public Segment(String segmentName,
 boolean required)

Method Details

getSegmentName

public String getSegmentName()

isRequired

public boolean isRequired()

toString

public String toString()

Overrides:

toString in class Object