Author: norman
Date: Sat Mar 31 07:59:35 2007
New Revision: 524437
URL: http://svn.apache.org/viewvc?view=rev&rev=524437
Log:
Add javadocs
Remove unused stuff
Modified:
james/mime4j/trunk/src/main/java/org/mime4j/AbstractContentHandler.java
james/mime4j/trunk/src/main/java/org/mime4j/CloseShieldInputStream.java
james/mime4j/trunk/src/main/java/org/mime4j/EOLConvertingInputStream.java
james/mime4j/trunk/src/main/java/org/mime4j/MimeBoundaryInputStream.java
james/mime4j/trunk/src/main/java/org/mime4j/RootInputStream.java
james/mime4j/trunk/src/main/java/org/mime4j/SimpleContentHandler.java
james/mime4j/trunk/src/main/java/org/mime4j/message/Entity.java
james/mime4j/trunk/src/main/java/org/mime4j/message/Header.java
james/mime4j/trunk/src/main/java/org/mime4j/message/TempFileBinaryBody.java
james/mime4j/trunk/src/main/java/org/mime4j/util/SimpleTempStorage.java
Modified:
james/mime4j/trunk/src/main/java/org/mime4j/AbstractContentHandler.java
URL:
http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/mime4j/AbstractContentHandler.java?view=diff&rev=524437&r1=524436&r2=524437
==============================================================================
--- james/mime4j/trunk/src/main/java/org/mime4j/AbstractContentHandler.java
(original)
+++ james/mime4j/trunk/src/main/java/org/mime4j/AbstractContentHandler.java Sat
Mar 31 07:59:35 2007
@@ -25,6 +25,8 @@
/**
* Abstract <code>ContentHandler</code> with default implementations of all
* the methods of the <code>ContentHandler</code> interface.
+ *
+ * The default is to todo nothing.
*
*
* @version $Id: AbstractContentHandler.java,v 1.3 2004/10/02 12:41:10
ntherning Exp $
Modified:
james/mime4j/trunk/src/main/java/org/mime4j/CloseShieldInputStream.java
URL:
http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/mime4j/CloseShieldInputStream.java?view=diff&rev=524437&r1=524436&r2=524437
==============================================================================
--- james/mime4j/trunk/src/main/java/org/mime4j/CloseShieldInputStream.java
(original)
+++ james/mime4j/trunk/src/main/java/org/mime4j/CloseShieldInputStream.java Sat
Mar 31 07:59:35 2007
@@ -44,51 +44,84 @@
return is;
}
+ /**
+ * @see java.io.InputStream#read()
+ */
public int read() throws IOException {
checkIfClosed();
return is.read();
}
+ /**
+ * @see java.io.InputStream#available()
+ */
public int available() throws IOException {
checkIfClosed();
return is.available();
}
+
+ /**
+ * Set the underlying InputStream to null
+ */
public void close() throws IOException {
is = null;
}
+ /**
+ * @see java.io.FilterInputStream#reset()
+ */
public synchronized void reset() throws IOException {
checkIfClosed();
is.reset();
}
+ /**
+ * @see java.io.FilterInputStream#markSupported()
+ */
public boolean markSupported() {
if (is == null)
return false;
return is.markSupported();
}
+ /**
+ * @see java.io.FilterInputStream#mark(int)
+ */
public synchronized void mark(int readlimit) {
if (is != null)
is.mark(readlimit);
}
+ /**
+ * @see java.io.FilterInputStream#skip(long)
+ */
public long skip(long n) throws IOException {
checkIfClosed();
return is.skip(n);
}
+ /**
+ * @see java.io.FilterInputStream#read(byte[])
+ */
public int read(byte b[]) throws IOException {
checkIfClosed();
return is.read(b);
}
+ /**
+ * @see java.io.FilterInputStream#read(byte[], int, int)
+ */
public int read(byte b[], int off, int len) throws IOException {
checkIfClosed();
return is.read(b, off, len);
}
+ /**
+ * Check if the underlying InputStream is null. If so throw an Exception
+ *
+ * @throws IOException if the underlying InputStream is null
+ */
private void checkIfClosed() throws IOException {
if (is == null)
throw new IOException("Stream is closed");
Modified:
james/mime4j/trunk/src/main/java/org/mime4j/EOLConvertingInputStream.java
URL:
http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/mime4j/EOLConvertingInputStream.java?view=diff&rev=524437&r1=524436&r2=524437
==============================================================================
--- james/mime4j/trunk/src/main/java/org/mime4j/EOLConvertingInputStream.java
(original)
+++ james/mime4j/trunk/src/main/java/org/mime4j/EOLConvertingInputStream.java
Sat Mar 31 07:59:35 2007
@@ -77,6 +77,9 @@
in.close();
}
+ /**
+ * @see java.io.InputStream#read()
+ */
public int read() throws IOException {
int b = in.read();
Modified:
james/mime4j/trunk/src/main/java/org/mime4j/MimeBoundaryInputStream.java
URL:
http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/mime4j/MimeBoundaryInputStream.java?view=diff&rev=524437&r1=524436&r2=524437
==============================================================================
--- james/mime4j/trunk/src/main/java/org/mime4j/MimeBoundaryInputStream.java
(original)
+++ james/mime4j/trunk/src/main/java/org/mime4j/MimeBoundaryInputStream.java
Sat Mar 31 07:59:35 2007
@@ -23,9 +23,6 @@
import java.io.InputStream;
import java.io.PushbackInputStream;
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-
/**
* Stream that constrains itself to a single MIME body part.
* After the stream ends (i.e. read() returns -1) [EMAIL PROTECTED]
#hasMoreParts()}
@@ -38,8 +35,7 @@
* @version $Id: MimeBoundaryInputStream.java,v 1.2 2004/11/29 13:15:42
ntherning Exp $
*/
public class MimeBoundaryInputStream extends InputStream {
- private static Log log = LogFactory.getLog(MimeBoundaryInputStream.class);
-
+
private PushbackInputStream s = null;
private byte[] boundary = null;
private boolean first = true;
@@ -114,6 +110,9 @@
}
}
+ /**
+ * @see java.io.InputStream#read()
+ */
public int read() throws IOException {
if (eof) {
return -1;
Modified: james/mime4j/trunk/src/main/java/org/mime4j/RootInputStream.java
URL:
http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/mime4j/RootInputStream.java?view=diff&rev=524437&r1=524436&r2=524437
==============================================================================
--- james/mime4j/trunk/src/main/java/org/mime4j/RootInputStream.java (original)
+++ james/mime4j/trunk/src/main/java/org/mime4j/RootInputStream.java Sat Mar 31
07:59:35 2007
@@ -67,6 +67,9 @@
this.truncated = true;
}
+ /**
+ * @see java.io.InputStream#read()
+ */
public int read() throws IOException {
if (truncated) {
return -1;
@@ -80,6 +83,10 @@
return b;
}
+ /**
+ *
+ * @see java.io.InputStream#read(byte[], int, int)
+ */
public int read(byte[] b, int off, int len) throws IOException {
if (truncated) {
return -1;
@@ -95,6 +102,9 @@
return n;
}
+ /**
+ * @see java.io.InputStream#read(byte[])
+ */
public int read(byte[] b) throws IOException {
return read(b, 0, b.length);
}
Modified: james/mime4j/trunk/src/main/java/org/mime4j/SimpleContentHandler.java
URL:
http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/mime4j/SimpleContentHandler.java?view=diff&rev=524437&r1=524436&r2=524437
==============================================================================
--- james/mime4j/trunk/src/main/java/org/mime4j/SimpleContentHandler.java
(original)
+++ james/mime4j/trunk/src/main/java/org/mime4j/SimpleContentHandler.java Sat
Mar 31 07:59:35 2007
@@ -60,20 +60,32 @@
private Header currHeader;
+ /**
+ * @see org.mime4j.AbstractContentHandler#startHeader()
+ */
public final void startHeader() {
currHeader = new Header();
}
+ /**
+ * @see org.mime4j.AbstractContentHandler#field(java.lang.String)
+ */
public final void field(String fieldData) {
currHeader.addField(Field.parse(fieldData));
}
+ /**
+ * @see org.mime4j.AbstractContentHandler#endHeader()
+ */
public final void endHeader() {
Header tmp = currHeader;
currHeader = null;
headers(tmp);
}
+ /**
+ * @see org.mime4j.AbstractContentHandler#body(org.mime4j.BodyDescriptor,
java.io.InputStream)
+ */
public final void body(BodyDescriptor bd, InputStream is) throws
IOException {
if (bd.isBase64Encoded()) {
bodyDecoded(bd, new Base64InputStream(is));
Modified: james/mime4j/trunk/src/main/java/org/mime4j/message/Entity.java
URL:
http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/mime4j/message/Entity.java?view=diff&rev=524437&r1=524436&r2=524437
==============================================================================
--- james/mime4j/trunk/src/main/java/org/mime4j/message/Entity.java (original)
+++ james/mime4j/trunk/src/main/java/org/mime4j/message/Entity.java Sat Mar 31
07:59:35 2007
@@ -160,5 +160,11 @@
&&
getMimeType().startsWith(ContentTypeField.TYPE_MULTIPART_PREFIX);
}
+ /**
+ * Write the content to the given outputstream
+ *
+ * @param out the outputstream to write to
+ * @throws IOException
+ */
public abstract 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=524437&r1=524436&r2=524437
==============================================================================
--- james/mime4j/trunk/src/main/java/org/mime4j/message/Header.java (original)
+++ james/mime4j/trunk/src/main/java/org/mime4j/message/Header.java Sat Mar 31
07:59:35 2007
@@ -139,9 +139,9 @@
/**
- * Write the Header to the given outputStream
+ * Write the Header to the given OutputStream
*
- * @param out
+ * @param out the OutputStream to write to
* @throws IOException
*/
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=524437&r1=524436&r2=524437
==============================================================================
--- james/mime4j/trunk/src/main/java/org/mime4j/message/TempFileBinaryBody.java
(original)
+++ james/mime4j/trunk/src/main/java/org/mime4j/message/TempFileBinaryBody.java
Sat Mar 31 07:59:35 2007
@@ -43,6 +43,12 @@
private Entity parent = null;
private TempFile tempFile = null;
+ /**
+ * Use the given InputStream to build the TemporyFileBinaryBody
+ *
+ * @param is the InputStream to use as source
+ * @throws IOException
+ */
public TempFileBinaryBody(InputStream is) throws IOException {
TempPath tempPath = TempStorage.getInstance().getRootTempPath();
Modified:
james/mime4j/trunk/src/main/java/org/mime4j/util/SimpleTempStorage.java
URL:
http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/mime4j/util/SimpleTempStorage.java?view=diff&rev=524437&r1=524436&r2=524437
==============================================================================
--- james/mime4j/trunk/src/main/java/org/mime4j/util/SimpleTempStorage.java
(original)
+++ james/mime4j/trunk/src/main/java/org/mime4j/util/SimpleTempStorage.java Sat
Mar 31 07:59:35 2007
@@ -109,6 +109,9 @@
return new SimpleTempFile(f);
}
+ /**
+ * @see org.mime4j.util.TempStorage#getRootTempPath()
+ */
public TempPath getRootTempPath() {
return rootPath;
}
@@ -124,16 +127,25 @@
this.path = path;
}
+ /**
+ * @see org.mime4j.util.TempPath#createTempFile()
+ */
public TempFile createTempFile() throws IOException {
return SimpleTempStorage.this.createTempFile(this, null, null);
}
+ /**
+ * @see org.mime4j.util.TempPath#createTempFile(java.lang.String,
java.lang.String)
+ */
public TempFile createTempFile(String prefix, String suffix)
throws IOException {
return SimpleTempStorage.this.createTempFile(this, prefix, suffix);
}
+ /**
+ * @see org.mime4j.util.TempPath#createTempFile(java.lang.String,
java.lang.String, boolean)
+ */
public TempFile createTempFile(String prefix, String suffix,
boolean allowInMemory)
throws IOException {
@@ -141,17 +153,29 @@
return SimpleTempStorage.this.createTempFile(this, prefix, suffix);
}
+ /**
+ * @see org.mime4j.util.TempPath#getAbsolutePath()
+ */
public String getAbsolutePath() {
return path.getAbsolutePath();
}
+ /**
+ * Do nothing
+ */
public void delete() {
}
+ /**
+ * @see org.mime4j.util.TempPath#createTempPath()
+ */
public TempPath createTempPath() throws IOException {
return SimpleTempStorage.this.createTempPath(this, null);
}
+ /**
+ * @see org.mime4j.util.TempPath#createTempPath(java.lang.String)
+ */
public TempPath createTempPath(String prefix) throws IOException {
return SimpleTempStorage.this.createTempPath(this, prefix);
}
@@ -160,36 +184,50 @@
private class SimpleTempFile implements TempFile {
private File file = null;
-
- private SimpleTempFile(String file) {
- this.file = new File(file);
- this.file.deleteOnExit();
- }
-
+
private SimpleTempFile(File file) {
this.file = file;
this.file.deleteOnExit();
}
+ /**
+ * @see org.mime4j.util.TempFile#getInputStream()
+ */
public InputStream getInputStream() throws IOException {
return new BufferedInputStream(new FileInputStream(file));
}
+ /**
+ * @see org.mime4j.util.TempFile#getOutputStream()
+ */
public OutputStream getOutputStream() throws IOException {
return new BufferedOutputStream(new FileOutputStream(file));
}
+ /**
+ * @see org.mime4j.util.TempFile#getAbsolutePath()
+ */
public String getAbsolutePath() {
return file.getAbsolutePath();
}
+ /**
+ * Do nothing
+ */
public void delete() {
+ // Not implementated
}
+ /**
+ * @see org.mime4j.util.TempFile#isInMemory()
+ */
public boolean isInMemory() {
return false;
}
+ /**
+ * @see org.mime4j.util.TempFile#length()
+ */
public long length() {
return file.length();
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
