io.micronaut.core.attr

Interface MutableAttributeHolder

All Superinterfaces:

AttributeHolder

All Known Subinterfaces:

HttpMessage<B>, HttpRequest<B>, HttpResponse<B>, InvocationContext<T,R>, MethodInvocationContext<T,R>, MutableHttpMessage<B>, MutableHttpRequest<B>, MutableHttpResponse<B>

All Known Implementing Classes:

AbstractNettyHttpRequest, FullHttpRequest, FullNettyClientHttpResponse, HttpMessageWrapper, HttpRequestWrapper, HttpResponseWrapper, InterceptorChain, MethodInterceptorChain, NettyHttpRequest, NettyMutableHttpResponse, SimpleHttpRequest

public interface MutableAttributeHolder
extends AttributeHolder

An interface for types that support mutating attributes.

Since:

1.0

Author:

graemerocher

Method Summary

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

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

getAttribute, getAttribute

Method Detail

getAttributes

@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 MutableAttributeHolder setAttribute(@Nonnull
                                                     CharSequence name,
                                                     @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> Optional<T> removeAttribute(@Nonnull
                                                 CharSequence name,
                                                 @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