Package io.micronaut.core.attr

Interface MutableAttributeHolder

All Superinterfaces:

AttributeHolder

public interface MutableAttributeHolder
extends AttributeHolder

An interface for types that support mutating attributes.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
@NonNull MutableConvertibleValues<Object>	getAttributes()	Overrides the default AttributeHolder.getAttributes() method to return a mutable object.
default <T> @NonNull Optional<T>	removeAttribute(@NonNull CharSequence name, @NonNull Class<T> type)	Remove an attribute.
default @NonNull MutableAttributeHolder	setAttribute(@NonNull CharSequence name, @Nullable Object value)	Sets an attribute on the message.

Methods inherited from interface io.micronaut.core.attr.AttributeHolder

getAttribute, getAttribute

Method Details

getAttributes

@NonNull
@NonNull MutableConvertibleValues<Object> getAttributes()

Overrides the default AttributeHolder.getAttributes() method to return a mutable object.

Specified by:

getAttributes in interface AttributeHolder

Returns:

The mutable attributes

setAttribute

@NonNull
default @NonNull MutableAttributeHolder setAttribute(@NonNull
 @NonNull CharSequence name,
 @Nullable
 @Nullable Object value)

Sets an attribute on the message.

Parameters:

name - The name of the attribute

value - The value of the attribute

Returns:

This message

removeAttribute

@NonNull
default <T> @NonNull Optional<T> removeAttribute(@NonNull
 @NonNull CharSequence name,
 @NonNull
 @NonNull Class<T> type)

Remove an attribute. Returning the old value if it is present.

Type Parameters:

T - type Generic

Parameters:

name - The name of the attribute

type - The required type

Returns:

An Optional value