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

Class DisplayModel

java.lang.Object

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

public final class DisplayModel
extends Object

A model which provides directives about how the model should be shown in the user interface.

Instances are to be created through a builder

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DisplayModel.DisplayModelBuilder A Builder which allows creating instances of DisplayModel

Method Summary

Modifier and Type	Method and Description
static DisplayModel.DisplayModelBuilder	builder()
boolean	equals(Object obj)
String	getDisplayName()
String	getExample()
Optional<PathModel>	getPathModel()
String	getSummary()
int	hashCode()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static DisplayModel.DisplayModelBuilder builder()

Returns:

a new DisplayModel.DisplayModelBuilder

getDisplayName

public String getDisplayName()

Returns:

The name which should be use to show this model

getSummary

public String getSummary()

Returns:

A very brief overview about this model

getExample

public String getExample()

Returns:

An example of the content that should be used

getPathModel

public Optional<PathModel> getPathModel()

Returns:

an Optional with a PathModel if the parameter is a Path to a file or directory,\ an Optional.empty() if its not.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object