Package dev.enola.common.protobuf

Class ProtobufMediaTypes

java.lang.Object

dev.enola.common.protobuf.ProtobufMediaTypes

All Implemented Interfaces:

MediaTypeProvider, ResourceMediaTypeDetector

public class ProtobufMediaTypes
extends Object
implements MediaTypeProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAMETER_PROTO_MESSAGE	MediaType parameter to indicate the resource's root message fully qualified name.
static final MediaType	PROTO_UTF_8
static final MediaType	PROTOBUF_BINARY
static final MediaType	PROTOBUF_JSON_UTF_8	"ProtoBuf as JSON" - which is different from e.g.
static final MediaType	PROTOBUF_TEXTPROTO_UTF_8
static final MediaType	PROTOBUF_YAML_UTF_8	"ProtoBuf as YAML" - which is different from e.g.

Constructor Summary

Constructors

Constructor	Description
ProtobufMediaTypes()

Method Summary

Modifier and Type	Method	Description
Multimap<String,MediaType>	extensionsToTypes()	Maps the URI path "extension" (WITH the dot; or not, filenames such as "README" are also permitted!) to its "canonical" Media Types.
static Optional<String>	getProtoMessageFQN(MediaType mediaType)
Map<MediaType,Set<MediaType>>	knownTypesWithAlternatives()	Maps "canonical" (primary) Media Types to a set of its "also known as alternatives".
static MediaType	setProtoMessageFQN(MediaType mediaType, String protoFQN)

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.enola.common.io.mediatype.MediaTypeProvider

detect

Methods inherited from interface dev.enola.common.io.mediatype.ResourceMediaTypeDetector

detect

Field Details

PARAMETER_PROTO_MESSAGE

public static final String PARAMETER_PROTO_MESSAGE

MediaType parameter to indicate the resource's root message fully qualified name. Inspired by https://protobuf.dev/reference/protobuf/textformat-spec/#header.

See Also:

• Constant Field Values

PROTO_UTF_8

public static final MediaType PROTO_UTF_8

PROTOBUF_TEXTPROTO_UTF_8

public static final MediaType PROTOBUF_TEXTPROTO_UTF_8

PROTOBUF_JSON_UTF_8

public static final MediaType PROTOBUF_JSON_UTF_8

"ProtoBuf as JSON" - which is different from e.g. a JSON-LD representation of RDF.

PROTOBUF_YAML_UTF_8

public static final MediaType PROTOBUF_YAML_UTF_8

"ProtoBuf as YAML" - which is different from e.g. a YAML-LD representation of RDF.

PROTOBUF_BINARY

public static final MediaType PROTOBUF_BINARY

Constructor Details

ProtobufMediaTypes

public ProtobufMediaTypes()

Method Details

setProtoMessageFQN

public static MediaType setProtoMessageFQN(MediaType mediaType,
 String protoFQN)

getProtoMessageFQN

public static Optional<String> getProtoMessageFQN(MediaType mediaType)

knownTypesWithAlternatives

public Map<MediaType,Set<MediaType>> knownTypesWithAlternatives()

Description copied from interface: MediaTypeProvider

Maps "canonical" (primary) Media Types to a set of its "also known as alternatives".

Specified by:

knownTypesWithAlternatives in interface MediaTypeProvider

extensionsToTypes

public Multimap<String,MediaType> extensionsToTypes()

Description copied from interface: MediaTypeProvider

Maps the URI path "extension" (WITH the dot; or not, filenames such as "README" are also permitted!) to its "canonical" Media Types. This should only be used for "informational" listing kind of output. To actually determine a MediaType, please use MediaTypeProvider.detect(String, ByteSource, MediaType) instead.

Specified by:

extensionsToTypes in interface MediaTypeProvider