| java.lang.Object com.sun.tck.wma.MessagePart
MessagePart | public class MessagePart (Code) | | Instances of the MessagePart class can be added to a
MultipartMessage . Each MessagePart consists
of the content element, MIME type and content-id. The Content can be of
any type. Additionally, it's possible to specify the content location and
the encoding scheme.
since: WMA 2.0 |
Constructor Summary | |
public | MessagePart(byte[] contents, int offset, int length, java.lang.String mimeType, java.lang.String contentId, java.lang.String contentLocation, java.lang.String enc) Constructs a MessagePart object from a subset of the byte
array. | public | MessagePart(byte[] contents, java.lang.String mimeType, java.lang.String contentId, java.lang.String contentLocation, java.lang.String enc) Construct a MessagePart object from a byte array. | public | MessagePart(java.io.InputStream is, java.lang.String mimeType, java.lang.String contentId, java.lang.String contentLocation, java.lang.String enc) Constructs a MessagePart object from an
InputStream . |
BUFFER_SIZE | final static int BUFFER_SIZE(Code) | | Buffer size 2048.
|
MAX_PART_SIZE_BYTES | static int MAX_PART_SIZE_BYTES(Code) | | Maximum size for message part.
|
US_ASCII_LOWEST_VALID_CHAR | final static char US_ASCII_LOWEST_VALID_CHAR(Code) | | Lowest valid ASCII character.
|
US_ASCII_VALID_BIT_MASK | final static char US_ASCII_VALID_BIT_MASK(Code) | | Mask for ASCII character checks.
|
content | byte[] content(Code) | | Content byte array.
|
contentLocation | String contentLocation(Code) | | Content location.
|
MessagePart | public MessagePart(byte[] contents, int offset, int length, java.lang.String mimeType, java.lang.String contentId, java.lang.String contentLocation, java.lang.String enc) throws SizeExceededException(Code) | | Constructs a MessagePart object from a subset of the byte
array. This constructor is only useful if the data size is small
(roughly less than 10K). For larger content the InputStream
based constructor should be used.
Parameters: contents - byte array containing the contents for theMessagePart . Parameters: offset - start position Parameters: length - the number of bytes to be included in the MessagePart . Parameters: mimeType - the MIME Content-Type for the MessagePart [RFC 2046] Parameters: contentId - the content-id header field value for theMessagePart [RFC 2045]. The content-id is unique over all MessagePart s of a MultipartMessage and must always be set for eachmessage part. Parameters: contentLocation - the content location which specifies thefile name of the file that is attached. If the content location isset to null no content location will be set for thisMessagePart . Parameters: enc - the encoding scheme for the MessagePart .if enc is set to null no encoding willbe used for this MessagePart . throws: java.lang.IllegalArgumentException - if mimeType or contentId isnull . This exception will be thrown ifcontentID or contentLocation containsother characters than specified in US-ASCII format. This exceptionwill be thrown if either length is less than 0 oroffset + length exceeds the length of thecontent or if offset is less than 0 or ifthe specified encoding scheme is unknown. throws: SizeExceededException - if the contents is larger thanthe available memory or supported size for the message part |
MessagePart | public MessagePart(byte[] contents, java.lang.String mimeType, java.lang.String contentId, java.lang.String contentLocation, java.lang.String enc) throws SizeExceededException(Code) | | Construct a MessagePart object from a byte array. This
constructor is only useful if the data size is small (roughly 10K).
For larger content the InputStream based constructor
should be used.
Parameters: contents - byte array containing the contents for theMessagePart . The contents of the array will becopied into the MessagePart . Parameters: mimeType - the MIME Content-Type for the MessagePart [RFC 2046] Parameters: contentId - the content-id header field value for theMessagePart [RFC 2045]. The content-id is unique over all MessagePart s of a MultipartMessage and must always be set for eachmessage part. Parameters: contentLocation - the content location which specifies thefile name of the file that is attached. If the content location isset to null no content location will be set for thisMessagePart . Parameters: enc - the encoding scheme for the MessagePart .if enc is set to null no encoding willbe used for this MessagePart . throws: java.lang.IllegalArgumentException - if mimeType or contentId isnull . This exception will be thrown ifcontentID or contentLocation containsother characters than specified in US-ASCII format or ifthe specified encoding scheme is unknown. throws: SizeExceededException - if the contents is larger thanthe available memory or supported size for the message part |
MessagePart | public MessagePart(java.io.InputStream is, java.lang.String mimeType, java.lang.String contentId, java.lang.String contentLocation, java.lang.String enc) throws IOException, SizeExceededException(Code) | | Constructs a MessagePart object from an
InputStream . The contents of the MessagePart
are loaded from the InputStream during the constructor
call until the end of the stream is reached.
Parameters: is - InputStream from which the contents of the MessagePart are read. Parameters: mimeType - the MIME Content-Type for the MessagePart [RFC 2046] Parameters: contentId - the content-id header field value for theMessagePart [RFC 2045]. The content-id is unique over all MessagePart s of a MultipartMessage and must always be set for eachmessage part. Parameters: contentLocation - the content location which specifies thefile name of the file that is attached. If the content location isset to null no content location will be set for thisMessagePart . Parameters: enc - the encoding scheme for the MessagePart .if enc is set to null no encoding willbe used for this MessagePart . throws: java.io.IOException - if reading the InputStream causes an exception other than EOFException . throws: java.lang.IllegalArgumentException - if mimeType or contentId isnull . This exception will be thrown ifcontentID or contentLocation containsother characters than specified in US-ASCII format or ifthe specified encoding scheme is unknown. throws: SizeExceededException - of the content from the InputStream is larger than the available memory orsupported size for the message part. |
construct | void construct(byte[] contents, int offset, int length, java.lang.String mimeType, java.lang.String contentId, java.lang.String contentLocation, java.lang.String enc) throws SizeExceededException(Code) | | Constructs a message.
Parameters: contents - byte array containing the contents for theMessagePart . Parameters: offset - start position Parameters: length - the number of bytes to be included in the MessagePart . Parameters: mimeType - the MIME Content-Type for the MessagePart [RFC 2046] Parameters: contentId - the content-id header field value for theMessagePart [RFC 2045]. The content-id is unique over all MessagePart s of a MultipartMessage and must always be set for eachmessage part. Parameters: contentLocation - the content location which specifies thefile name of the file that is attached. If the content location isset to null no content location will be set for thisMessagePart . Parameters: enc - the encoding scheme for the MessagePart .if enc is set to null no encoding willbe used for this MessagePart . throws: java.lang.IllegalArgumentException - if mimeType or contentId isnull . This exception will be thrown ifcontentID or contentLocation containsother characters than specified in US-ASCII format. This exceptionwill be thrown if either length is less than 0 oroffset + length exceeds the length of thecontent or if offset is less than 0 or ifthe specified encoding scheme is unknown. throws: SizeExceededException - if the contents is larger thanthe available memory or supported size for the message part |
containsNonUSASCII | static boolean containsNonUSASCII(String str)(Code) | | Checks if a string contains non-ASCII characters.
Parameters: str - Text to be checked. true if non-ASCII characters are found. |
getContent | public byte[] getContent()(Code) | | Returns the content of the MessagePart as an array of
bytes. If it's not possible to create an arary which can contain all
data, this method must throw an OutOfMemoryError .
MessagePart data as byte array |
getContentAsStream | public java.io.InputStream getContentAsStream()(Code) | | Returns an InputStream for reading the contents of the
MessagePart . Returns an empty stream if no content is
available.
an InputStream that can be used for reading thecontents of this MessagePart . |
getContentID | public java.lang.String getContentID()(Code) | | Returns the content-id value of the MessagePart .
the value of the content-id as a String, or null if the content-id is not set (possible if the message was sentfrom a not JSR 205 compliant client). |
getContentLocation | public java.lang.String getContentLocation()(Code) | | Returns content location of the MessagePart .
content location |
getEncoding | public java.lang.String getEncoding()(Code) | | Returns the encoding of the content, e.g. "US-ASCII", "UTF-8",
"UTF-16", ... as a String .
the encoding of the MessagePart content ornull if the encoding scheme of the MessagePart cannot be determined. |
getLength | public int getLength()(Code) | | Returns the content size of this MessagePart .
Content size (in bytes) of this MessagePart or 0 ifthe MessagePart is empty. |
getMIMEType | public java.lang.String getMIMEType()(Code) | | Returns the mime type of the MessagePart .
MIME type of the MessagePart . |
|
|