moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

Comment and Javadoc updates

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1733119 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Nick Burch 2016-03-01 18:11:14 +00:00
parent ba416e6c09
commit ea9169b3c4
1 changed files with 23 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
src/scratchpad/src/org/apache/poi/hsmf/MAPIMessage.java
View File

@ -18,7 +18,6 @@
package org.apache.poi.hsmf; package org.apache.poi.hsmf;
import java.io.File; import java.io.File;
import java.io.FileInputStream;
import java.io.IOException; import java.io.IOException;
import java.io.InputStream; import java.io.InputStream;
import java.io.OutputStream; import java.io.OutputStream;
@ -60,7 +59,7 @@ import org.apache.poi.util.POILogger;
* Reads an Outlook MSG File in and provides hooks into its data structure. * Reads an Outlook MSG File in and provides hooks into its data structure.
* *
* If you want to develop with HSMF, you might find it worth getting * If you want to develop with HSMF, you might find it worth getting
* some of the microsoft public documentation, such as: * some of the Microsoft public documentation, such as:
* *
* [MS-OXCMSG]: Message and Attachment Object Protocol Specification * [MS-OXCMSG]: Message and Attachment Object Protocol Specification
*/ */
@ -77,7 +76,6 @@ public class MAPIMessage extends POIDocument {
/** /**
* Constructor for creating new files. * Constructor for creating new files.
*
*/ */
public MAPIMessage() { public MAPIMessage() {
// TODO - make writing possible // TODO - make writing possible
@ -87,16 +85,30 @@ public class MAPIMessage extends POIDocument {
/** /**
* Constructor for reading MSG Files from the file system. * Constructor for reading MSG Files from the file system.
* @param filename *
* @param filename Name of the file to read
* @throws IOException * @throws IOException
*/ */
public MAPIMessage(String filename) throws IOException { public MAPIMessage(String filename) throws IOException {
this(new NPOIFSFileSystem(new File(filename))); this(new File(filename));
}
/**
* Constructor for reading MSG Files from the file system.
*
* @param file The file to read from
* @throws IOException
*/
public MAPIMessage(File file) throws IOException {
this(new NPOIFSFileSystem(file));
} }
/** /**
* Constructor for reading MSG Files from an input stream. * Constructor for reading MSG Files from an input stream.
* @param in *
* <p>Note - this will buffer the whole message into memory
* in order to process. For lower memory use, use {@link #MAPIMessage(File)}
*
* @param in The InputStream to buffer then read from
* @throws IOException * @throws IOException
*/ */
public MAPIMessage(InputStream in) throws IOException { public MAPIMessage(InputStream in) throws IOException {
@ -104,7 +116,8 @@ public class MAPIMessage extends POIDocument {
} }
/** /**
* Constructor for reading MSG Files from a POIFS filesystem * Constructor for reading MSG Files from a POIFS filesystem
* @param fs *
* @param fs Open POIFS FileSystem containing the message
* @throws IOException * @throws IOException
*/ */
public MAPIMessage(NPOIFSFileSystem fs) throws IOException { public MAPIMessage(NPOIFSFileSystem fs) throws IOException {
@ -120,7 +133,7 @@ public class MAPIMessage extends POIDocument {
/** /**
* Constructor for reading MSG Files from a certain * Constructor for reading MSG Files from a certain
* point within a POIFS filesystem * point within a POIFS filesystem
* @param poifsDir * @param poifsDir Directory containing the message
* @throws IOException * @throws IOException
*/ */
public MAPIMessage(DirectoryNode poifsDir) throws IOException { public MAPIMessage(DirectoryNode poifsDir) throws IOException {
@ -133,7 +146,7 @@ public class MAPIMessage extends POIDocument {
ArrayList<AttachmentChunks> attachments = new ArrayList<AttachmentChunks>(); ArrayList<AttachmentChunks> attachments = new ArrayList<AttachmentChunks>();
ArrayList<RecipientChunks> recipients = new ArrayList<RecipientChunks>(); ArrayList<RecipientChunks> recipients = new ArrayList<RecipientChunks>();
for(ChunkGroup group : chunkGroups) { for(ChunkGroup group : chunkGroups) {
// Should only ever be one of these // Should only ever be one of each of these
if(group instanceof Chunks) { if(group instanceof Chunks) {
mainChunks = (Chunks)group; mainChunks = (Chunks)group;
} else if(group instanceof NameIdChunks) { } else if(group instanceof NameIdChunks) {
@ -142,7 +155,7 @@ public class MAPIMessage extends POIDocument {
recipients.add( (RecipientChunks)group ); recipients.add( (RecipientChunks)group );
} }
// Add to list(s) // Can be multiple of these - add to list(s)
if(group instanceof AttachmentChunks) { if(group instanceof AttachmentChunks) {
attachments.add( (AttachmentChunks)group ); attachments.add( (AttachmentChunks)group );
} }