Interface ContentDescriptor
- All Known Subinterfaces:
ContentBody
- All Known Implementing Classes:
AbstractContentBody
,ByteArrayBody
,FileBody
,InputStreamBody
,StringBody
public interface ContentDescriptor
Represents common content properties.
-
Method Summary
Modifier and TypeMethodDescriptionThe body descriptors character set, defaulted appropriately for the MIME type.long
Returns the body descriptors content-length.Gets the defaulted MIME media type for this content.Returns the body descriptors MIME type.Gets the defaulted MIME sub type for this content.Returns the body descriptors transfer encoding.
-
Method Details
-
getMimeType
String getMimeType()Returns the body descriptors MIME type.- Returns:
- The MIME type, which has been parsed from the content-type definition. Must not be null, but "text/plain", if no content-type was specified.
- See Also:
-
getMediaType
String getMediaType()Gets the defaulted MIME media type for this content. For exampleTEXT
,IMAGE
,MULTIPART
- Returns:
- the MIME media type when content-type specified,
otherwise the correct default (
TEXT
) - See Also:
-
getSubType
String getSubType()Gets the defaulted MIME sub type for this content.- Returns:
- the MIME media type when content-type is specified,
otherwise the correct default (
PLAIN
) - See Also:
-
getCharset
String getCharset()The body descriptors character set, defaulted appropriately for the MIME type.
For
TEXT
types, this will be defaulted tous-ascii
. For other types, when the charset parameter is missing this property will be null.- Returns:
- Character set, which has been parsed from the
content-type definition. Not null for
TEXT
types, when unset will be set to defaultus-ascii
. For other types, when unset, null will be returned.
-
getTransferEncoding
String getTransferEncoding()Returns the body descriptors transfer encoding.- Returns:
- The transfer encoding. Must not be null, but "7bit", if no transfer-encoding was specified.
-
getContentLength
long getContentLength()Returns the body descriptors content-length.- Returns:
- Content length, if known, or -1, to indicate the absence of a content-length header.
-