com.phoenixnap.oss.ramlapisync.naming

Class RamlHelper

java.lang.Object

com.phoenixnap.oss.ramlapisync.naming.RamlHelper

public class RamlHelper
extends Object

Class containing utility methods for modifying Raml models

Since:

0.5.3

Author:

kurtpa

Constructor Summary

Constructors

Constructor and Description
RamlHelper()

Method Summary

Modifier and Type	Method and Description
static RamlResponse	getSuccessfulResponse(RamlAction action) Gets the successful response from an action (200 or 201)
static void	mergeActions(RamlAction existingAction, RamlAction newAction) Merges together existing actions.
static void	mergeResources(RamlResource existing, RamlResource resource, boolean addActions) Tree merging algorithm, if a resource already exists it will not overwrite and add all children to the existing resource
static void	mergeResources(RamlRoot raml, RamlResource resource, boolean addActions) Merges two RAML Resources trees together.
static void	removeResourceTree(RamlRoot model, String urlPrefixToIgnore) Removes a section of the tree from the resources in a Raml model and moves all sub resources to the root

Methods inherited from class java.lang.Object

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

Constructor Detail

RamlHelper

public RamlHelper()

Method Detail

mergeResources

public static void mergeResources(RamlResource existing,
                                  RamlResource resource,
                                  boolean addActions)

Tree merging algorithm, if a resource already exists it will not overwrite and add all children to the existing resource

Parameters:

existing - The existing resource in the model

resource - The resource to merge in

addActions - If true it will copy all actions even if the resource itself isnt copied

mergeResources

public static void mergeResources(RamlRoot raml,
                                  RamlResource resource,
                                  boolean addActions)

Merges two RAML Resources trees together. This is non-recursive and could currently lose children in lower levels.

Parameters:

raml - The RAML model to merge into

resource - The candidate resource

addActions - whether we should add actions

mergeActions

public static void mergeActions(RamlAction existingAction,
                                RamlAction newAction)

Merges together existing actions. At present we are doing the following: - Add Response bodies from the new to existing TODO Other operations that we should consider. Not adding these until an actual usecase crops up. - Merging Descriptions? - Copying over Request Data? - Copying over other responses?

Parameters:

existingAction - The action we already have in our model

newAction - The action we we want to include in the model

getSuccessfulResponse

public static RamlResponse getSuccessfulResponse(RamlAction action)

Gets the successful response from an action (200 or 201)

Parameters:

action - The action to parse

Returns:

The Successful response or null if not found

removeResourceTree

public static void removeResourceTree(RamlRoot model,
                                      String urlPrefixToIgnore)

Removes a section of the tree from the resources in a Raml model and moves all sub resources to the root

Parameters:

model - The Raml model to modify

urlPrefixToIgnore - The section of the URL to remove