Package com.github.chhorz.javadoc.tags
Class StructuredTag
- java.lang.Object
-
- com.github.chhorz.javadoc.tags.StructuredTag
-
- Direct Known Subclasses:
AuthorTag
,CategoryTag
,ConstructorTag
,DeprecatedTag
,ExceptionTag
,HiddenTag
,ParamTag
,PropertyTag
,ProvidesTag
,ReceiverTag
,ReturnTag
,SampleTag
,SeeTag
,SerialDataTag
,SerialFieldTag
,SerialTag
,SinceTag
,SuppressTag
,ThrowsTag
,UsesTag
,VersionTag
public abstract class StructuredTag extends java.lang.Object implements BlockTag
Structured tags are base javadoc block tags of scheme:@author name-text
@param parameter-name description
- Author:
- chhorz
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.github.chhorz.javadoc.tags.BlockTag
BlockTag.Segment
-
-
Constructor Summary
Constructors Constructor Description StructuredTag(java.lang.String tagName, BlockTag.Segment... segments)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
createPattern(java.lang.String allTagNames)
java.util.List<BlockTag.Segment>
getSegments()
java.lang.String
getTagName()
java.util.Map<java.lang.String,java.lang.String>
getValues()
void
putValue(java.lang.String segmentName, java.lang.String segmentValue)
java.lang.String
toString()
-
-
-
Constructor Detail
-
StructuredTag
public StructuredTag(java.lang.String tagName, BlockTag.Segment... segments)
-
-
Method Detail
-
getTagName
public java.lang.String getTagName()
- Specified by:
getTagName
in interfaceTag
- Returns:
- the Javadoc tag name
-
getSegments
public java.util.List<BlockTag.Segment> getSegments()
- Specified by:
getSegments
in interfaceBlockTag
- Returns:
- all names of segments that can be read
-
getValues
public java.util.Map<java.lang.String,java.lang.String> getValues()
-
putValue
public void putValue(java.lang.String segmentName, java.lang.String segmentValue)
-
createPattern
public java.lang.String createPattern(java.lang.String allTagNames)
- Specified by:
createPattern
in interfaceBlockTag
- Parameters:
allTagNames
- the list of all patterns will be calculated on the fly and describes the end of a single tag- Returns:
- the complete pattern string for this tag
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-