public class Swagger2MarkupProperties
extends java.lang.Object
| 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 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) |
| 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. |
public static final java.lang.String PROPERTIES_PREFIX
public static final java.lang.String MARKUP_LANGUAGE
public static final java.lang.String SWAGGER_MARKUP_LANGUAGE
public static final java.lang.String GENERATED_EXAMPLES_ENABLED
public static final java.lang.String BASE_PATH_PREFIX_ENABLED
public static final java.lang.String SEPARATED_DEFINITIONS_ENABLED
public static final java.lang.String SEPARATED_OPERATIONS_ENABLED
public static final java.lang.String PATHS_GROUPED_BY
public static final java.lang.String HEADER_REGEX
public static final java.lang.String OUTPUT_LANGUAGE
public static final java.lang.String INLINE_SCHEMA_ENABLED
public static final java.lang.String INTER_DOCUMENT_CROSS_REFERENCES_ENABLED
public static final java.lang.String INTER_DOCUMENT_CROSS_REFERENCES_PREFIX
public static final java.lang.String FLAT_BODY_ENABLED
public static final java.lang.String PATH_SECURITY_SECTION_ENABLED
public static final java.lang.String ANCHOR_PREFIX
public static final java.lang.String OVERVIEW_DOCUMENT
public static final java.lang.String PATHS_DOCUMENT
public static final java.lang.String DEFINITIONS_DOCUMENT
public static final java.lang.String SECURITY_DOCUMENT
public static final java.lang.String SEPARATED_OPERATIONS_FOLDER
public static final java.lang.String SEPARATED_DEFINITIONS_FOLDER
public static final java.lang.String TAG_ORDER_BY
public static final java.lang.String OPERATION_ORDER_BY
public static final java.lang.String DEFINITION_ORDER_BY
public static final java.lang.String PARAMETER_ORDER_BY
public static final java.lang.String PROPERTY_ORDER_BY
public static final java.lang.String RESPONSE_ORDER_BY
public static final java.lang.String LINE_SEPARATOR
public static final java.lang.String PAGE_BREAK_LOCATIONS
public static final java.lang.String EXTENSION_PREFIX
public Swagger2MarkupProperties(java.util.Properties properties)
public Swagger2MarkupProperties(java.util.Map<java.lang.String,java.lang.String> map)
public Swagger2MarkupProperties(org.apache.commons.configuration2.Configuration configuration)
public java.util.Optional<java.lang.String> getString(java.lang.String key)
key - the property name to resolvepublic java.lang.String getString(java.lang.String key,
java.lang.String defaultValue)
defaultValue if the key cannot be resolved.key - the property name to resolvedefaultValue - the default value to return if no value is foundpublic int getInt(java.lang.String key,
int defaultValue)
defaultValue if the key cannot be resolved.key - the property name to resolvedefaultValue - the default value to return if no value is foundpublic java.util.Optional<java.lang.Integer> getInteger(java.lang.String key)
key - the property name to resolvepublic int getRequiredInt(java.lang.String key)
null).java.lang.IllegalStateException - if the key cannot bepublic boolean getRequiredBoolean(java.lang.String key)
null).java.lang.IllegalStateException - if the key cannot be resolvedpublic boolean getBoolean(java.lang.String key,
boolean defaultValue)
defaultValue if the key cannot be resolved.key - the property name to resolvedefaultValue - the default value to return if no value is foundpublic java.util.Optional<java.net.URI> getURI(java.lang.String key)
defaultValue if the key cannot be resolved.key - the property name to resolvejava.lang.IllegalStateException - if the value cannot be mapped to the enumpublic java.net.URI getRequiredURI(java.lang.String key)
null).java.lang.IllegalStateException - if the key cannot be resolvedpublic java.util.Optional<java.nio.file.Path> getPath(java.lang.String key)
defaultValue if the key cannot be resolved.key - the property name to resolvejava.lang.IllegalStateException - if the value cannot be mapped to the enumpublic java.nio.file.Path getRequiredPath(java.lang.String key)
null).java.lang.IllegalStateException - if the key cannot be resolvedpublic java.util.Optional<io.github.swagger2markup.markup.builder.MarkupLanguage> getMarkupLanguage(java.lang.String key)
defaultValue if the key cannot be resolved.key - the property name to resolvepublic io.github.swagger2markup.markup.builder.MarkupLanguage getRequiredMarkupLanguage(java.lang.String key)
null).java.lang.IllegalStateException - if the key cannot be resolvedpublic Language getLanguage(java.lang.String key)
defaultValue if the key cannot be resolved.key - the property name to resolvepublic GroupBy getGroupBy(java.lang.String key)
defaultValue if the key cannot be resolved.key - the property name to resolvejava.lang.IllegalStateException - if the value cannot be mapped to the enumpublic OrderBy getOrderBy(java.lang.String key)
defaultValue if the key cannot be resolved.key - the property name to resolvejava.lang.IllegalStateException - if the value cannot be mapped to the enumpublic java.lang.String getRequiredString(java.lang.String key)
throws java.lang.IllegalStateException
null).java.lang.IllegalStateException - if the key cannot be resolvedpublic java.util.List<java.lang.String> getKeys()
public java.util.List<java.lang.String> getKeys(java.lang.String prefix)
swagger2markup.extensions.folder1, swagger2markup.extensions.folder2, swagger2markup.folder3,getKeys("swagger2markup.extensions");swagger2markup.extensions.folder1, swagger2markup.extensions.folder2.prefix - The prefix to test against.public java.util.List<PageBreakLocations> getPageBreakLocations(java.lang.String key)
public java.util.Optional<java.util.regex.Pattern> getHeaderPattern(java.lang.String key)