org.refcodes.net

Interface ContentType

All Superinterfaces:

org.refcodes.collection.Clearable, org.refcodes.collection.Containable, org.refcodes.collection.Dictionary<String,String>, org.refcodes.collection.Dictionary.ClearableDictionary<String,String>, org.refcodes.collection.Dictionary.MutableDictionary<String,String>, org.refcodes.collection.Dictionary.MutableDictionary.DictionaryBuilder<String,String,org.refcodes.structure.Property,org.refcodes.collection.Properties.PropertiesBuilder>, HttpMediaType, HttpMediaTypeAccessor.HttpMediaTypeProvider<RuntimeException>, org.refcodes.collection.Keys<String,String>, org.refcodes.collection.Keys.ClearableKeys<String,String>, org.refcodes.collection.Keys.MutableKeys<String,String>, MediaTypeAccessor, org.refcodes.collection.Properties, org.refcodes.collection.Properties.ClearableProperties, org.refcodes.collection.Properties.MutableProperties, org.refcodes.collection.Properties.PropertiesBuilder, TopLevelTypeAccessor

All Known Implementing Classes:

ContentTypeImpl

public interface ContentType
extends TopLevelTypeAccessor, MediaTypeAccessor, org.refcodes.collection.Properties.PropertiesBuilder, HttpMediaType

A ContentType represents a MediaType and its according TopLevelType with additional (optional) suffixed parameters (as of the according HTTP header fields). In other words, it is a concrete occurrence of a MediaType in an HTTP header including the particular parameters. A ContentType with the particular parameters may look as follows: "application/json;charset=UTF-8" in case of MediaType.APPLICATION_JSON and the parameter' MediaTypeParameter.CHARSET name set to the Encoding.UTF_8 code.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.net.TopLevelTypeAccessor

TopLevelTypeAccessor.TopLevelTypeBuilder<B extends TopLevelTypeAccessor.TopLevelTypeBuilder<B>>, TopLevelTypeAccessor.TopLevelTypeMutator, TopLevelTypeAccessor.TopLevelTypeProperty

Nested classes/interfaces inherited from interface org.refcodes.net.MediaTypeAccessor

MediaTypeAccessor.MediaTypeBuilder<B extends MediaTypeAccessor.MediaTypeBuilder<B>>, MediaTypeAccessor.MediaTypeMutator, MediaTypeAccessor.MediaTypeProperty

Nested classes/interfaces inherited from interface org.refcodes.collection.Properties

org.refcodes.collection.Properties.ClearableProperties, org.refcodes.collection.Properties.MutableProperties, org.refcodes.collection.Properties.PropertiesBuilder

Nested classes/interfaces inherited from interface org.refcodes.collection.Dictionary.MutableDictionary

org.refcodes.collection.Dictionary.MutableDictionary.DictionaryBuilder<K,V,T extends org.refcodes.structure.Relation<K,V>,B extends org.refcodes.collection.Dictionary.MutableDictionary.DictionaryBuilder<K,V,T,B>>

Nested classes/interfaces inherited from interface org.refcodes.collection.Dictionary

org.refcodes.collection.Dictionary.ClearableDictionary<K,V>, org.refcodes.collection.Dictionary.MutableDictionary<K,V>

Nested classes/interfaces inherited from interface org.refcodes.collection.Keys

org.refcodes.collection.Keys.ClearableKeys<K,V>, org.refcodes.collection.Keys.MutableKeys<K,V>

Method Summary

Modifier and Type	Method and Description
default String	getCharsetParametrer() Retrieves the charset parameter from the properties of this ContentType instance.
default TopLevelType	getTopLevelType() Retrieves the Media-Top-Level-Type from the Media-Top-Level-Type property.
default String	put(MediaTypeParameter aParameter, String aValue)
default String	putCharsetParametrer(String aCharsetCode) Sets the charset parameter's charset-code.
default String	toHttpMediaType() Returns the HTTP media type: It consists of the Media-Top-Level-Type ( getTopLevelType() and the Media-Subtype ( MediaTypeAccessor.getMediaType()) as well as some (optional) suffixed parameters (as of Keys.keySet() and #get(String), mutable via #put(String, String)) all being concatenated in an HTTP valid manner, such as: "application/json;charset=UTF-8".
default ContentType	withCharsetParametrer(String aValue) Sets the charset parameter's charset-code.
default ContentType	withPut(MediaTypeParameter aParameter, String aValue)
default ContentType	withPut(org.refcodes.structure.Property aProperty)
default ContentType	withPut(String aKey, String aValue)

Methods inherited from interface org.refcodes.net.MediaTypeAccessor

getMediaType

Methods inherited from interface org.refcodes.collection.Properties.MutableProperties

put, putAll, putAll, putAll

Methods inherited from interface org.refcodes.collection.Properties

toMap, toProperties

Methods inherited from interface org.refcodes.collection.Dictionary.MutableDictionary

put, put

Methods inherited from interface org.refcodes.collection.Containable

isEmpty, size

Methods inherited from interface org.refcodes.collection.Keys

containsKey, get, keySet, values

Methods inherited from interface org.refcodes.collection.Clearable

clear

Methods inherited from interface org.refcodes.collection.Keys.MutableKeys

removeKey

Method Detail

getTopLevelType

default TopLevelType getTopLevelType()

Description copied from interface: TopLevelTypeAccessor

Retrieves the Media-Top-Level-Type from the Media-Top-Level-Type property.

Specified by:

getTopLevelType in interface TopLevelTypeAccessor

Returns:

The Media-Top-Level-Type stored by the Media-Top-Level-Type property.

withPut

default ContentType withPut(String aKey,
                            String aValue)

Specified by:

withPut in interface org.refcodes.collection.Dictionary.MutableDictionary.DictionaryBuilder<String,String,org.refcodes.structure.Property,org.refcodes.collection.Properties.PropertiesBuilder>

Specified by:

withPut in interface org.refcodes.collection.Properties.PropertiesBuilder

withPut

default ContentType withPut(org.refcodes.structure.Property aProperty)

Specified by:

withPut in interface org.refcodes.collection.Dictionary.MutableDictionary.DictionaryBuilder<String,String,org.refcodes.structure.Property,org.refcodes.collection.Properties.PropertiesBuilder>

Specified by:

withPut in interface org.refcodes.collection.Properties.PropertiesBuilder

put

default String put(MediaTypeParameter aParameter,
                   String aValue)

withPut

default ContentType withPut(MediaTypeParameter aParameter,
                            String aValue)

getCharsetParametrer

default String getCharsetParametrer()

Retrieves the charset parameter from the properties of this ContentType instance.

Returns:

The charset parameter or null if none is found.

putCharsetParametrer

default String putCharsetParametrer(String aCharsetCode)

Sets the charset parameter's charset-code.

Parameters:

aCharsetCode - The code of the charset to be set (e.g. "UTF-8"), see Encoding for some common codes.

Returns:

The charset parameter's charset-code (if previously been set) or null if none was set before.

withCharsetParametrer

default ContentType withCharsetParametrer(String aValue)

Sets the charset parameter's charset-code.

Parameters:

aCharsetCode - The code of the charset to be set (e.g. "UTF-8"), see Encoding for some common codes.

Returns:

This ContentType instance as of the builder pattern.

toHttpMediaType

default String toHttpMediaType()

Returns the HTTP media type: It consists of the Media-Top-Level-Type ( getTopLevelType() and the Media-Subtype ( MediaTypeAccessor.getMediaType()) as well as some (optional) suffixed parameters (as of Keys.keySet() and #get(String), mutable via #put(String, String)) all being concatenated in an HTTP valid manner, such as: "application/json;charset=UTF-8".

Specified by:

toHttpMediaType in interface HttpMediaType

Specified by:

toHttpMediaType in interface HttpMediaTypeAccessor.HttpMediaTypeProvider<RuntimeException>

Returns:

The HTTP header Media-Type as of the IANA specification.