com.phoenixnap.oss.ramlapisync.naming

Class NamingHelper

java.lang.Object

com.phoenixnap.oss.ramlapisync.naming.NamingHelper

public class NamingHelper
extends Object

Class containing methods relating to naming converntions and string cleanup for naming

Since:

0.0.1

Author:

Kurt Paris

Constructor Summary

Constructors

Constructor and Description
NamingHelper()

Method Summary

Modifier and Type	Method and Description
static String	cleanForJavadoc(String input) Utility method to clean a string for use within javadoc
static String	cleanLeadingAndTrailingNewLineAndChars(String input) Utility method to clean New Line,Spaces and other highly useless characters found (mainly in javadoc)
static String	convertClassName(Class<?> clazz) Convert a class name into its restful Resource representation.
static String	convertContentTypeToQualifier(String contentType) Converts an http contentType into a qualifier that can be used within a Java method
static String	getActionName(RamlResource controllerizedResource, RamlResource resource, RamlAction action, RamlActionType actionType) Attempts to infer the name of an action (intent) from a resource's relative URL and action details
static String	getDefaultModelPackage() Returns the default sub package that will be used for model objects used in the Request/Response body
static String	getParameterName(String name) Converts the name of a parameter into a name suitable for a Java parameter
static String	getResourceName(RamlResource resource, boolean singularize) Attempts to infer the name of a resource from a resources's relative URL
static String	getResourceName(String resource, boolean singularize) Attempts to infer the name of a resource from a resources's relative URL
static boolean	isUriParamResource(String resource) Checks if a Resource URI fragment is a URI Parameter.
static boolean	isValidJavaClassName(String input) Utility method to check if a string can be used as a valid class name
static String	resolveProperties(String inputString) Attempts to load system propertes from the string or use included defaults if available

Methods inherited from class java.lang.Object

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

Constructor Detail

NamingHelper

public NamingHelper()

Method Detail

convertContentTypeToQualifier

public static String convertContentTypeToQualifier(String contentType)

Converts an http contentType into a qualifier that can be used within a Java method

Parameters:

contentType - The content type to convert application/json

Returns:

qualifier, example V1Html

isUriParamResource

public static boolean isUriParamResource(String resource)

Checks if a Resource URI fragment is a URI Parameter. URI parameters are defined as {myParameter}

Parameters:

resource - The Resource key/ relative URL

Returns:

If true this URI is a frament containing a URI parameter

isValidJavaClassName

public static boolean isValidJavaClassName(String input)

Utility method to check if a string can be used as a valid class name

Parameters:

input - String to check

Returns:

true if valid

cleanForJavadoc

public static String cleanForJavadoc(String input)

Utility method to clean a string for use within javadoc

Parameters:

input - String to be cleaned

Returns:

The cleaned string

cleanLeadingAndTrailingNewLineAndChars

public static String cleanLeadingAndTrailingNewLineAndChars(String input)

Utility method to clean New Line,Spaces and other highly useless characters found (mainly in javadoc)

Parameters:

input - The string to be cleaned

Returns:

Cleaned String

convertClassName

public static String convertClassName(Class<?> clazz)

Convert a class name into its restful Resource representation. eg. MonitorServiceImpl becomes Monitor

Parameters:

clazz - The Class to name

Returns:

The name for this class

resolveProperties

public static String resolveProperties(String inputString)

Attempts to load system propertes from the string or use included defaults if available

Parameters:

inputString - Strign containing spring property format

Returns:

resolved String

getResourceName

public static String getResourceName(RamlResource resource,
                                     boolean singularize)

Attempts to infer the name of a resource from a resources's relative URL

Parameters:

resource - The raml resource being parsed

singularize - indicates if the resource name should be singularized or not

Returns:

A name representing this resource or null if one cannot be inferred

getResourceName

public static String getResourceName(String resource,
                                     boolean singularize)

Attempts to infer the name of a resource from a resources's relative URL

Parameters:

resource - The Url representation of this object

singularize - indicates if the resource name should be singularized or not

Returns:

A name representing this resource or null if one cannot be inferred

getParameterName

public static String getParameterName(String name)

Converts the name of a parameter into a name suitable for a Java parameter

Parameters:

name - The name of a RAML query parameter or request header

Returns:

A name suitable for a Java parameter

getActionName

public static String getActionName(RamlResource controllerizedResource,
                                   RamlResource resource,
                                   RamlAction action,
                                   RamlActionType actionType)

Attempts to infer the name of an action (intent) from a resource's relative URL and action details

Parameters:

controllerizedResource - The resource that is mapped to the root controller

resource - The child resource that will be mapped as a method of the root controller

action - The RAML action object

actionType - The ActionType/HTTP Verb for this Action

Returns:

The java name of the method that will represent this Action

getDefaultModelPackage

public static String getDefaultModelPackage()

Returns the default sub package that will be used for model objects used in the Request/Response body

Returns:

the package suffix to be appended.