io.smallrye.openapi.api.util

Class ArchiveUtil

java.lang.Object

io.smallrye.openapi.api.util.ArchiveUtil

public class ArchiveUtil
extends Object

Some useful methods for creating stuff from ShrinkWrap Archives.

Author:

[email protected]

Method Summary

Modifier and Type	Method and Description
static OpenApiConfig	archiveToConfig(org.jboss.shrinkwrap.api.Archive<?> archive) Creates an OpenApiConfig instance from the given ShrinkWrap archive.
static org.jboss.jandex.IndexView	archiveToIndex(OpenApiConfig config, org.jboss.shrinkwrap.api.Archive<?> archive) Index the ShrinkWrap archive to produce a jandex index.
static OpenApiStaticFile	archiveToStaticFile(org.jboss.shrinkwrap.api.Archive<?> archive) Finds the static OpenAPI file located in the deployment and, if it exists, returns it as an OpenApiStaticFile.

Methods inherited from class java.lang.Object

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

Method Detail

archiveToConfig

public static OpenApiConfig archiveToConfig(org.jboss.shrinkwrap.api.Archive<?> archive)

Creates an OpenApiConfig instance from the given ShrinkWrap archive.

Parameters:

archive - Shrinkwrap Archive instance

Returns:

OpenApiConfig

archiveToStaticFile

public static OpenApiStaticFile archiveToStaticFile(org.jboss.shrinkwrap.api.Archive<?> archive)

Finds the static OpenAPI file located in the deployment and, if it exists, returns it as an OpenApiStaticFile. If not found, returns null. The static file (when not null) contains an InputStream to the contents of the static file. The caller is responsible for closing this stream.

Parameters:

archive - Shrinkwrap Archive instance

Returns:

OpenApiStaticFile

archiveToIndex

public static org.jboss.jandex.IndexView archiveToIndex(OpenApiConfig config,
                                                        org.jboss.shrinkwrap.api.Archive<?> archive)

Index the ShrinkWrap archive to produce a jandex index.

Parameters:

config - OpenApiConfig

archive - Shrinkwrap Archive

Returns:

indexed classes in Archive