public class ApiListingBuilder
extends java.lang.Object
Constructor and Description |
---|
ApiListingBuilder(com.google.common.collect.Ordering<ApiDescription> descriptionOrdering)
Update the sorting order for api descriptions
|
Modifier and Type | Method and Description |
---|---|
ApiListingBuilder |
apis(java.util.List<ApiDescription> apis)
Updates the apis
|
ApiListingBuilder |
apiVersion(java.lang.String apiVersion)
Updates the api version
|
ApiListingBuilder |
appendConsumes(java.util.List<java.lang.String> consumes)
Appends to the exiting collection of supported media types this listing consumes
|
ApiListingBuilder |
appendProduces(java.util.List<java.lang.String> produces)
Appends to the exiting collection of supported media types this listing produces
|
ApiListingBuilder |
availableTags(java.util.Set<Tag> availableTags)
Globally configured tags
|
ApiListingBuilder |
basePath(java.lang.String basePath)
Updates base path for the api listing
|
ApiListing |
build() |
ApiListingBuilder |
consumes(java.util.Set<java.lang.String> mediaTypes)
Replaces the existing media types with new entries that this documentation consumes
|
ApiListingBuilder |
description(java.lang.String description)
Updates the description
|
ApiListingBuilder |
host(java.lang.String host)
Updates the host
|
ApiListingBuilder |
models(java.util.Map<java.lang.String,Model> models)
Adds to the models collection
|
ApiListingBuilder |
position(int position)
Updates the position of the listing
|
ApiListingBuilder |
produces(java.util.Set<java.lang.String> mediaTypes)
Replaces the existing media types with new entries that this documentation produces
|
ApiListingBuilder |
protocols(java.util.Set<java.lang.String> protocols)
Appends to the exiting collection of supported protocols
|
ApiListingBuilder |
resourcePath(java.lang.String resourcePath)
Updates resource path for the api listing
|
ApiListingBuilder |
securityReferences(java.util.List<SecurityReference> securityReferences)
Updates the references to the security definitiosn
|
ApiListingBuilder |
tagNames(java.util.Set<java.lang.String> tagNames)
Updates the tags
|
ApiListingBuilder |
tags(java.util.Set<Tag> tags)
Updates the tags.
|
public ApiListingBuilder(com.google.common.collect.Ordering<ApiDescription> descriptionOrdering)
descriptionOrdering
- - ordering for the api descriptionspublic ApiListingBuilder apiVersion(java.lang.String apiVersion)
apiVersion
- - api versionpublic ApiListingBuilder basePath(java.lang.String basePath)
basePath
- - base pathpublic ApiListingBuilder resourcePath(java.lang.String resourcePath)
resourcePath
- - resource pathpublic ApiListingBuilder produces(java.util.Set<java.lang.String> mediaTypes)
mediaTypes
- - new media typespublic ApiListingBuilder consumes(java.util.Set<java.lang.String> mediaTypes)
mediaTypes
- - new media typespublic ApiListingBuilder appendProduces(java.util.List<java.lang.String> produces)
produces
- - new media typespublic ApiListingBuilder appendConsumes(java.util.List<java.lang.String> consumes)
consumes
- - new media typespublic ApiListingBuilder host(java.lang.String host)
host
- - new hostpublic ApiListingBuilder protocols(java.util.Set<java.lang.String> protocols)
protocols
- - new protocolspublic ApiListingBuilder securityReferences(java.util.List<SecurityReference> securityReferences)
securityReferences
- - security definition referencespublic ApiListingBuilder apis(java.util.List<ApiDescription> apis)
apis
- - apispublic ApiListingBuilder models(java.util.Map<java.lang.String,Model> models)
models
- - model entries by namepublic ApiListingBuilder description(java.lang.String description)
description
- - description of the api listingpublic ApiListingBuilder position(int position)
position
- - position used to for sorting the listingspublic ApiListingBuilder tagNames(java.util.Set<java.lang.String> tagNames)
tagNames
- - just the tag namespublic ApiListingBuilder tags(java.util.Set<Tag> tags)
tags
- - Tag with name and descriptionpublic ApiListingBuilder availableTags(java.util.Set<Tag> availableTags)
availableTags
- - tags available for services and operationspublic ApiListing build()