org.mule.extension.maven.documentation

Class NameUtils

java.lang.Object

org.mule.extension.maven.documentation.NameUtils

public class NameUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
NameUtils()

Method Summary

Modifier and Type	Method and Description
static Optional<String>	getDescription(org.mule.runtime.api.meta.model.display.HasDisplayModel model, org.mule.runtime.api.meta.DescribedObject describedObject)
static String	normalize(String name) Idempotent method that normalizes names to avoid invalid AsciiDoctor ids.
static String	prettify(org.mule.runtime.api.meta.NamedObject component)
static String	prettify(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

NameUtils

public NameUtils()

Method Detail

prettify

public static String prettify(org.mule.runtime.api.meta.NamedObject component)

prettify

public static String prettify(String name)

getDescription

public static Optional<String> getDescription(org.mule.runtime.api.meta.model.display.HasDisplayModel model,
                                              org.mule.runtime.api.meta.DescribedObject describedObject)

normalize

public static String normalize(String name)

Idempotent method that normalizes names to avoid invalid AsciiDoctor ids. Normalization consist on generating an UpperCamelCase name without spaces or hyphens (underscores remains untouched)

Parameters:

name - name to be normalized

Returns:

the normalized name