Package org.refcodes.net

Interface ContentType

All Superinterfaces:

org.refcodes.structure.CanonicalMap, org.refcodes.structure.CanonicalMap.CanonicalMapBuilder, org.refcodes.structure.CanonicalMap.MutableCanonicalMap, org.refcodes.structure.Clearable, org.refcodes.structure.Containable, org.refcodes.mixin.DelimiterAccessor, org.refcodes.structure.Dictionary<String,String>, org.refcodes.structure.Dictionary.MutableDictionary<String,String>, org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<String,String,org.refcodes.structure.PathMap.PathMapBuilder<String>>, org.refcodes.mixin.Dumpable, HttpMediaType, HttpMediaTypeAccessor.HttpMediaTypeProvider<RuntimeException>, org.refcodes.structure.Keys<String,String>, org.refcodes.structure.Keys.MutableKeys<String,String>, org.refcodes.structure.Keys.MutableValues<String,String>, Map<String,String>, MediaTypeAccessor, org.refcodes.structure.PathMap<String>, org.refcodes.structure.PathMap.MutablePathMap<String>, org.refcodes.structure.PathMap.PathMapBuilder<String>, org.refcodes.configuration.Properties, org.refcodes.configuration.Properties.MutableProperties, org.refcodes.configuration.Properties.PropertiesBuilder, org.refcodes.structure.PropertiesAccessorMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder>, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin, TopLevelTypeAccessor, org.refcodes.mixin.TypeAccessor<String>

All Known Implementing Classes:

ContentTypeImpl

public interface ContentType
extends TopLevelTypeAccessor, MediaTypeAccessor, org.refcodes.configuration.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.structure.CanonicalMap

org.refcodes.structure.CanonicalMap.CanonicalMapBuilder, org.refcodes.structure.CanonicalMap.MutableCanonicalMap

Nested classes/interfaces inherited from interface org.refcodes.mixin.DelimiterAccessor

org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B extends org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B>>, org.refcodes.mixin.DelimiterAccessor.DelimiterMutator, org.refcodes.mixin.DelimiterAccessor.DelimiterProperty

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

org.refcodes.structure.Dictionary.MutableDictionary<K extends Object,V extends Object>

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

org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<K extends Object,V extends Object,B extends org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<K,V,B>>

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.structure.PathMap

org.refcodes.structure.PathMap.MutablePathMap<T extends Object>, org.refcodes.structure.PathMap.PathMapBuilder<T extends Object>

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

org.refcodes.configuration.Properties.MutableProperties, org.refcodes.configuration.Properties.PropertiesBuilder

Nested classes/interfaces inherited from interface org.refcodes.structure.PropertiesAccessorMixin

org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<T extends Object>, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin

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.mixin.TypeAccessor

org.refcodes.mixin.TypeAccessor.TypeMutator<T extends Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends Object>

Field Summary

Fields inherited from interface org.refcodes.configuration.Properties

DEFAULT_COMMENT

Method Summary

Modifier and Type	Method	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)	Put.
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 Keys.get(Object), mutable via Keys.MutableValues.put(Object, Object)) 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(String aKey, String aValue)
default ContentType	withPut(MediaTypeParameter aParameter, String aValue)	With put.
default ContentType	withPut(org.refcodes.structure.Relation<String,String> aProperty)

Methods inherited from interface org.refcodes.structure.CanonicalMap

toInstance, toInstance, toType, toType

Methods inherited from interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

withInsert, withInsert, withInsertFrom, withInsertTo

Methods inherited from interface org.refcodes.structure.CanonicalMap.MutableCanonicalMap

insert, insert, insertFrom, insertTo, putAll, toDump, toSourceCode, toSourceCode

Methods inherited from interface org.refcodes.structure.Clearable

clear

Methods inherited from interface org.refcodes.structure.Containable

isEmpty, size

Methods inherited from interface org.refcodes.mixin.Dumpable

toDump

Methods inherited from interface org.refcodes.structure.Keys.MutableValues

put

Methods inherited from interface org.refcodes.net.MediaTypeAccessor

getMediaType

Methods inherited from interface org.refcodes.structure.PathMap

directories, directories, entries, entries, fromExternalKey, getArray, getArray, getRootPath, hasParentPath, isArray, isArray, isDirectory, isEntry, isRecord, isRootPath, keySet, paths, paths, records, records, toDataStructure, toDataStructure, toExternalKey, toMap, toNormalizedPath, toNormalizedPath, toParentPath, toPath

Methods inherited from interface org.refcodes.structure.PathMap.MutablePathMap

insert, insert, insert, insert, insertFrom, insertFrom, insertTo, insertTo, put, putArray, putArray, removeAll

Methods inherited from interface org.refcodes.structure.PathMap.PathMapBuilder

withInsert, withInsert, withInsertFrom, withInsertTo

Methods inherited from interface org.refcodes.configuration.Properties

getDelimiter, getType, toMap, toProperties, toPropertyPath

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

containsValue, delete, delete, insert, insert, insertFrom, insertTo, put, putAll, putAll, putAll

Methods inherited from interface org.refcodes.configuration.Properties.PropertiesBuilder

childrenOf, retrieve, retrieveFrom, retrieveTo, withInsert, withInsert, withInsert, withInsert, withInsertFrom, withInsertFrom, withInsertTo, withInsertTo, withPutBoolean, withPutByte, withPutDouble, withPutFloat, withPutInteger, withPutLong, withPutShort, withRemoveFrom

Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin

containsKey, get, getBoolean, getBoolean, getByte, getByte, getCharacter, getCharacter, getDouble, getDouble, getFloat, getFloat, getInteger, getInteger, getLong, getLong, getShort, getShort, use, useBoolean, useBoolean, useByte, useByte, useDouble, useDouble, useFloat, useFloat, useInteger, useInteger, useLong, useLong, useShort, useShort

Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin

withPut

Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin

put, put, putBoolean, putBoolean, putByte, putByte, putDouble, putDouble, putFloat, putFloat, putInteger, putInteger, putLong, putLong, putShort, putShort

Method Detail

getTopLevelType

default TopLevelType getTopLevelType()

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.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withPut in interface org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<String,String,org.refcodes.structure.PathMap.PathMapBuilder<String>>

Specified by:

withPut in interface org.refcodes.structure.PathMap.PathMapBuilder<String>

Specified by:

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

Specified by:

withPut in interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder>

withPut

default ContentType withPut(org.refcodes.structure.Relation<String,String> aProperty)

Specified by:

withPut in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withPut in interface org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<String,String,org.refcodes.structure.PathMap.PathMapBuilder<String>>

Specified by:

withPut in interface org.refcodes.structure.PathMap.PathMapBuilder<String>

Specified by:

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

put

default String put(MediaTypeParameter aParameter,
                   String aValue)

Put.

Parameters:

aParameter - the parameter

aValue - the value

Returns:

the string

withPut

default ContentType withPut(MediaTypeParameter aParameter,
                            String aValue)

With put.

Parameters:

aParameter - the aarameter

aValue - the value

Returns:

the content type

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:

aValue - the value

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 Keys.get(Object), mutable via Keys.MutableValues.put(Object, Object)) 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.