org.mule.metadata.message.api

Interface MessageMetadataType

All Superinterfaces:

MetadataType, ObjectType

public interface MessageMetadataType
extends ObjectType

Models a Message Type with its payload and attributes.

Since:

1.0

See Also:

MuleEventMetadataType

Method Summary

Modifier and Type	Method and Description
static MessageMetadataTypeBuilder	builder()
static MessageMetadataTypeBuilder	builder(ObjectType messageType) Creates a builder for the MessageMetadataType based on the specified message
<T extends TypeAnnotation> Optional<T>	getAttributesAnnotation(Class<T> annotation) The attributes annotations of provided annotation class
Optional<Set<TypeAnnotation>>	getAttributesAnnotations() The attributes annotations
Optional<MetadataType>	getAttributesType() The attributes metadata type
<T extends TypeAnnotation> Optional<T>	getPayloadAnnotation(Class<T> annotation) The payload annotations of provided annotation class
Optional<Set<TypeAnnotation>>	getPayloadAnnotations() The payload annotations
Optional<MetadataType>	getPayloadType() The payload metadata types

Methods inherited from interface org.mule.metadata.api.model.ObjectType

getFieldByName, getFields, getOpenRestriction, isOpen, isOrdered

Methods inherited from interface org.mule.metadata.api.model.MetadataType

accept, getAnnotation, getAnnotations, getDescription, getMetadataFormat

Method Detail

builder

static MessageMetadataTypeBuilder builder()

getPayloadType

Optional<MetadataType> getPayloadType()

The payload metadata types

Returns:

The payload type

getPayloadAnnotations

Optional<Set<TypeAnnotation>> getPayloadAnnotations()

The payload annotations

Returns:

The set of payload annotations

getPayloadAnnotation

<T extends TypeAnnotation> Optional<T> getPayloadAnnotation(Class<T> annotation)

The payload annotations of provided annotation class

Parameters:

annotation - class

Returns:

optional annotation

getAttributesType

Optional<MetadataType> getAttributesType()

The attributes metadata type

Returns:

The attribute type

getAttributesAnnotations

Optional<Set<TypeAnnotation>> getAttributesAnnotations()

The attributes annotations

Returns:

The set of attributes annotations

getAttributesAnnotation

<T extends TypeAnnotation> Optional<T> getAttributesAnnotation(Class<T> annotation)

The attributes annotations of provided annotation class

Parameters:

annotation - class

Returns:

optional annotation

builder

static MessageMetadataTypeBuilder builder(ObjectType messageType)

Creates a builder for the MessageMetadataType based on the specified message

Parameters:

messageType - The message type to build builder from.

Returns:

The builder