org.mule.runtime.extension.api.model

Class AbstractNamedImmutableModel

java.lang.Object

org.mule.runtime.extension.api.model.AbstractImmutableModel

org.mule.runtime.extension.api.model.AbstractNamedImmutableModel

All Implemented Interfaces:

DescribedObject, HasDisplayModel, EnrichableModel, NamedObject

Direct Known Subclasses:

AbstractComplexModel, AbstractParameterizedModel, ImmutableNestedComponentModel, ImmutableParameterGroupModel, ImmutableParameterModel

public abstract class AbstractNamedImmutableModel
extends AbstractImmutableModel
implements NamedObject, HasDisplayModel

Base class for immutable implementations of NamedObject introspection models

Since:

1.0

Field Summary

Fields inherited from class org.mule.runtime.extension.api.model.AbstractImmutableModel

description, modelProperties

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractNamedImmutableModel(String name, String description, DisplayModel displayModel, Set<ModelProperty> modelProperties) Creates a new instance

Method Summary

Modifier and Type	Method and Description
protected static void	checkArgument(boolean condition, String message)
boolean	equals(Object obj) Defines object equality based on the given object being an object of this class and in the equality of the getName() attributes
Optional<DisplayModel>	getDisplayModel()
String	getName() Gets the name of the object
int	hashCode() Calculates hashcode based on getName()
String	toString()

Methods inherited from class org.mule.runtime.extension.api.model.AbstractImmutableModel

copy, copy, getDescription, getModelProperties, getModelProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractNamedImmutableModel

protected AbstractNamedImmutableModel(String name,
                                      String description,
                                      DisplayModel displayModel,
                                      Set<ModelProperty> modelProperties)

Creates a new instance

Parameters:

name - the model's name

description - the model's description

displayModel - a model containing directives about how this component is to be displayed in the UI

modelProperties - A Set of custom properties which extend this model

Throws:

IllegalArgumentException - if name is blank

Method Detail

checkArgument

protected static void checkArgument(boolean condition,
                                    String message)

getName

public final String getName()

Gets the name of the object

Specified by:

getName in interface NamedObject

Returns:

the name of the object

getDisplayModel

public Optional<DisplayModel> getDisplayModel()

Specified by:

getDisplayModel in interface HasDisplayModel

Returns:

An Optional DisplayModel which contains directives about how this model should be displayed in the UI

equals

public boolean equals(Object obj)

Defines object equality based on the given object being an object of this class and in the equality of the getName() attributes

Overrides:

equals in class Object

Parameters:

obj - an object

Returns:

true if equal

hashCode

public int hashCode()

Calculates hashcode based on getName()

Overrides:

hashCode in class Object

Returns:

a hash code

toString

public String toString()

Overrides:

toString in class AbstractImmutableModel