org.mule.runtime.api.meta.model.display

Class DisplayModel.DisplayModelBuilder

java.lang.Object

org.mule.runtime.api.meta.model.display.DisplayModel.DisplayModelBuilder

Enclosing class:

DisplayModel

public static final class DisplayModel.DisplayModelBuilder
extends Object

A Builder which allows creating instances of DisplayModel

Method Summary

Modifier and Type	Method and Description
DisplayModel	build()
DisplayModel.DisplayModelBuilder	classValue(ClassValueModel classValueModel) A ClassValueModel with metadata for a parameter which references a class
DisplayModel.DisplayModelBuilder	displayName(String displayName) Sets the name which should be use to show this model
DisplayModel.DisplayModelBuilder	example(String example) An example about the content of this model
DisplayModel.DisplayModelBuilder	path(PathModel pathModel) A PathModel with metadata for a parameter that points to file or directory.
DisplayModel.DisplayModelBuilder	summary(String summary) A very brief overview about this model

Methods inherited from class java.lang.Object

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

Method Detail

displayName

public DisplayModel.DisplayModelBuilder displayName(String displayName)

Sets the name which should be use to show this model

Parameters:

displayName - a display name

Returns:

this builder

summary

public DisplayModel.DisplayModelBuilder summary(String summary)

A very brief overview about this model

Parameters:

summary - a summary

Returns:

this builder

example

public DisplayModel.DisplayModelBuilder example(String example)

An example about the content of this model

Parameters:

example - an example

Returns:

this builder

path

public DisplayModel.DisplayModelBuilder path(PathModel pathModel)

A PathModel with metadata for a parameter that points to file or directory.

Parameters:

pathModel - a PathModel with the metadata associated to the path param.

Returns:

this builder

classValue

public DisplayModel.DisplayModelBuilder classValue(ClassValueModel classValueModel)

A ClassValueModel with metadata for a parameter which references a class

Parameters:

classValueModel - a ClassValueModel with the metadata associated to the class param

Returns:

this builder

build

public DisplayModel build()

Returns:

the built DisplayModel