Swagger2MarkupProperties (swagger2markup 1.2.0 API)

java.lang.Object
- io.github.swagger2markup.Swagger2MarkupProperties

public class Swagger2MarkupProperties
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ANCHOR_PREFIX`
`static java.lang.String`	`BASE_PATH_PREFIX_ENABLED`
`static java.lang.String`	`DEFINITION_ORDER_BY`
`static java.lang.String`	`DEFINITIONS_DOCUMENT`
`static java.lang.String`	`EXTENSION_PREFIX` Prefix for Swagger2Markup extension properties
`static java.lang.String`	`FLAT_BODY_ENABLED`
`static java.lang.String`	`GENERATED_EXAMPLES_ENABLED`
`static java.lang.String`	`HEADER_REGEX`
`static java.lang.String`	`INLINE_SCHEMA_ENABLED`
`static java.lang.String`	`INTER_DOCUMENT_CROSS_REFERENCES_ENABLED`
`static java.lang.String`	`INTER_DOCUMENT_CROSS_REFERENCES_PREFIX`
`static java.lang.String`	`LINE_SEPARATOR`
`static java.lang.String`	`MARKUP_LANGUAGE`
`static java.lang.String`	`OPERATION_ORDER_BY`
`static java.lang.String`	`OUTPUT_LANGUAGE`
`static java.lang.String`	`OVERVIEW_DOCUMENT`
`static java.lang.String`	`PAGE_BREAK_LOCATIONS`
`static java.lang.String`	`PARAMETER_ORDER_BY`
`static java.lang.String`	`PATH_SECURITY_SECTION_ENABLED`
`static java.lang.String`	`PATHS_DOCUMENT`
`static java.lang.String`	`PATHS_GROUPED_BY`
`static java.lang.String`	`PROPERTIES_PREFIX` Prefix for Swagger2Markup properties
`static java.lang.String`	`PROPERTY_ORDER_BY`
`static java.lang.String`	`RESPONSE_ORDER_BY`
`static java.lang.String`	`SECURITY_DOCUMENT`
`static java.lang.String`	`SEPARATED_DEFINITIONS_ENABLED`
`static java.lang.String`	`SEPARATED_DEFINITIONS_FOLDER`
`static java.lang.String`	`SEPARATED_OPERATIONS_ENABLED`
`static java.lang.String`	`SEPARATED_OPERATIONS_FOLDER`
`static java.lang.String`	`SWAGGER_MARKUP_LANGUAGE`
`static java.lang.String`	`TAG_ORDER_BY`

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getBoolean(java.lang.String key, boolean defaultValue)` Return the boolean property value associated with the given key, or `defaultValue` if the key cannot be resolved.
`GroupBy`	`getGroupBy(java.lang.String key)` Return the GroupBy property value associated with the given key, or `defaultValue` if the key cannot be resolved.
`java.util.Optional<java.util.regex.Pattern>`	`getHeaderPattern(java.lang.String key)`
`int`	`getInt(java.lang.String key, int defaultValue)` Return the int property value associated with the given key, or `defaultValue` if the key cannot be resolved.
`java.util.Optional<java.lang.Integer>`	`getInteger(java.lang.String key)` Returns an optional Integer property value associated with the given key.
`java.util.List<java.lang.String>`	`getKeys()` Return the list of keys.
`java.util.List<java.lang.String>`	`getKeys(java.lang.String prefix)` Get the list of the keys contained in the configuration that match the specified prefix.
`Language`	`getLanguage(java.lang.String key)` Return the Language property value associated with the given key, or `defaultValue` if the key cannot be resolved.
`java.util.Optional<io.github.swagger2markup.markup.builder.MarkupLanguage>`	`getMarkupLanguage(java.lang.String key)` Return the MarkupLanguage property value associated with the given key, or `defaultValue` if the key cannot be resolved.
`OrderBy`	`getOrderBy(java.lang.String key)` Return the OrderBy property value associated with the given key, or `defaultValue` if the key cannot be resolved.
`java.util.List<PageBreakLocations>`	`getPageBreakLocations(java.lang.String key)`
`java.util.Optional<java.nio.file.Path>`	`getPath(java.lang.String key)` Return the Path property value associated with the given key, or `defaultValue` if the key cannot be resolved.
`boolean`	`getRequiredBoolean(java.lang.String key)` Return the boolean property value associated with the given key (never `null`).
`int`	`getRequiredInt(java.lang.String key)` Return the int property value associated with the given key (never `null`).
`io.github.swagger2markup.markup.builder.MarkupLanguage`	`getRequiredMarkupLanguage(java.lang.String key)` Return the MarkupLanguage property value associated with the given key (never `null`).
`java.nio.file.Path`	`getRequiredPath(java.lang.String key)` Return the Path property value associated with the given key (never `null`).
`java.lang.String`	`getRequiredString(java.lang.String key)` Return the String property value associated with the given key (never `null`).
`java.net.URI`	`getRequiredURI(java.lang.String key)` Return the URI property value associated with the given key (never `null`).
`java.util.Optional<java.lang.String>`	`getString(java.lang.String key)` Returns an optional String property value associated with the given key.
`java.lang.String`	`getString(java.lang.String key, java.lang.String defaultValue)` Return the String property value associated with the given key, or `defaultValue` if the key cannot be resolved.
`java.util.Optional<java.net.URI>`	`getURI(java.lang.String key)` Return the URI property value associated with the given key, or `defaultValue` if the key cannot be resolved.

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

- Field Detail
  - PROPERTIES_PREFIX
```
public static final java.lang.String PROPERTIES_PREFIX
```
    Prefix for Swagger2Markup properties
    
    See Also:
    
    Constant Field Values
  - MARKUP_LANGUAGE
```
public static final java.lang.String MARKUP_LANGUAGE
```
    See Also:
    
    Constant Field Values
  - SWAGGER_MARKUP_LANGUAGE
```
public static final java.lang.String SWAGGER_MARKUP_LANGUAGE
```
    See Also:
    
    Constant Field Values
  - GENERATED_EXAMPLES_ENABLED
```
public static final java.lang.String GENERATED_EXAMPLES_ENABLED
```
    See Also:
    
    Constant Field Values
  - BASE_PATH_PREFIX_ENABLED
```
public static final java.lang.String BASE_PATH_PREFIX_ENABLED
```
    See Also:
    
    Constant Field Values
  - SEPARATED_DEFINITIONS_ENABLED
```
public static final java.lang.String SEPARATED_DEFINITIONS_ENABLED
```
    See Also:
    
    Constant Field Values
  - SEPARATED_OPERATIONS_ENABLED
```
public static final java.lang.String SEPARATED_OPERATIONS_ENABLED
```
    See Also:
    
    Constant Field Values
  - PATHS_GROUPED_BY
```
public static final java.lang.String PATHS_GROUPED_BY
```
    See Also:
    
    Constant Field Values
  - HEADER_REGEX
```
public static final java.lang.String HEADER_REGEX
```
    See Also:
    
    Constant Field Values
  - OUTPUT_LANGUAGE
```
public static final java.lang.String OUTPUT_LANGUAGE
```
    See Also:
    
    Constant Field Values
  - INLINE_SCHEMA_ENABLED
```
public static final java.lang.String INLINE_SCHEMA_ENABLED
```
    See Also:
    
    Constant Field Values
  - INTER_DOCUMENT_CROSS_REFERENCES_ENABLED
```
public static final java.lang.String INTER_DOCUMENT_CROSS_REFERENCES_ENABLED
```
    See Also:
    
    Constant Field Values
  - INTER_DOCUMENT_CROSS_REFERENCES_PREFIX
```
public static final java.lang.String INTER_DOCUMENT_CROSS_REFERENCES_PREFIX
```
    See Also:
    
    Constant Field Values
  - FLAT_BODY_ENABLED
```
public static final java.lang.String FLAT_BODY_ENABLED
```
    See Also:
    
    Constant Field Values
  - PATH_SECURITY_SECTION_ENABLED
```
public static final java.lang.String PATH_SECURITY_SECTION_ENABLED
```
    See Also:
    
    Constant Field Values
  - ANCHOR_PREFIX
```
public static final java.lang.String ANCHOR_PREFIX
```
    See Also:
    
    Constant Field Values
  - OVERVIEW_DOCUMENT
```
public static final java.lang.String OVERVIEW_DOCUMENT
```
    See Also:
    
    Constant Field Values
  - PATHS_DOCUMENT
```
public static final java.lang.String PATHS_DOCUMENT
```
    See Also:
    
    Constant Field Values
  - DEFINITIONS_DOCUMENT
```
public static final java.lang.String DEFINITIONS_DOCUMENT
```
    See Also:
    
    Constant Field Values
  - SECURITY_DOCUMENT
```
public static final java.lang.String SECURITY_DOCUMENT
```
    See Also:
    
    Constant Field Values
  - SEPARATED_OPERATIONS_FOLDER
```
public static final java.lang.String SEPARATED_OPERATIONS_FOLDER
```
    See Also:
    
    Constant Field Values
  - SEPARATED_DEFINITIONS_FOLDER
```
public static final java.lang.String SEPARATED_DEFINITIONS_FOLDER
```
    See Also:
    
    Constant Field Values
  - TAG_ORDER_BY
```
public static final java.lang.String TAG_ORDER_BY
```
    See Also:
    
    Constant Field Values
  - OPERATION_ORDER_BY
```
public static final java.lang.String OPERATION_ORDER_BY
```
    See Also:
    
    Constant Field Values
  - DEFINITION_ORDER_BY
```
public static final java.lang.String DEFINITION_ORDER_BY
```
    See Also:
    
    Constant Field Values
  - PARAMETER_ORDER_BY
```
public static final java.lang.String PARAMETER_ORDER_BY
```
    See Also:
    
    Constant Field Values
  - PROPERTY_ORDER_BY
```
public static final java.lang.String PROPERTY_ORDER_BY
```
    See Also:
    
    Constant Field Values
  - RESPONSE_ORDER_BY
```
public static final java.lang.String RESPONSE_ORDER_BY
```
    See Also:
    
    Constant Field Values
  - LINE_SEPARATOR
```
public static final java.lang.String LINE_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - PAGE_BREAK_LOCATIONS
```
public static final java.lang.String PAGE_BREAK_LOCATIONS
```
    See Also:
    
    Constant Field Values
  - EXTENSION_PREFIX
```
public static final java.lang.String EXTENSION_PREFIX
```
    Prefix for Swagger2Markup extension properties
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Swagger2MarkupProperties
```
public Swagger2MarkupProperties(java.util.Properties properties)
```
  - Swagger2MarkupProperties
```
public Swagger2MarkupProperties(java.util.Map<java.lang.String,java.lang.String> map)
```
  - Swagger2MarkupProperties
```
public Swagger2MarkupProperties(org.apache.commons.configuration2.Configuration configuration)
```
- Method Detail
  - getString
```
public java.util.Optional<java.lang.String> getString(java.lang.String key)
```
    Returns an optional String property value associated with the given key.
    
    Parameters:
    
    key - the property name to resolve
    
    Returns:
    
    The string property
  - getString
```
public java.lang.String getString(java.lang.String key,
                                  java.lang.String defaultValue)
```
    Return the String property value associated with the given key, or defaultValue if the key cannot be resolved.
    
    Parameters:
    
    key - the property name to resolve
    
    defaultValue - the default value to return if no value is found
    
    Returns:
    
    The string property
  - getInt
```
public int getInt(java.lang.String key,
                  int defaultValue)
```
    Return the int property value associated with the given key, or defaultValue if the key cannot be resolved.
    
    Parameters:
    
    key - the property name to resolve
    
    defaultValue - the default value to return if no value is found
    
    Returns:
    
    The int property
  - getInteger
```
public java.util.Optional<java.lang.Integer> getInteger(java.lang.String key)
```
    Returns an optional Integer property value associated with the given key.
    
    Parameters:
    
    key - the property name to resolve
    
    Returns:
    
    An optional Integer property
  - getRequiredInt
```
public int getRequiredInt(java.lang.String key)
```
    Return the int property value associated with the given key (never null).
    
    Returns:
    
    The int property
    
    Throws:
    
    java.lang.IllegalStateException - if the key cannot be
  - getRequiredBoolean
```
public boolean getRequiredBoolean(java.lang.String key)
```
    Return the boolean property value associated with the given key (never null).
    
    Returns:
    
    The boolean property
    
    Throws:
    
    java.lang.IllegalStateException - if the key cannot be resolved
  - getBoolean
```
public boolean getBoolean(java.lang.String key,
                          boolean defaultValue)
```
    Return the boolean property value associated with the given key, or defaultValue if the key cannot be resolved.
    
    Parameters:
    
    key - the property name to resolve
    
    defaultValue - the default value to return if no value is found
    
    Returns:
    
    The boolean property
  - getURI
```
public java.util.Optional<java.net.URI> getURI(java.lang.String key)
```
    Return the URI property value associated with the given key, or defaultValue if the key cannot be resolved.
    
    Parameters:
    
    key - the property name to resolve
    
    Returns:
    
    The URI property
    
    Throws:
    
    java.lang.IllegalStateException - if the value cannot be mapped to the enum
  - getRequiredURI
```
public java.net.URI getRequiredURI(java.lang.String key)
```
    Return the URI property value associated with the given key (never null).
    
    Returns:
    
    The URI property
    
    Throws:
    
    java.lang.IllegalStateException - if the key cannot be resolved
  - getPath
```
public java.util.Optional<java.nio.file.Path> getPath(java.lang.String key)
```
    Return the Path property value associated with the given key, or defaultValue if the key cannot be resolved.
    
    Parameters:
    
    key - the property name to resolve
    
    Returns:
    
    The Path property
    
    Throws:
    
    java.lang.IllegalStateException - if the value cannot be mapped to the enum
  - getRequiredPath
```
public java.nio.file.Path getRequiredPath(java.lang.String key)
```
    Return the Path property value associated with the given key (never null).
    
    Returns:
    
    The Path property
    
    Throws:
    
    java.lang.IllegalStateException - if the key cannot be resolved
  - getMarkupLanguage
```
public java.util.Optional<io.github.swagger2markup.markup.builder.MarkupLanguage> getMarkupLanguage(java.lang.String key)
```
    Return the MarkupLanguage property value associated with the given key, or defaultValue if the key cannot be resolved.
    
    Parameters:
    
    key - the property name to resolve
    
    Returns:
    
    The MarkupLanguage property
  - getRequiredMarkupLanguage
```
public io.github.swagger2markup.markup.builder.MarkupLanguage getRequiredMarkupLanguage(java.lang.String key)
```
    Return the MarkupLanguage property value associated with the given key (never null).
    
    Returns:
    
    The MarkupLanguage property
    
    Throws:
    
    java.lang.IllegalStateException - if the key cannot be resolved
  - getLanguage
```
public Language getLanguage(java.lang.String key)
```
    Return the Language property value associated with the given key, or defaultValue if the key cannot be resolved.
    
    Parameters:
    
    key - the property name to resolve
    
    Returns:
    
    The Language property
  - getGroupBy
```
public GroupBy getGroupBy(java.lang.String key)
```
    Return the GroupBy property value associated with the given key, or defaultValue if the key cannot be resolved.
    
    Parameters:
    
    key - the property name to resolve
    
    Returns:
    
    The GroupBy property
    
    Throws:
    
    java.lang.IllegalStateException - if the value cannot be mapped to the enum
  - getOrderBy
```
public OrderBy getOrderBy(java.lang.String key)
```
    Return the OrderBy property value associated with the given key, or defaultValue if the key cannot be resolved.
    
    Parameters:
    
    key - the property name to resolve
    
    Returns:
    
    The OrderBy property
    
    Throws:
    
    java.lang.IllegalStateException - if the value cannot be mapped to the enum
  - getRequiredString
```
public java.lang.String getRequiredString(java.lang.String key)
                                   throws java.lang.IllegalStateException
```
    Return the String property value associated with the given key (never null).
    
    Returns:
    
    The String property
    
    Throws:
    
    java.lang.IllegalStateException - if the key cannot be resolved
  - getKeys
```
public java.util.List<java.lang.String> getKeys()
```
    Return the list of keys.
    
    Returns:
    
    the list of keys.
  - getKeys
```
public java.util.List<java.lang.String> getKeys(java.lang.String prefix)
```
    Get the list of the keys contained in the configuration that match the specified prefix. For instance, if the configuration contains the following keys:
    swagger2markup.extensions.folder1, swagger2markup.extensions.folder2, swagger2markup.folder3,
    an invocation of getKeys("swagger2markup.extensions");
    will return the key below:
    swagger2markup.extensions.folder1, swagger2markup.extensions.folder2.
    Note that the prefix itself is included in the result set if there is a matching key. The exact behavior - how the prefix is actually interpreted - depends on a concrete implementation.
    
    Parameters:
    
    prefix - The prefix to test against.
    
    Returns:
    
    the list of keys.
  - getPageBreakLocations
```
public java.util.List<PageBreakLocations> getPageBreakLocations(java.lang.String key)
```
  - getHeaderPattern
```
public java.util.Optional<java.util.regex.Pattern> getHeaderPattern(java.lang.String key)
```

Class Swagger2MarkupProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROPERTIES_PREFIX

MARKUP_LANGUAGE

SWAGGER_MARKUP_LANGUAGE

GENERATED_EXAMPLES_ENABLED

BASE_PATH_PREFIX_ENABLED

SEPARATED_DEFINITIONS_ENABLED

SEPARATED_OPERATIONS_ENABLED

PATHS_GROUPED_BY

HEADER_REGEX

OUTPUT_LANGUAGE

INLINE_SCHEMA_ENABLED

INTER_DOCUMENT_CROSS_REFERENCES_ENABLED

INTER_DOCUMENT_CROSS_REFERENCES_PREFIX

FLAT_BODY_ENABLED

PATH_SECURITY_SECTION_ENABLED

ANCHOR_PREFIX

OVERVIEW_DOCUMENT

PATHS_DOCUMENT

DEFINITIONS_DOCUMENT

SECURITY_DOCUMENT

SEPARATED_OPERATIONS_FOLDER

SEPARATED_DEFINITIONS_FOLDER

TAG_ORDER_BY

OPERATION_ORDER_BY

DEFINITION_ORDER_BY

PARAMETER_ORDER_BY

PROPERTY_ORDER_BY

RESPONSE_ORDER_BY

LINE_SEPARATOR

PAGE_BREAK_LOCATIONS

EXTENSION_PREFIX

Constructor Detail

Swagger2MarkupProperties

Swagger2MarkupProperties

Swagger2MarkupProperties

Method Detail

getString

getString

getInt

getInteger

getRequiredInt

getRequiredBoolean

getBoolean

getURI

getRequiredURI

getPath

getRequiredPath

getMarkupLanguage

getRequiredMarkupLanguage

getLanguage

getGroupBy

getOrderBy

getRequiredString

getKeys

getKeys

getPageBreakLocations

getHeaderPattern