BlockTag

All Superinterfaces:

Tag

All Known Implementing Classes:

AuthorTag, CategoryTag, ConstructorTag, DeprecatedTag, ExceptionTag, HiddenTag, ParamTag, PatternTag, PropertyTag, ProvidesTag, ReceiverTag, ReturnTag, SampleTag, SeeTag, SerialDataTag, SerialFieldTag, SerialTag, SinceTag, StructuredTag, SuppressTag, ThrowsTag, UsesTag, VersionTag
```
public interface BlockTag
extends Tag
```
Oracle documentation block tags

Author:

chhorz

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class BlockTag.Segment
Representation for a javadoc segment of a given tag.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.String`	`createPattern(java.lang.String allTagNames)`
`java.util.List<BlockTag.Segment>`	`getSegments()`
`void`	`putValue(java.lang.String segmentName, java.lang.String value)`

Methods inherited from interface com.github.chhorz.javadoc.tags.Tag
getTagName

- Method Detail
  - getSegments
```
java.util.List<BlockTag.Segment> getSegments()
```
    Returns:
    
    all names of segments that can be read
  - putValue
```
void putValue(java.lang.String segmentName,
              java.lang.String value)
```
    Parameters:
    
    segmentName - the segment name for which the value should be saved
    
    value - the value that was parsed for the segment
  - createPattern
```
java.lang.String createPattern(java.lang.String allTagNames)
```
    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