io.swagger.transform.util

Class SwaggerMigrators

java.lang.Object

io.swagger.transform.util.SwaggerMigrators

@ParametersAreNonnullByDefault
public final class SwaggerMigrators
extends Object

Utility SwaggerMigrators

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SwaggerMigrators.MembersToString Migrator converting object member values to JSON Strings

Constructor Summary

Constructors

Constructor and Description
SwaggerMigrators()

Method Summary

Methods

Modifier and Type	Method and Description
static SwaggerMigrator	fromPatch(com.github.fge.jsonpatch.JsonPatch patch) Return a migrator applying a JSON Patch
static SwaggerMigrator	membersToString(String first, String... others) Return a migrator converting object member values to JSON Strings
static SwaggerMigrator	patchFromResource(String resourcePath) Return a migrator applying a JSON Patch as read from the classpath
static SwaggerMigrator	renameMember(String from, String to) Return a migrator renaming object members

Methods inherited from class java.lang.Object

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

Constructor Detail

SwaggerMigrators

public SwaggerMigrators()

Method Detail

membersToString

public static SwaggerMigrator membersToString(String first,
                              String... others)

Return a migrator converting object member values to JSON Strings

Note that this will only work if member values are not containers (ie, JSON Arrays or Objects).

Parameters:

first - first member name

others - one or more other member names

Returns:

a migrator

See Also:

SwaggerMigrators.MembersToString

fromPatch

public static SwaggerMigrator fromPatch(com.github.fge.jsonpatch.JsonPatch patch)

Return a migrator applying a JSON Patch

The JSON Patch must be deserialized at this point. You can also load one from the classpath using patchFromResource(String).

Parameters:

patch - the JSON patch to apply

Returns:

a migrator

See Also:

JsonPatch

renameMember

public static SwaggerMigrator renameMember(String from,
                           String to)

Return a migrator renaming object members

Note that this migrator will not fail if the member to rename does not exists; however it will fail if the target member already exists in the target JSON Object.

Parameters:

from - the member name to rename

to - the new name

Returns:

a migrator

patchFromResource

public static SwaggerMigrator patchFromResource(String resourcePath)

Return a migrator applying a JSON Patch as read from the classpath

Parameters:

resourcePath - the resource path

Returns:

a migrator

See Also:

fromPatch(JsonPatch)