io.github.swagger2markup.internal.utils

Class InlineSchemaUtils

java.lang.Object

io.github.swagger2markup.internal.utils.InlineSchemaUtils

public class InlineSchemaUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
InlineSchemaUtils()

Method Summary

Modifier and Type	Method and Description
static Type	createInlineType(Type type, java.lang.String name, java.lang.String uniqueName, java.util.List<ObjectType> inlineDefinitions) Returns a RefType to a new inlined type named with name and uniqueName.

Methods inherited from class java.lang.Object

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

Constructor Detail

InlineSchemaUtils

public InlineSchemaUtils()

Method Detail

createInlineType

public static Type createInlineType(Type type,
                                    java.lang.String name,
                                    java.lang.String uniqueName,
                                    java.util.List<ObjectType> inlineDefinitions)

Returns a RefType to a new inlined type named with name and uniqueName.
The returned RefType point to the new inlined type which is added to the inlineDefinitions collection.
The function is recursive and support collections (ArrayType and MapType).
The function is transparent : type is returned as-is if type is not inlinable or if !config.isInlineSchemaEnabled().

Parameters:

type - type to inline

name - name of the created inline ObjectType

uniqueName - unique name of the created inline ObjectType

inlineDefinitions - a non null collection of inline ObjectType

Returns:

the type referencing the newly created inline ObjectType. Can be a RefType, an ArrayType or a MapType