Module org.mule.runtime.extensions.api

Package org.mule.runtime.extension.api.declaration.type.annotation

Class DisplayTypeAnnotation

java.lang.Object

org.mule.runtime.extension.api.declaration.type.annotation.DisplayTypeAnnotation

All Implemented Interfaces:

org.mule.metadata.api.annotation.TypeAnnotation

public class DisplayTypeAnnotation
extends Object
implements org.mule.metadata.api.annotation.TypeAnnotation

A TypeAnnotation that contains information about the name and summary that should be rendered in the UI for a particular model.

That information is obtained through the DisplayName and Summary annotations.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
DisplayTypeAnnotation(org.mule.runtime.api.meta.model.display.DisplayModel displayModel)	Creates a new instance

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Optional<org.mule.runtime.api.meta.model.display.ClassValueModel>	getClassValueModel()
String	getDisplayName()
String	getExample()
String	getName()
Optional<org.mule.runtime.api.meta.model.display.PathModel>	getPathModel()
String	getSummary()
int	hashCode()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.metadata.api.annotation.TypeAnnotation

isPublic

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

DisplayTypeAnnotation

public DisplayTypeAnnotation(org.mule.runtime.api.meta.model.display.DisplayModel displayModel)

Creates a new instance

Parameters:

displayModel - a DisplayModel

Method Details

getName

public String getName()

Specified by:

getName in interface org.mule.metadata.api.annotation.TypeAnnotation

getDisplayName

public String getDisplayName()

Returns:

the name which should be use to render this model.

getSummary

public String getSummary()

Returns:

a brief overview about this model.

getExample

public String getExample()

Returns:

a brief example about a possible value for this model.

getPathModel

public Optional<org.mule.runtime.api.meta.model.display.PathModel> getPathModel()

Returns:

a PathModel instance if the carrier parameter points to a file or directory, Optional.empty() otherwise.

getClassValueModel

public Optional<org.mule.runtime.api.meta.model.display.ClassValueModel> getClassValueModel()

Returns:

a ClassValueModel instance if the carrier parameter points to a class. Optional.empty() otherwise.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object