org.mule.runtime.extension.api.introspection.property

Class DisplayModelProperty

java.lang.Object

org.mule.runtime.extension.api.introspection.property.DisplayModelProperty

All Implemented Interfaces:

Serializable, ModelProperty, Named

public class DisplayModelProperty
extends Object
implements ModelProperty

Immutable ModelProperty which provides a friendly display name and summary for any EnrichableModel.

Since:

1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DisplayModelProperty(String displayName, String summary) Instantiates a new DisplayModelProperty

Method Summary

Modifier and Type	Method and Description
Optional<String>	getDisplayName()
String	getName() A unique name which identifies this property.
Optional<String>	getSummary()
boolean	isExternalizable() Whether this instance should be included when serializing or sharing the owning EnrichableModel or if on the contrary, this model property holds information which is proprietary to the runtime and should not communicated.

Methods inherited from class java.lang.Object

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

Constructor Detail

DisplayModelProperty

public DisplayModelProperty(String displayName,
                            String summary)

Instantiates a new DisplayModelProperty

Parameters:

displayName - nullable model display name

summary - nullable model summary

Method Detail

getName

public String getName()

A unique name which identifies this property. No model should contain two instances with the same name

Specified by:

getName in interface ModelProperty

Specified by:

getName in interface Named

Returns:

displayModelProperty

isExternalizable

public boolean isExternalizable()

Whether this instance should be included when serializing or sharing the owning EnrichableModel or if on the contrary, this model property holds information which is proprietary to the runtime and should not communicated.

Non externalizable properties should be skipped by serializers and any other kind of sharing mechanisms.

Specified by:

isExternalizable in interface ModelProperty

Returns:

true

getDisplayName

public Optional<String> getDisplayName()

Returns:

the optional display name of the enriched EnrichableModel

getSummary

public Optional<String> getSummary()

Returns:

the optional summary of the enriched EnrichableModel