org.springframework.boot.actuate.endpoint.annotation

Interface Producible<E extends Enum<E> & Producible<E>>

Type Parameters:

E - enum type that implements this interface

All Known Implementing Classes:

ApiVersion, TextOutputFormat

public interface Producible<E extends Enum<E> & Producible<E>>

Interface that can be implemented by any Enum that represents a finite set of producible mime-types.

Can be used with @ReadOperation, @ReadOperation and @ReadOperation annotations to quickly define a list of produces values.

Producible types can also be injected into operations when the underlying technology supports content negotiation. For example, with web based endpoints, the value of the Producible enum is resolved using the Accept header of the request. When multiple values are equally acceptable, the value with the highest ordinal is used.

Since:

2.5.0

Author:

Andy Wilkinson

Method Summary

Modifier and Type	Method and Description
MimeType	getProducedMimeType() Mime type that can be produced.

Method Detail

getProducedMimeType

MimeType getProducedMimeType()

Mime type that can be produced.

Returns:

the producible mime type