You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by no...@apache.org on 2007/02/21 13:07:40 UTC
svn commit: r509981 - in
/james/mime4j/trunk/src/main/java/org/mime4j/message: AbstractBody.java
BinaryBody.java BodyPart.java Header.java Message.java Multipart.java
TempFileBinaryBody.java TempFileTextBody.java
Author: norman
Date: Wed Feb 21 04:07:40 2007
New Revision: 509981
URL: http://svn.apache.org/viewvc?view=rev&rev=509981
Log:
Add some javadocs, remove deprecated methods
Modified:
james/mime4j/trunk/src/main/java/org/mime4j/message/AbstractBody.java
james/mime4j/trunk/src/main/java/org/mime4j/message/BinaryBody.java
james/mime4j/trunk/src/main/java/org/mime4j/message/BodyPart.java
james/mime4j/trunk/src/main/java/org/mime4j/message/Header.java
james/mime4j/trunk/src/main/java/org/mime4j/message/Message.java
james/mime4j/trunk/src/main/java/org/mime4j/message/Multipart.java
james/mime4j/trunk/src/main/java/org/mime4j/message/TempFileBinaryBody.java
james/mime4j/trunk/src/main/java/org/mime4j/message/TempFileTextBody.java
Modified: james/mime4j/trunk/src/main/java/org/mime4j/message/AbstractBody.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/mime4j/message/AbstractBody.java?view=diff&rev=509981&r1=509980&r2=509981
==============================================================================
--- james/mime4j/trunk/src/main/java/org/mime4j/message/AbstractBody.java (original)
+++ james/mime4j/trunk/src/main/java/org/mime4j/message/AbstractBody.java Wed Feb 21 04:07:40 2007
@@ -30,10 +30,16 @@
public abstract class AbstractBody implements Body {
private Entity parent = null;
+ /**
+ * @see org.mime4j.message.Body#getParent()
+ */
public Entity getParent() {
return parent;
}
+ /**
+ * @see org.mime4j.message.Body#setParent(org.mime4j.message.Entity)
+ */
public void setParent(Entity parent) {
this.parent = parent;
}
Modified: james/mime4j/trunk/src/main/java/org/mime4j/message/BinaryBody.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/mime4j/message/BinaryBody.java?view=diff&rev=509981&r1=509980&r2=509981
==============================================================================
--- james/mime4j/trunk/src/main/java/org/mime4j/message/BinaryBody.java (original)
+++ james/mime4j/trunk/src/main/java/org/mime4j/message/BinaryBody.java Wed Feb 21 04:07:40 2007
@@ -30,6 +30,7 @@
* @version $Id: BinaryBody.java,v 1.3 2004/10/02 12:41:11 ntherning Exp $
*/
public interface BinaryBody extends Body {
+
/**
* Gets a <code>InputStream</code> which reads the bytes of the
* body.
Modified: james/mime4j/trunk/src/main/java/org/mime4j/message/BodyPart.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/mime4j/message/BodyPart.java?view=diff&rev=509981&r1=509980&r2=509981
==============================================================================
--- james/mime4j/trunk/src/main/java/org/mime4j/message/BodyPart.java (original)
+++ james/mime4j/trunk/src/main/java/org/mime4j/message/BodyPart.java Wed Feb 21 04:07:40 2007
@@ -29,6 +29,12 @@
* @version $Id: BodyPart.java,v 1.3 2004/10/02 12:41:11 ntherning Exp $
*/
public class BodyPart extends Entity {
+
+ /**
+ * TODO: Implement me
+ *
+ * @see org.mime4j.message.Entity#writeTo(java.io.OutputStream)
+ */
public void writeTo(OutputStream out) throws IOException {
}
}
Modified: james/mime4j/trunk/src/main/java/org/mime4j/message/Header.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/mime4j/message/Header.java?view=diff&rev=509981&r1=509980&r2=509981
==============================================================================
--- james/mime4j/trunk/src/main/java/org/mime4j/message/Header.java (original)
+++ james/mime4j/trunk/src/main/java/org/mime4j/message/Header.java Wed Feb 21 04:07:40 2007
@@ -117,6 +117,12 @@
return Collections.unmodifiableList(l);
}
+ /**
+ * Return Header Object as String representation. Each headerline is
+ * seperated by "\r\n"
+ *
+ * @return headers
+ */
public String toString() {
StringBuffer str = new StringBuffer();
for (Iterator it = fields.iterator(); it.hasNext();) {
Modified: james/mime4j/trunk/src/main/java/org/mime4j/message/Message.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/mime4j/message/Message.java?view=diff&rev=509981&r1=509980&r2=509981
==============================================================================
--- james/mime4j/trunk/src/main/java/org/mime4j/message/Message.java (original)
+++ james/mime4j/trunk/src/main/java/org/mime4j/message/Message.java Wed Feb 21 04:07:40 2007
@@ -77,6 +77,11 @@
return (UnstructuredField) getHeader().getField(Field.SUBJECT);
}
+ /**
+ * TODO: Implement me
+ * '//
+ * @see org.mime4j.message.Entity#writeTo(java.io.OutputStream)
+ */
public void writeTo(OutputStream out) throws IOException {
}
@@ -95,6 +100,9 @@
}
}
+ /**
+ * @see org.mime4j.ContentHandler#startMessage()
+ */
public void startMessage() {
if (stack.isEmpty()) {
stack.push(Message.this);
@@ -106,20 +114,32 @@
}
}
+ /**
+ * @see org.mime4j.ContentHandler#endMessage()
+ */
public void endMessage() {
expect(Message.class);
stack.pop();
}
+ /**
+ * @see org.mime4j.ContentHandler#startHeader()
+ */
public void startHeader() {
stack.push(new Header());
}
+ /**
+ * @see org.mime4j.ContentHandler#field(java.lang.String)
+ */
public void field(String fieldData) {
expect(Header.class);
((Header) stack.peek()).addField(Field.parse(fieldData));
}
+ /**
+ * @see org.mime4j.ContentHandler#endHeader()
+ */
public void endHeader() {
expect(Header.class);
Header h = (Header) stack.pop();
@@ -127,6 +147,9 @@
((Entity) stack.peek()).setHeader(h);
}
+ /**
+ * @see org.mime4j.ContentHandler#startMultipart(org.mime4j.BodyDescriptor)
+ */
public void startMultipart(BodyDescriptor bd) {
expect(Entity.class);
@@ -136,6 +159,9 @@
stack.push(multiPart);
}
+ /**
+ * @see org.mime4j.ContentHandler#body(org.mime4j.BodyDescriptor, java.io.InputStream)
+ */
public void body(BodyDescriptor bd, InputStream is) throws IOException {
expect(Entity.class);
@@ -156,10 +182,16 @@
((Entity) stack.peek()).setBody(body);
}
+ /**
+ * @see org.mime4j.ContentHandler#endMultipart()
+ */
public void endMultipart() {
stack.pop();
}
+ /**
+ * @see org.mime4j.ContentHandler#startBodyPart()
+ */
public void startBodyPart() {
expect(Multipart.class);
@@ -168,11 +200,17 @@
stack.push(bodyPart);
}
+ /**
+ * @see org.mime4j.ContentHandler#endBodyPart()
+ */
public void endBodyPart() {
expect(BodyPart.class);
stack.pop();
}
+ /**
+ * @see org.mime4j.ContentHandler#epilogue(java.io.InputStream)
+ */
public void epilogue(InputStream is) throws IOException {
expect(Multipart.class);
StringBuffer sb = new StringBuffer();
@@ -183,6 +221,9 @@
((Multipart) stack.peek()).setEpilogue(sb.toString());
}
+ /**
+ * @see org.mime4j.ContentHandler#preamble(java.io.InputStream)
+ */
public void preamble(InputStream is) throws IOException {
expect(Multipart.class);
StringBuffer sb = new StringBuffer();
@@ -193,6 +234,11 @@
((Multipart) stack.peek()).setPreamble(sb.toString());
}
+ /**
+ * TODO: Implement me
+ *
+ * @see org.mime4j.ContentHandler#raw(java.io.InputStream)
+ */
public void raw(InputStream is) throws IOException {
}
Modified: james/mime4j/trunk/src/main/java/org/mime4j/message/Multipart.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/mime4j/message/Multipart.java?view=diff&rev=509981&r1=509980&r2=509981
==============================================================================
--- james/mime4j/trunk/src/main/java/org/mime4j/message/Multipart.java (original)
+++ james/mime4j/trunk/src/main/java/org/mime4j/message/Multipart.java Wed Feb 21 04:07:40 2007
@@ -71,10 +71,16 @@
this.subType = subType;
}
+ /**
+ * @see org.mime4j.message.Body#getParent()
+ */
public Entity getParent() {
return parent;
}
+ /**
+ * @see org.mime4j.message.Body#setParent(org.mime4j.message.Entity)
+ */
public void setParent(Entity parent) {
this.parent = parent;
for (Iterator it = bodyParts.iterator(); it.hasNext();) {
@@ -149,6 +155,11 @@
this.preamble = preamble;
}
+ /**
+ * TODO: Implement me
+ *
+ * @see org.mime4j.message.Body#writeTo(java.io.OutputStream)
+ */
public void writeTo(OutputStream out) throws IOException {
}
}
Modified: james/mime4j/trunk/src/main/java/org/mime4j/message/TempFileBinaryBody.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/mime4j/message/TempFileBinaryBody.java?view=diff&rev=509981&r1=509980&r2=509981
==============================================================================
--- james/mime4j/trunk/src/main/java/org/mime4j/message/TempFileBinaryBody.java (original)
+++ james/mime4j/trunk/src/main/java/org/mime4j/message/TempFileBinaryBody.java Wed Feb 21 04:07:40 2007
@@ -23,7 +23,7 @@
import java.io.InputStream;
import java.io.OutputStream;
-import org.apache.commons.io.CopyUtils;
+import org.apache.commons.io.IOUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.mime4j.util.TempFile;
@@ -49,22 +49,35 @@
tempFile = tempPath.createTempFile("attachment", ".bin");
OutputStream out = tempFile.getOutputStream();
- CopyUtils.copy(is, out);
+ IOUtils.copy(is, out);
out.close();
}
+ /**
+ * @see org.mime4j.message.AbstractBody#getParent()
+ */
public Entity getParent() {
return parent;
}
+ /**
+ * @see org.mime4j.message.AbstractBody#setParent(org.mime4j.message.Entity)
+ */
public void setParent(Entity parent) {
this.parent = parent;
}
+ /**
+ * @see org.mime4j.message.BinaryBody#getInputStream()
+ */
public InputStream getInputStream() throws IOException {
return tempFile.getInputStream();
}
+ /**
+ * @see org.mime4j.message.Body#writeTo(java.io.OutputStream)
+ */
public void writeTo(OutputStream out) throws IOException {
+ IOUtils.copy(getInputStream(),out);
}
}
Modified: james/mime4j/trunk/src/main/java/org/mime4j/message/TempFileTextBody.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/mime4j/message/TempFileTextBody.java?view=diff&rev=509981&r1=509980&r2=509981
==============================================================================
--- james/mime4j/trunk/src/main/java/org/mime4j/message/TempFileTextBody.java (original)
+++ james/mime4j/trunk/src/main/java/org/mime4j/message/TempFileTextBody.java Wed Feb 21 04:07:40 2007
@@ -26,7 +26,7 @@
import java.io.Reader;
import java.io.UnsupportedEncodingException;
-import org.apache.commons.io.CopyUtils;
+import org.apache.commons.io.IOUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.mime4j.util.CharsetUtil;
@@ -60,10 +60,13 @@
tempFile = tempPath.createTempFile("attachment", ".txt");
OutputStream out = tempFile.getOutputStream();
- CopyUtils.copy(is, out);
+ IOUtils.copy(is, out);
out.close();
}
+ /**
+ * @see org.mime4j.message.TextBody#getReader()
+ */
public Reader getReader() throws UnsupportedEncodingException, IOException {
String javaCharset = null;
if (mimeCharset != null) {
@@ -102,6 +105,11 @@
return new InputStreamReader(tempFile.getInputStream(), javaCharset);
}
+
+ /**
+ * @see org.mime4j.message.Body#writeTo(java.io.OutputStream)
+ */
public void writeTo(OutputStream out) throws IOException {
+ IOUtils.copy(tempFile.getInputStream(), out);
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org