org.mule.devkit.model.apidoc

Class AbstractElement

java.lang.Object

org.mule.devkit.model.apidoc.AbstractElement

All Implemented Interfaces:

Element

Direct Known Subclasses:

Config, ModuleModel, Operation, Variable

public abstract class AbstractElement
extends Object
implements Element

Represents an element in the DevKit model, This includes Configurable Fields, Configs, all the Operation Types and Modules and Connectors itself

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description The description of the element.
protected String	friendlyName Some elements have a friendlyName attribute or are annotated with the FriendlyName annotation.
protected String	javaName The element name in the code itself
protected String	xsdName The element xsd name .

Constructor Summary

Constructors

Constructor and Description
AbstractElement()

Method Summary

Modifier and Type	Method and Description
String	description()
void	description(String description)
String	friendlyName()
void	friendlyName(String friendlyName)
String	javaName()
void	javaName(String javaName)
protected String	setEmptyForNull(String value)
String	xsdName()
void	xsdName(String xsdName)

Methods inherited from class java.lang.Object

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

Field Detail

javaName

protected String javaName

The element name in the code itself

friendlyName

protected String friendlyName

Some elements have a friendlyName attribute or are annotated with the FriendlyName annotation. If none a friendlyName is generated from the javaName

description

protected String description

The description of the element. is taken from the associated element javadoc

xsdName

protected String xsdName

The element xsd name . is taken from the name attribute, or auto-generated if not specified

Constructor Detail

AbstractElement

public AbstractElement()

Method Detail

description

public String description()

Specified by:

description in interface Element

friendlyName

public String friendlyName()

Specified by:

friendlyName in interface Element

javaName

public String javaName()

Specified by:

javaName in interface Element

xsdName

public String xsdName()

Specified by:

xsdName in interface Element

description

public void description(String description)

Specified by:

description in interface Element

friendlyName

public void friendlyName(String friendlyName)

Specified by:

friendlyName in interface Element

javaName

public void javaName(String javaName)

Specified by:

javaName in interface Element

xsdName

public void xsdName(String xsdName)

Specified by:

xsdName in interface Element

setEmptyForNull

protected String setEmptyForNull(String value)