io.github.robwin.swagger2markup.utils

Class TagUtils

java.lang.Object

io.github.robwin.swagger2markup.utils.TagUtils

public class TagUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
TagUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,io.swagger.models.Tag>	convertTagsListToMap(java.util.List<io.swagger.models.Tag> tags) Converts the global Tag list into a Map where the tag name is the key and the Tag the value.
static com.google.common.base.Optional<java.lang.String>	getTagDescription(java.util.Map<java.lang.String,io.swagger.models.Tag> tagsMap, java.lang.String tagName) Retrieves the optional description of a tag.
static com.google.common.collect.Multimap<java.lang.String,org.apache.commons.lang3.tuple.Pair<java.lang.String,io.swagger.models.Path>>	groupPathsByTag(java.util.Map<java.lang.String,io.swagger.models.Path> paths) Groups the paths by tag.

Methods inherited from class java.lang.Object

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

Constructor Detail

TagUtils

public TagUtils()

Method Detail

convertTagsListToMap

public static java.util.Map<java.lang.String,io.swagger.models.Tag> convertTagsListToMap(java.util.List<io.swagger.models.Tag> tags)

Converts the global Tag list into a Map where the tag name is the key and the Tag the value.

Parameters:

tags - the List of tags

Returns:

the Map of tags

getTagDescription

public static com.google.common.base.Optional<java.lang.String> getTagDescription(java.util.Map<java.lang.String,io.swagger.models.Tag> tagsMap,
                                                                  java.lang.String tagName)

Retrieves the optional description of a tag.

Parameters:

tagsMap - the Map of tags

tagName - the name of the tag

Returns:

the optional description of the tag

groupPathsByTag

public static com.google.common.collect.Multimap<java.lang.String,org.apache.commons.lang3.tuple.Pair<java.lang.String,io.swagger.models.Path>> groupPathsByTag(java.util.Map<java.lang.String,io.swagger.models.Path> paths)

Groups the paths by tag. The key of the Multimap is the tag name. The value of the Multimap is a Pair which contains the Method and the Path.

Parameters:

paths - the Paths

Returns:

Paths grouped by Tag