Swagger2MarkupConfigBuilder (swagger2markup 1.2.0 API)

java.lang.Object
- io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder

public class Swagger2MarkupConfigBuilder
extends java.lang.Object

Constructor Summary

Constructors
Constructor and Description
`Swagger2MarkupConfigBuilder()`
`Swagger2MarkupConfigBuilder(org.apache.commons.configuration2.Configuration configuration)`
`Swagger2MarkupConfigBuilder(java.util.Map<java.lang.String,java.lang.String> map)`
`Swagger2MarkupConfigBuilder(java.util.Properties properties)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Swagger2MarkupConfig`	`build()` Builds the Swagger2MarkupConfig.
`Swagger2MarkupConfigBuilder`	`withAnchorPrefix(java.lang.String anchorPrefix)` Optionally prefix all anchors for uniqueness.
`Swagger2MarkupConfigBuilder`	`withBasePathPrefix()` Prepend the base path to all paths.
`Swagger2MarkupConfigBuilder`	`withDefinitionOrdering(java.util.Comparator<java.lang.String> definitionOrdering)` Specifies a custom comparator function to order definitions.
`Swagger2MarkupConfigBuilder`	`withDefinitionOrdering(OrderBy orderBy)` Specifies definition ordering.
`Swagger2MarkupConfigBuilder`	`withFlatBody()` Optionally isolate the body parameter, if any, from other parameters.
`Swagger2MarkupConfigBuilder`	`withGeneratedExamples()` Include generated examples into the documents.
`Swagger2MarkupConfigBuilder`	`withHeaderRegex(java.lang.String headerRegex)` Specifies the regex pattern to use for grouping paths.
`Swagger2MarkupConfigBuilder`	`withInterDocumentCrossReferences()` Enable use of inter-document cross-references when needed.
`Swagger2MarkupConfigBuilder`	`withInterDocumentCrossReferences(java.lang.String prefix)` Enable use of inter-document cross-references when needed.
`Swagger2MarkupConfigBuilder`	`withLineSeparator(io.github.swagger2markup.markup.builder.LineSeparator lineSeparator)` Specifies the line separator which should be used.
`Swagger2MarkupConfigBuilder`	`withMarkupLanguage(io.github.swagger2markup.markup.builder.MarkupLanguage markupLanguage)` Specifies the markup language which should be used to generate the files.
`Swagger2MarkupConfigBuilder`	`withOperationOrdering(java.util.Comparator<PathOperation> operationOrdering)` Specifies a custom comparator function to order operations.
`Swagger2MarkupConfigBuilder`	`withOperationOrdering(OrderBy orderBy)` Specifies operation ordering.
`Swagger2MarkupConfigBuilder`	`withoutInlineSchema()` Disable inline schema support.
`Swagger2MarkupConfigBuilder`	`withoutPathSecuritySection()` Optionally disable the security section for path sections
`Swagger2MarkupConfigBuilder`	`withOutputLanguage(Language language)` Specifies labels language of output files.
`Swagger2MarkupConfigBuilder`	`withPageBreaks(java.util.List<PageBreakLocations> locations)` Set the page break locations
`Swagger2MarkupConfigBuilder`	`withParameterOrdering(java.util.Comparator<io.swagger.models.parameters.Parameter> parameterOrdering)` Specifies a custom comparator function to order parameters.
`Swagger2MarkupConfigBuilder`	`withParameterOrdering(OrderBy orderBy)` Specifies parameter ordering.
`Swagger2MarkupConfigBuilder`	`withPathsGroupedBy(GroupBy pathsGroupedBy)` Specifies if the paths should be grouped by tags or stay as-is.
`Swagger2MarkupConfigBuilder`	`withPropertyOrdering(java.util.Comparator<java.lang.String> propertyOrdering)` Specifies a custom comparator function to order properties.
`Swagger2MarkupConfigBuilder`	`withPropertyOrdering(OrderBy orderBy)` Specifies property ordering.
`Swagger2MarkupConfigBuilder`	`withResponseOrdering(java.util.Comparator<java.lang.String> responseOrdering)` Specifies a custom comparator function to order responses.
`Swagger2MarkupConfigBuilder`	`withResponseOrdering(OrderBy orderBy)` Specifies response ordering.
`Swagger2MarkupConfigBuilder`	`withSeparatedDefinitions()` In addition to the Definitions file, also create separate definition files for each model definition.
`Swagger2MarkupConfigBuilder`	`withSeparatedOperations()` In addition to the Paths file, also create separate operation files for each operation.
`Swagger2MarkupConfigBuilder`	`withSwaggerMarkupLanguage(io.github.swagger2markup.markup.builder.MarkupLanguage swaggerMarkupLanguage)` Specifies the markup language used in Swagger descriptions.
`Swagger2MarkupConfigBuilder`	`withTagOrdering(java.util.Comparator<java.lang.String> tagOrdering)` Specifies a custom comparator function to order tags.
`Swagger2MarkupConfigBuilder`	`withTagOrdering(OrderBy orderBy)` Specifies tag ordering.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Swagger2MarkupConfigBuilder
```
public Swagger2MarkupConfigBuilder()
```
  - Swagger2MarkupConfigBuilder
```
public Swagger2MarkupConfigBuilder(java.util.Properties properties)
```
  - Swagger2MarkupConfigBuilder
```
public Swagger2MarkupConfigBuilder(java.util.Map<java.lang.String,java.lang.String> map)
```
  - Swagger2MarkupConfigBuilder
```
public Swagger2MarkupConfigBuilder(org.apache.commons.configuration2.Configuration configuration)
```
- Method Detail
  - build
```
public Swagger2MarkupConfig build()
```
    Builds the Swagger2MarkupConfig.
    
    Returns:
    
    the Swagger2MarkupConfig
  - withMarkupLanguage
```
public Swagger2MarkupConfigBuilder withMarkupLanguage(io.github.swagger2markup.markup.builder.MarkupLanguage markupLanguage)
```
    Specifies the markup language which should be used to generate the files.
    
    Parameters:
    
    markupLanguage - the markup language which is used to generate the files
    
    Returns:
    
    this builder
  - withSwaggerMarkupLanguage
```
public Swagger2MarkupConfigBuilder withSwaggerMarkupLanguage(io.github.swagger2markup.markup.builder.MarkupLanguage swaggerMarkupLanguage)
```
    Specifies the markup language used in Swagger descriptions.
    
    Parameters:
    
    swaggerMarkupLanguage - the markup language used in Swagger descriptions
    
    Returns:
    
    this builder
  - withGeneratedExamples
```
public Swagger2MarkupConfigBuilder withGeneratedExamples()
```
    Include generated examples into the documents.
    
    Returns:
    
    this builder
  - withSeparatedDefinitions
```
public Swagger2MarkupConfigBuilder withSeparatedDefinitions()
```
    In addition to the Definitions file, also create separate definition files for each model definition.
    
    Returns:
    
    this builder
  - withSeparatedOperations
```
public Swagger2MarkupConfigBuilder withSeparatedOperations()
```
    In addition to the Paths file, also create separate operation files for each operation.
    
    Returns:
    
    this builder
  - withPathsGroupedBy
```
public Swagger2MarkupConfigBuilder withPathsGroupedBy(GroupBy pathsGroupedBy)
```
    Specifies if the paths should be grouped by tags or stay as-is.
    
    Parameters:
    
    pathsGroupedBy - the GroupBy enum
    
    Returns:
    
    this builder
  - withHeaderRegex
```
public Swagger2MarkupConfigBuilder withHeaderRegex(java.lang.String headerRegex)
```
    Specifies the regex pattern to use for grouping paths.
    
    Parameters:
    
    headerRegex - regex pattern string containing one capture group
    
    Returns:
    
    this builder
    
    Throws:
    
    java.util.regex.PatternSyntaxException - when pattern cannot be compiled
  - withOutputLanguage
```
public Swagger2MarkupConfigBuilder withOutputLanguage(Language language)
```
    Specifies labels language of output files.
    
    Parameters:
    
    language - the enum
    
    Returns:
    
    this builder
  - withoutInlineSchema
```
public Swagger2MarkupConfigBuilder withoutInlineSchema()
```
    Disable inline schema support.
    
    Returns:
    
    this builder
  - withTagOrdering
```
public Swagger2MarkupConfigBuilder withTagOrdering(OrderBy orderBy)
```
    Specifies tag ordering.
    By default tag ordering == OrderBy.NATURAL.
    Use withTagOrdering(Comparator) to set a custom ordering.
    
    Parameters:
    
    orderBy - tag ordering
    
    Returns:
    
    this builder
  - withTagOrdering
```
public Swagger2MarkupConfigBuilder withTagOrdering(java.util.Comparator<java.lang.String> tagOrdering)
```
    Specifies a custom comparator function to order tags.
    
    Parameters:
    
    tagOrdering - tag ordering
    
    Returns:
    
    this builder
  - withOperationOrdering
```
public Swagger2MarkupConfigBuilder withOperationOrdering(OrderBy orderBy)
```
    Specifies operation ordering.
    By default operation ordering == OrderBy.AS_IS.
    Use withOperationOrdering(Comparator) to set a custom ordering.
    
    Parameters:
    
    orderBy - operation ordering
    
    Returns:
    
    this builder
  - withOperationOrdering
```
public Swagger2MarkupConfigBuilder withOperationOrdering(java.util.Comparator<PathOperation> operationOrdering)
```
    Specifies a custom comparator function to order operations.
    
    Parameters:
    
    operationOrdering - operation ordering
    
    Returns:
    
    this builder
  - withDefinitionOrdering
```
public Swagger2MarkupConfigBuilder withDefinitionOrdering(OrderBy orderBy)
```
    Specifies definition ordering.
    By default definition ordering == OrderBy.NATURAL.
    Use withDefinitionOrdering(Comparator) to set a custom ordering.
    
    Parameters:
    
    orderBy - definition ordering
    
    Returns:
    
    this builder
  - withDefinitionOrdering
```
public Swagger2MarkupConfigBuilder withDefinitionOrdering(java.util.Comparator<java.lang.String> definitionOrdering)
```
    Specifies a custom comparator function to order definitions.
    
    Parameters:
    
    definitionOrdering - definition ordering
    
    Returns:
    
    this builder
  - withParameterOrdering
```
public Swagger2MarkupConfigBuilder withParameterOrdering(OrderBy orderBy)
```
    Specifies parameter ordering.
    By default parameter ordering == OrderBy.NATURAL.
    Use withParameterOrdering(Comparator) to set a custom ordering.
    
    Parameters:
    
    orderBy - parameter ordering
    
    Returns:
    
    this builder
  - withParameterOrdering
```
public Swagger2MarkupConfigBuilder withParameterOrdering(java.util.Comparator<io.swagger.models.parameters.Parameter> parameterOrdering)
```
    Specifies a custom comparator function to order parameters.
    
    Parameters:
    
    parameterOrdering - parameter ordering
    
    Returns:
    
    this builder
  - withPropertyOrdering
```
public Swagger2MarkupConfigBuilder withPropertyOrdering(OrderBy orderBy)
```
    Specifies property ordering.
    By default property ordering == OrderBy.NATURAL.
    Use withPropertyOrdering(Comparator) to set a custom ordering.
    
    Parameters:
    
    orderBy - property ordering
    
    Returns:
    
    this builder
  - withPropertyOrdering
```
public Swagger2MarkupConfigBuilder withPropertyOrdering(java.util.Comparator<java.lang.String> propertyOrdering)
```
    Specifies a custom comparator function to order properties.
    
    Parameters:
    
    propertyOrdering - property ordering
    
    Returns:
    
    this builder
  - withResponseOrdering
```
public Swagger2MarkupConfigBuilder withResponseOrdering(OrderBy orderBy)
```
    Specifies response ordering.
    By default response ordering == OrderBy.NATURAL.
    Use withResponseOrdering(Comparator) to set a custom ordering.
    
    Parameters:
    
    orderBy - response ordering
    
    Returns:
    
    this builder
  - withResponseOrdering
```
public Swagger2MarkupConfigBuilder withResponseOrdering(java.util.Comparator<java.lang.String> responseOrdering)
```
    Specifies a custom comparator function to order responses.
    
    Parameters:
    
    responseOrdering - response ordering
    
    Returns:
    
    this builder
  - withInterDocumentCrossReferences
```
public Swagger2MarkupConfigBuilder withInterDocumentCrossReferences(java.lang.String prefix)
```
    Enable use of inter-document cross-references when needed.
    
    Parameters:
    
    prefix - Prefix to document in all inter-document cross-references.
    
    Returns:
    
    this builder
  - withInterDocumentCrossReferences
```
public Swagger2MarkupConfigBuilder withInterDocumentCrossReferences()
```
    Enable use of inter-document cross-references when needed.
    
    Returns:
    
    this builder
  - withFlatBody
```
public Swagger2MarkupConfigBuilder withFlatBody()
```
    Optionally isolate the body parameter, if any, from other parameters.
    
    Returns:
    
    this builder
  - withoutPathSecuritySection
```
public Swagger2MarkupConfigBuilder withoutPathSecuritySection()
```
    Optionally disable the security section for path sections
    
    Returns:
    
    this builder
  - withBasePathPrefix
```
public Swagger2MarkupConfigBuilder withBasePathPrefix()
```
    Prepend the base path to all paths.
    
    Returns:
    
    this builder
  - withAnchorPrefix
```
public Swagger2MarkupConfigBuilder withAnchorPrefix(java.lang.String anchorPrefix)
```
    Optionally prefix all anchors for uniqueness.
    
    Parameters:
    
    anchorPrefix - anchor prefix.
    
    Returns:
    
    this builder
  - withPageBreaks
```
public Swagger2MarkupConfigBuilder withPageBreaks(java.util.List<PageBreakLocations> locations)
```
    Set the page break locations
    
    Parameters:
    
    locations - List of locations to create new pages
    
    Returns:
    
    this builder
  - withLineSeparator
```
public Swagger2MarkupConfigBuilder withLineSeparator(io.github.swagger2markup.markup.builder.LineSeparator lineSeparator)
```
    Specifies the line separator which should be used.
    
    Parameters:
    
    lineSeparator - the lineSeparator
    
    Returns:
    
    this builder

Class Swagger2MarkupConfigBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Swagger2MarkupConfigBuilder

Swagger2MarkupConfigBuilder

Swagger2MarkupConfigBuilder

Swagger2MarkupConfigBuilder

Method Detail

build

withMarkupLanguage

withSwaggerMarkupLanguage

withGeneratedExamples

withSeparatedDefinitions

withSeparatedOperations

withPathsGroupedBy

withHeaderRegex

withOutputLanguage

withoutInlineSchema

withTagOrdering

withTagOrdering

withOperationOrdering

withOperationOrdering

withDefinitionOrdering

withDefinitionOrdering

withParameterOrdering

withParameterOrdering

withPropertyOrdering

withPropertyOrdering

withResponseOrdering

withResponseOrdering

withInterDocumentCrossReferences

withInterDocumentCrossReferences

withFlatBody

withoutPathSecuritySection

withBasePathPrefix

withAnchorPrefix

withPageBreaks

withLineSeparator