mirror of
https://github.com/haraldk/TwelveMonkeys.git
synced 2025-08-02 11:05:29 -04:00
Cleaning up documentation. Renamed package.html to package_info.java.
This commit is contained in:
parent
ac68a31c36
commit
1c22280f51
@ -141,7 +141,7 @@ public class ConvolveWithEdgeOp implements BufferedImageOp, RasterOp {
|
||||
return pOriginal;
|
||||
}
|
||||
|
||||
// TODO: Might be faster if we could clone raster and strech it...
|
||||
// TODO: Might be faster if we could clone raster and stretch it...
|
||||
int w = pOriginal.getWidth();
|
||||
int h = pOriginal.getHeight();
|
||||
|
||||
|
@ -82,11 +82,11 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads a <code>boolean</code> from the underlying input stream by
|
||||
* Reads a {@code boolean} from the underlying input stream by
|
||||
* reading a single byte. If the byte is zero, false is returned.
|
||||
* If the byte is positive, true is returned.
|
||||
*
|
||||
* @return the <code>boolean</code> value read.
|
||||
* @return the {@code boolean} value read.
|
||||
* @throws EOFException if the end of the underlying input stream
|
||||
* has been reached
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
@ -100,10 +100,10 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads a signed <code>byte</code> from the underlying input stream
|
||||
* Reads a signed {@code byte} from the underlying input stream
|
||||
* with value between -128 and 127
|
||||
*
|
||||
* @return the <code>byte</code> value read.
|
||||
* @return the {@code byte} value read.
|
||||
* @throws EOFException if the end of the underlying input stream
|
||||
* has been reached
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
@ -118,10 +118,10 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads an unsigned <code>byte</code> from the underlying
|
||||
* Reads an unsigned {@code byte} from the underlying
|
||||
* input stream with value between 0 and 255
|
||||
*
|
||||
* @return the <code>byte</code> value read.
|
||||
* @return the {@code byte} value read.
|
||||
* @throws EOFException if the end of the underlying input
|
||||
* stream has been reached
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
@ -135,10 +135,10 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads a two byte signed <code>short</code> from the underlying
|
||||
* Reads a two byte signed {@code short} from the underlying
|
||||
* input stream in little endian order, low byte first.
|
||||
*
|
||||
* @return the <code>short</code> read.
|
||||
* @return the {@code short} read.
|
||||
* @throws EOFException if the end of the underlying input stream
|
||||
* has been reached
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
@ -155,7 +155,7 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads a two byte unsigned <code>short</code> from the underlying
|
||||
* Reads a two byte unsigned {@code short} from the underlying
|
||||
* input stream in little endian order, low byte first.
|
||||
*
|
||||
* @return the int value of the unsigned short read.
|
||||
@ -174,7 +174,7 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads a two byte Unicode <code>char</code> from the underlying
|
||||
* Reads a two byte Unicode {@code char} from the underlying
|
||||
* input stream in little endian order, low byte first.
|
||||
*
|
||||
* @return the int value of the unsigned short read.
|
||||
@ -193,10 +193,10 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
|
||||
|
||||
|
||||
/**
|
||||
* Reads a four byte signed <code>int</code> from the underlying
|
||||
* Reads a four byte signed {@code int} from the underlying
|
||||
* input stream in little endian order, low byte first.
|
||||
*
|
||||
* @return the <code>int</code> read.
|
||||
* @return the {@code int} read.
|
||||
* @throws EOFException if the end of the underlying input stream
|
||||
* has been reached
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
@ -215,10 +215,10 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads an eight byte signed <code>int</code> from the underlying
|
||||
* Reads an eight byte signed {@code int} from the underlying
|
||||
* input stream in little endian order, low byte first.
|
||||
*
|
||||
* @return the <code>int</code> read.
|
||||
* @return the {@code int} read.
|
||||
* @throws EOFException if the end of the underlying input stream
|
||||
* has been reached
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
@ -315,7 +315,7 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
|
||||
|
||||
/**
|
||||
* @return the next eight bytes of this input stream, interpreted as a
|
||||
* little endian <code>double</code>.
|
||||
* little endian {@code double}.
|
||||
* @throws EOFException if end of stream occurs before eight bytes
|
||||
* have been read.
|
||||
* @throws IOException if an I/O error occurs.
|
||||
@ -326,7 +326,7 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
|
||||
|
||||
/**
|
||||
* @return the next four bytes of this input stream, interpreted as a
|
||||
* little endian <code>int</code>.
|
||||
* little endian {@code int}.
|
||||
* @throws EOFException if end of stream occurs before four bytes
|
||||
* have been read.
|
||||
* @throws IOException if an I/O error occurs.
|
||||
@ -336,8 +336,8 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
|
||||
}
|
||||
|
||||
/**
|
||||
* See the general contract of the <code>skipBytes</code>
|
||||
* method of <code>DataInput</code>.
|
||||
* See the general contract of the {@code skipBytes}
|
||||
* method of {@code DataInput}.
|
||||
* <p>
|
||||
* Bytes for this operation are read from the contained input stream.
|
||||
*
|
||||
@ -359,8 +359,8 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
|
||||
}
|
||||
|
||||
/**
|
||||
* See the general contract of the <code>readFully</code>
|
||||
* method of <code>DataInput</code>.
|
||||
* See the general contract of the {@code readFully}
|
||||
* method of {@code DataInput}.
|
||||
* <p/>
|
||||
* Bytes
|
||||
* for this operation are read from the contained
|
||||
@ -377,8 +377,8 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
|
||||
}
|
||||
|
||||
/**
|
||||
* See the general contract of the <code>readFully</code>
|
||||
* method of <code>DataInput</code>.
|
||||
* See the general contract of the {@code readFully}
|
||||
* method of {@code DataInput}.
|
||||
* <p/>
|
||||
* Bytes
|
||||
* for this operation are read from the contained
|
||||
@ -407,8 +407,8 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
|
||||
}
|
||||
|
||||
/**
|
||||
* See the general contract of the <code>readLine</code>
|
||||
* method of <code>DataInput</code>.
|
||||
* See the general contract of the {@code readLine}
|
||||
* method of {@code DataInput}.
|
||||
* <p>
|
||||
* Bytes for this operation are read from the contained input stream.
|
||||
*
|
||||
|
@ -88,7 +88,7 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
|
||||
/**
|
||||
* Writes the specified byte value to the underlying output stream.
|
||||
*
|
||||
* @param pByte the <code>byte</code> value to be written.
|
||||
* @param pByte the {@code byte} value to be written.
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
*/
|
||||
public synchronized void write(int pByte) throws IOException {
|
||||
@ -97,8 +97,8 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes <code>pLength</code> bytes from the specified byte array
|
||||
* starting at <code>pOffset</code> to the underlying output stream.
|
||||
* Writes {@code pLength} bytes from the specified byte array
|
||||
* starting at {@code pOffset} to the underlying output stream.
|
||||
*
|
||||
* @param pBytes the data.
|
||||
* @param pOffset the start offset in the data.
|
||||
@ -113,11 +113,11 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
|
||||
|
||||
|
||||
/**
|
||||
* Writes a <code>boolean</code> to the underlying output stream as
|
||||
* Writes a {@code boolean} to the underlying output stream as
|
||||
* a single byte. If the argument is true, the byte value 1 is written.
|
||||
* If the argument is false, the byte value <code>0</code> in written.
|
||||
* If the argument is false, the byte value {@code 0} in written.
|
||||
*
|
||||
* @param pBoolean the <code>boolean</code> value to be written.
|
||||
* @param pBoolean the {@code boolean} value to be written.
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
*/
|
||||
public void writeBoolean(boolean pBoolean) throws IOException {
|
||||
@ -130,9 +130,9 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes out a <code>byte</code> to the underlying output stream
|
||||
* Writes out a {@code byte} to the underlying output stream
|
||||
*
|
||||
* @param pByte the <code>byte</code> value to be written.
|
||||
* @param pByte the {@code byte} value to be written.
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
*/
|
||||
public void writeByte(int pByte) throws IOException {
|
||||
@ -141,10 +141,10 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes a two byte <code>short</code> to the underlying output stream in
|
||||
* Writes a two byte {@code short} to the underlying output stream in
|
||||
* little endian order, low byte first.
|
||||
*
|
||||
* @param pShort the <code>short</code> to be written.
|
||||
* @param pShort the {@code short} to be written.
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
*/
|
||||
public void writeShort(int pShort) throws IOException {
|
||||
@ -154,10 +154,10 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes a two byte <code>char</code> to the underlying output stream
|
||||
* Writes a two byte {@code char} to the underlying output stream
|
||||
* in little endian order, low byte first.
|
||||
*
|
||||
* @param pChar the <code>char</code> value to be written.
|
||||
* @param pChar the {@code char} value to be written.
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
*/
|
||||
public void writeChar(int pChar) throws IOException {
|
||||
@ -167,10 +167,10 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes a four-byte <code>int</code> to the underlying output stream
|
||||
* Writes a four-byte {@code int} to the underlying output stream
|
||||
* in little endian order, low byte first, high byte last
|
||||
*
|
||||
* @param pInt the <code>int</code> to be written.
|
||||
* @param pInt the {@code int} to be written.
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
*/
|
||||
public void writeInt(int pInt) throws IOException {
|
||||
@ -183,10 +183,10 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes an eight-byte <code>long</code> to the underlying output stream
|
||||
* Writes an eight-byte {@code long} to the underlying output stream
|
||||
* in little endian order, low byte first, high byte last
|
||||
*
|
||||
* @param pLong the <code>long</code> to be written.
|
||||
* @param pLong the {@code long} to be written.
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
*/
|
||||
public void writeLong(long pLong) throws IOException {
|
||||
@ -205,7 +205,7 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
|
||||
* Writes a 4 byte Java float to the underlying output stream in
|
||||
* little endian order.
|
||||
*
|
||||
* @param f the <code>float</code> value to be written.
|
||||
* @param f the {@code float} value to be written.
|
||||
* @throws IOException if an I/O error occurs.
|
||||
*/
|
||||
public final void writeFloat(float f) throws IOException {
|
||||
@ -216,7 +216,7 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
|
||||
* Writes an 8 byte Java double to the underlying output stream in
|
||||
* little endian order.
|
||||
*
|
||||
* @param d the <code>double</code> value to be written.
|
||||
* @param d the {@code double} value to be written.
|
||||
* @throws IOException if an I/O error occurs.
|
||||
*/
|
||||
public final void writeDouble(double d) throws IOException {
|
||||
@ -226,9 +226,9 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
|
||||
/**
|
||||
* Writes a string to the underlying output stream as a sequence of
|
||||
* bytes. Each character is written to the data output stream as
|
||||
* if by the <code>writeByte()</code> method.
|
||||
* if by the {@link #writeByte(int)} method.
|
||||
*
|
||||
* @param pString the <code>String</code> value to be written.
|
||||
* @param pString the {@code String} value to be written.
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
* @see #writeByte(int)
|
||||
* @see #out
|
||||
@ -244,9 +244,9 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
|
||||
/**
|
||||
* Writes a string to the underlying output stream as a sequence of
|
||||
* characters. Each character is written to the data output stream as
|
||||
* if by the <code>writeChar</code> method.
|
||||
* if by the {@code writeChar} method.
|
||||
*
|
||||
* @param pString a <code>String</code> value to be written.
|
||||
* @param pString a {@code String} value to be written.
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
* @see #writeChar(int)
|
||||
* @see #out
|
||||
@ -325,7 +325,7 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
|
||||
* (This class is not thread-safe with respect to this method. It is
|
||||
* possible that this number is temporarily less than the actual
|
||||
* number of bytes written.)
|
||||
* @return the value of the <code>written</code> field.
|
||||
* @return the value of the {@code written} field.
|
||||
* @see #mWritten
|
||||
*/
|
||||
public int size() {
|
||||
|
@ -111,11 +111,11 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads a <code>boolean</code> from the underlying input stream by
|
||||
* Reads a {@code boolean} from the underlying input stream by
|
||||
* reading a single byte. If the byte is zero, false is returned.
|
||||
* If the byte is positive, true is returned.
|
||||
*
|
||||
* @return the <code>boolean</code> value read.
|
||||
* @return the {@code boolean} value read.
|
||||
* @throws EOFException if the end of the underlying input stream
|
||||
* has been reached
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
@ -129,10 +129,10 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads a signed <code>byte</code> from the underlying input stream
|
||||
* Reads a signed {@code byte} from the underlying input stream
|
||||
* with value between -128 and 127
|
||||
*
|
||||
* @return the <code>byte</code> value read.
|
||||
* @return the {@code byte} value read.
|
||||
* @throws EOFException if the end of the underlying input stream
|
||||
* has been reached
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
@ -147,10 +147,10 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads an unsigned <code>byte</code> from the underlying
|
||||
* Reads an unsigned {@code byte} from the underlying
|
||||
* input stream with value between 0 and 255
|
||||
*
|
||||
* @return the <code>byte</code> value read.
|
||||
* @return the {@code byte} value read.
|
||||
* @throws EOFException if the end of the underlying input
|
||||
* stream has been reached
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
@ -164,10 +164,10 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads a two byte signed <code>short</code> from the underlying
|
||||
* Reads a two byte signed {@code short} from the underlying
|
||||
* input stream in little endian order, low byte first.
|
||||
*
|
||||
* @return the <code>short</code> read.
|
||||
* @return the {@code short} read.
|
||||
* @throws EOFException if the end of the underlying input stream
|
||||
* has been reached
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
@ -184,7 +184,7 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads a two byte unsigned <code>short</code> from the underlying
|
||||
* Reads a two byte unsigned {@code short} from the underlying
|
||||
* input stream in little endian order, low byte first.
|
||||
*
|
||||
* @return the int value of the unsigned short read.
|
||||
@ -203,7 +203,7 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads a two byte Unicode <code>char</code> from the underlying
|
||||
* Reads a two byte Unicode {@code char} from the underlying
|
||||
* input stream in little endian order, low byte first.
|
||||
*
|
||||
* @return the int value of the unsigned short read.
|
||||
@ -222,10 +222,10 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
|
||||
|
||||
|
||||
/**
|
||||
* Reads a four byte signed <code>int</code> from the underlying
|
||||
* Reads a four byte signed {@code int} from the underlying
|
||||
* input stream in little endian order, low byte first.
|
||||
*
|
||||
* @return the <code>int</code> read.
|
||||
* @return the {@code int} read.
|
||||
* @throws EOFException if the end of the underlying input stream
|
||||
* has been reached
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
@ -244,10 +244,10 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads an eight byte signed <code>int</code> from the underlying
|
||||
* Reads an eight byte signed {@code int} from the underlying
|
||||
* input stream in little endian order, low byte first.
|
||||
*
|
||||
* @return the <code>int</code> read.
|
||||
* @return the {@code int} read.
|
||||
* @throws EOFException if the end of the underlying input stream
|
||||
* has been reached
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
@ -343,7 +343,7 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
|
||||
|
||||
/**
|
||||
* @return the next eight bytes of this input stream, interpreted as a
|
||||
* little endian <code>double</code>.
|
||||
* little endian {@code double}.
|
||||
* @throws EOFException if end of stream occurs before eight bytes
|
||||
* have been read.
|
||||
* @throws IOException if an I/O error occurs.
|
||||
@ -354,7 +354,7 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
|
||||
|
||||
/**
|
||||
* @return the next four bytes of this input stream, interpreted as a
|
||||
* little endian <code>int</code>.
|
||||
* little endian {@code int}.
|
||||
* @throws EOFException if end of stream occurs before four bytes
|
||||
* have been read.
|
||||
* @throws IOException if an I/O error occurs.
|
||||
@ -374,8 +374,8 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
|
||||
* @param pos the offset position, measured in bytes from the
|
||||
* beginning of the file, at which to set the file
|
||||
* pointer.
|
||||
* @exception IOException if <code>pos</code> is less than
|
||||
* <code>0</code> or if an I/O error occurs.
|
||||
* @exception IOException if {@code pos} is less than
|
||||
* {@code 0} or if an I/O error occurs.
|
||||
*/
|
||||
public void seek(final long pos) throws IOException {
|
||||
mFile.seek(pos);
|
||||
@ -402,11 +402,11 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes a <code>boolean</code> to the underlying output stream as
|
||||
* Writes a {@code boolean} to the underlying output stream as
|
||||
* a single byte. If the argument is true, the byte value 1 is written.
|
||||
* If the argument is false, the byte value <code>0</code> in written.
|
||||
* If the argument is false, the byte value {@code 0} in written.
|
||||
*
|
||||
* @param pBoolean the <code>boolean</code> value to be written.
|
||||
* @param pBoolean the {@code boolean} value to be written.
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
*/
|
||||
public void writeBoolean(boolean pBoolean) throws IOException {
|
||||
@ -419,9 +419,9 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes out a <code>byte</code> to the underlying output stream
|
||||
* Writes out a {@code byte} to the underlying output stream
|
||||
*
|
||||
* @param pByte the <code>byte</code> value to be written.
|
||||
* @param pByte the {@code byte} value to be written.
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
*/
|
||||
public void writeByte(int pByte) throws IOException {
|
||||
@ -429,10 +429,10 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes a two byte <code>short</code> to the underlying output stream in
|
||||
* Writes a two byte {@code short} to the underlying output stream in
|
||||
* little endian order, low byte first.
|
||||
*
|
||||
* @param pShort the <code>short</code> to be written.
|
||||
* @param pShort the {@code short} to be written.
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
*/
|
||||
public void writeShort(int pShort) throws IOException {
|
||||
@ -441,10 +441,10 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes a two byte <code>char</code> to the underlying output stream
|
||||
* Writes a two byte {@code char} to the underlying output stream
|
||||
* in little endian order, low byte first.
|
||||
*
|
||||
* @param pChar the <code>char</code> value to be written.
|
||||
* @param pChar the {@code char} value to be written.
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
*/
|
||||
public void writeChar(int pChar) throws IOException {
|
||||
@ -453,10 +453,10 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes a four-byte <code>int</code> to the underlying output stream
|
||||
* Writes a four-byte {@code int} to the underlying output stream
|
||||
* in little endian order, low byte first, high byte last
|
||||
*
|
||||
* @param pInt the <code>int</code> to be written.
|
||||
* @param pInt the {@code int} to be written.
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
*/
|
||||
public void writeInt(int pInt) throws IOException {
|
||||
@ -468,10 +468,10 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes an eight-byte <code>long</code> to the underlying output stream
|
||||
* Writes an eight-byte {@code long} to the underlying output stream
|
||||
* in little endian order, low byte first, high byte last
|
||||
*
|
||||
* @param pLong the <code>long</code> to be written.
|
||||
* @param pLong the {@code long} to be written.
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
*/
|
||||
public void writeLong(long pLong) throws IOException {
|
||||
@ -489,7 +489,7 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
|
||||
* Writes a 4 byte Java float to the underlying output stream in
|
||||
* little endian order.
|
||||
*
|
||||
* @param f the <code>float</code> value to be written.
|
||||
* @param f the {@code float} value to be written.
|
||||
* @throws IOException if an I/O error occurs.
|
||||
*/
|
||||
public final void writeFloat(float f) throws IOException {
|
||||
@ -500,7 +500,7 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
|
||||
* Writes an 8 byte Java double to the underlying output stream in
|
||||
* little endian order.
|
||||
*
|
||||
* @param d the <code>double</code> value to be written.
|
||||
* @param d the {@code double} value to be written.
|
||||
* @throws IOException if an I/O error occurs.
|
||||
*/
|
||||
public final void writeDouble(double d) throws IOException {
|
||||
@ -510,9 +510,9 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
|
||||
/**
|
||||
* Writes a string to the underlying output stream as a sequence of
|
||||
* bytes. Each character is written to the data output stream as
|
||||
* if by the <code>writeByte()</code> method.
|
||||
* if by the {@code writeByte()} method.
|
||||
*
|
||||
* @param pString the <code>String</code> value to be written.
|
||||
* @param pString the {@code String} value to be written.
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
* @see #writeByte(int)
|
||||
* @see #mFile
|
||||
@ -527,9 +527,9 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
|
||||
/**
|
||||
* Writes a string to the underlying output stream as a sequence of
|
||||
* characters. Each character is written to the data output stream as
|
||||
* if by the <code>writeChar</code> method.
|
||||
* if by the {@code writeChar} method.
|
||||
*
|
||||
* @param pString a <code>String</code> value to be written.
|
||||
* @param pString a {@code String} value to be written.
|
||||
* @throws IOException if the underlying stream throws an IOException.
|
||||
* @see #writeChar(int)
|
||||
* @see #mFile
|
||||
|
@ -95,17 +95,17 @@ final class Win32File extends File {
|
||||
}
|
||||
|
||||
/**
|
||||
* Wraps a <tt>File</tt> object pointing to a Windows symbolic link
|
||||
* (<tt>.lnk</tt> file) in a <tt>Win32Lnk</tt>.
|
||||
* Wraps a {@code File} object pointing to a Windows symbolic link
|
||||
* ({@code .lnk} file) in a {@code Win32Lnk}.
|
||||
* If the operating system is not Windows, the
|
||||
* <tt>pPath</tt> parameter is returned unwrapped.
|
||||
* {@code pPath} parameter is returned unwrapped.
|
||||
*
|
||||
* @param pPath any path, possibly pointing to a Windows symbolic link file.
|
||||
* May be <tt>null</tt>, in which case <tt>null</tt> is returned.
|
||||
* May be {@code null}, in which case {@code null} is returned.
|
||||
*
|
||||
* @return a new <tt>Win32Lnk</tt> object if the current os is Windows, and
|
||||
* the file is a Windows symbolic link (<tt>.lnk</tt> file), otherwise
|
||||
* <tt>pPath</tt>
|
||||
* @return a new {@code Win32Lnk} object if the current os is Windows, and
|
||||
* the file is a Windows symbolic link ({@code .lnk} file), otherwise
|
||||
* {@code pPath}
|
||||
*/
|
||||
public static File wrap(final File pPath) {
|
||||
if (pPath == null) {
|
||||
@ -138,15 +138,15 @@ final class Win32File extends File {
|
||||
}
|
||||
|
||||
/**
|
||||
* Wraps a <tt>File</tt> array, possibly pointing to Windows symbolic links
|
||||
* (<tt>.lnk</tt> files) in <tt>Win32Lnk</tt>s.
|
||||
* Wraps a {@code File} array, possibly pointing to Windows symbolic links
|
||||
* ({@code .lnk} files) in {@code Win32Lnk}s.
|
||||
*
|
||||
* @param pPaths an array of <tt>File</tt>s, possibly pointing to Windows
|
||||
* @param pPaths an array of {@code File}s, possibly pointing to Windows
|
||||
* symbolic link files.
|
||||
* May be <tt>null</tt>, in which case <tt>null</tt> is returned.
|
||||
* May be {@code null}, in which case {@code null} is returned.
|
||||
*
|
||||
* @return <tt>pPaths</tt>, with any <tt>File</tt> representing a Windows
|
||||
* symbolic link (<tt>.lnk</tt> file) wrapped in a <tt>Win32Lnk</tt>.
|
||||
* @return {@code pPaths}, with any {@code File} representing a Windows
|
||||
* symbolic link ({@code .lnk} file) wrapped in a {@code Win32Lnk}.
|
||||
*/
|
||||
public static File[] wrap(File[] pPaths) {
|
||||
if (IS_WINDOWS) {
|
||||
|
@ -1,7 +0,0 @@
|
||||
<HTML>
|
||||
|
||||
<BODY>
|
||||
Provides for system input and output through data streams, serialization and the file system.
|
||||
</BODY>
|
||||
|
||||
</HTML>
|
4
twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/package_info.java
Executable file
4
twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/package_info.java
Executable file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
* Provides for system input and output through data streams, serialization and the file system.
|
||||
*/
|
||||
package com.twelvemonkeys.io;
|
@ -1,7 +0,0 @@
|
||||
- Remove util.BASE64, make clients use io.Base64.
|
||||
- Create subpackages
|
||||
io.base64
|
||||
io.lzw
|
||||
io.packbits
|
||||
io.zip
|
||||
|
@ -537,10 +537,10 @@ public final class BeanUtil {
|
||||
|
||||
/**
|
||||
* Configures the bean according to the given mapping.
|
||||
* For each <CODE>Map.Entry</CODE> in <CODE>Map.values()</CODE>,
|
||||
* For each {@code Map.Entry} in {@code Map.values()},
|
||||
* a method named
|
||||
* <CODE>set + capitalize(entry.getKey())</CODE> is called on the bean,
|
||||
* with <CODE>entry.getValue()</CODE> as its argument.
|
||||
* {@code set + capitalize(entry.getKey())} is called on the bean,
|
||||
* with {@code entry.getValue()} as its argument.
|
||||
* <p/>
|
||||
* Properties that has no matching set-method in the bean, are simply
|
||||
* discarded.
|
||||
@ -562,10 +562,10 @@ public final class BeanUtil {
|
||||
|
||||
/**
|
||||
* Configures the bean according to the given mapping.
|
||||
* For each <CODE>Map.Entry</CODE> in <CODE>Map.values()</CODE>,
|
||||
* For each {@code Map.Entry} in {@code Map.values()},
|
||||
* a method named
|
||||
* <CODE>set + capitalize(entry.getKey())</CODE> is called on the bean,
|
||||
* with <CODE>entry.getValue()</CODE> as its argument.
|
||||
* {@code set + capitalize(entry.getKey())} is called on the bean,
|
||||
* with {@code entry.getValue()} as its argument.
|
||||
* <p/>
|
||||
* Optionally, lisp-style names are allowed, and automatically converted
|
||||
* to Java-style camel-case names.
|
||||
|
@ -98,7 +98,7 @@ public final class DateUtil {
|
||||
/**
|
||||
* Gets the current time, rounded down to the closest second.
|
||||
* Equivalent to invoking
|
||||
* <tt>roundToSecond(System.currentTimeMillis())</tt>.
|
||||
* {@code roundToSecond(System.currentTimeMillis())}.
|
||||
*
|
||||
* @return the current time, rounded to the closest second.
|
||||
*/
|
||||
@ -109,7 +109,7 @@ public final class DateUtil {
|
||||
/**
|
||||
* Gets the current time, rounded down to the closest minute.
|
||||
* Equivalent to invoking
|
||||
* <tt>roundToMinute(System.currentTimeMillis())</tt>.
|
||||
* {@code roundToMinute(System.currentTimeMillis())}.
|
||||
*
|
||||
* @return the current time, rounded to the closest minute.
|
||||
*/
|
||||
@ -120,7 +120,7 @@ public final class DateUtil {
|
||||
/**
|
||||
* Gets the current time, rounded down to the closest hour.
|
||||
* Equivalent to invoking
|
||||
* <tt>roundToHour(System.currentTimeMillis())</tt>.
|
||||
* {@code roundToHour(System.currentTimeMillis())}.
|
||||
*
|
||||
* @return the current time, rounded to the closest hour.
|
||||
*/
|
||||
@ -131,7 +131,7 @@ public final class DateUtil {
|
||||
/**
|
||||
* Gets the current time, rounded down to the closest day.
|
||||
* Equivalent to invoking
|
||||
* <tt>roundToDay(System.currentTimeMillis())</tt>.
|
||||
* {@code roundToDay(System.currentTimeMillis())}.
|
||||
*
|
||||
* @return the current time, rounded to the closest day.
|
||||
*/
|
||||
|
@ -51,7 +51,7 @@ public final class MathUtil {
|
||||
* Java versions < 1.2 (typically for Applets).
|
||||
*
|
||||
* @param pAngDeg an angle, in degrees
|
||||
* @return the measurement of the angle <code>angdeg</code> in radians.
|
||||
* @return the measurement of the angle {@code angdeg} in radians.
|
||||
*
|
||||
* @see java.lang.Math#toRadians(double)
|
||||
*/
|
||||
@ -66,7 +66,7 @@ public final class MathUtil {
|
||||
* Java versions < 1.2 (typically for Applets).
|
||||
*
|
||||
* @param pAngRad an angle, in radians
|
||||
* @return the measurement of the angle <code>angrad</code> in degrees.
|
||||
* @return the measurement of the angle {@code angrad} in degrees.
|
||||
*
|
||||
* @see java.lang.Math#toDegrees(double)
|
||||
*/
|
||||
@ -76,11 +76,11 @@ public final class MathUtil {
|
||||
|
||||
/**
|
||||
* Returns the natural logarithm (base <I>e</I>) of a double value.
|
||||
* Equivalent to <CODE>java.lang.Math.log</CODE>, just with a proper name.
|
||||
* Equivalent to {@code java.lang.Math.log}, just with a proper name.
|
||||
*
|
||||
* @param pArg a number greater than 0.0.
|
||||
* @return the value ln <CODE>pArg</CODE>, the natural logarithm of
|
||||
* <CODE>pArg</CODE>.
|
||||
* @return the value ln {@code pArg}, the natural logarithm of
|
||||
* {@code pArg}.
|
||||
*
|
||||
* @see java.lang.Math#log(double)
|
||||
*/
|
||||
@ -94,8 +94,8 @@ public final class MathUtil {
|
||||
* Returns the base 10 logarithm of a double value.
|
||||
*
|
||||
* @param pArg a number greater than 0.0.
|
||||
* @return the value log <CODE>pArg</CODE>, the base 10 logarithm of
|
||||
* <CODE>pArg</CODE>.
|
||||
* @return the value log {@code pArg}, the base 10 logarithm of
|
||||
* {@code pArg}.
|
||||
*/
|
||||
public static double log(final double pArg) {
|
||||
return Math.log(pArg) / LN_10;
|
||||
@ -107,8 +107,8 @@ public final class MathUtil {
|
||||
* Returns the base 2 logarithm of a double value.
|
||||
*
|
||||
* @param pArg a number greater than 0.0.
|
||||
* @return the value log<SUB>2</SUB> <CODE>pArg</CODE>, the base 2
|
||||
* logarithm of <CODE>pArg</CODE>.
|
||||
* @return the value log<SUB>2</SUB> {@code pArg}, the base 2
|
||||
* logarithm of {@code pArg}.
|
||||
*/
|
||||
public static double log2(final double pArg) {
|
||||
return Math.log(pArg) / LN_2;
|
||||
@ -121,24 +121,24 @@ public final class MathUtil {
|
||||
* @param pArg a number greater than 0.0.
|
||||
* @param pBase a number greater than 0.0.
|
||||
*
|
||||
* @return the value log<SUB>pBase</SUB> <CODE>pArg</CODE>, the base
|
||||
* <CODE>pBase</CODE> logarithm of <CODE>pArg</CODE>.
|
||||
* @return the value log<SUB>pBase</SUB> {@code pArg}, the base
|
||||
* {@code pBase} logarithm of {@code pArg}.
|
||||
*/
|
||||
public static double log(final double pArg, final double pBase) {
|
||||
return Math.log(pArg) / Math.log(pBase);
|
||||
}
|
||||
|
||||
/**
|
||||
* A replacement for <tt>Math.abs</tt>, that never returns negative values.
|
||||
* <tt>Math.abs(long)</tt> does this for <tt>Long.MIN_VALUE</tt>.
|
||||
* A replacement for {@code Math.abs}, that never returns negative values.
|
||||
* {@code Math.abs(long)} does this for {@code Long.MIN_VALUE}.
|
||||
*
|
||||
* @see Math#abs(long)
|
||||
* @see Long#MIN_VALUE
|
||||
*
|
||||
* @param pNumber
|
||||
* @return the absolute value of <tt>pNumber</tt>
|
||||
* @return the absolute value of {@code pNumber}
|
||||
*
|
||||
* @throws ArithmeticException if <tt>pNumber == Long.MIN_VALUE</tt>
|
||||
* @throws ArithmeticException if {@code pNumber == Long.MIN_VALUE}
|
||||
*/
|
||||
public static long abs(final long pNumber) {
|
||||
if (pNumber == Long.MIN_VALUE) {
|
||||
@ -148,16 +148,16 @@ public final class MathUtil {
|
||||
}
|
||||
|
||||
/**
|
||||
* A replacement for <tt>Math.abs</tt>, that never returns negative values.
|
||||
* <tt>Math.abs(int)</tt> does this for <tt>Integer.MIN_VALUE</tt>.
|
||||
* A replacement for {@code Math.abs}, that never returns negative values.
|
||||
* {@code Math.abs(int)} does this for {@code Integer.MIN_VALUE}.
|
||||
*
|
||||
* @see Math#abs(int)
|
||||
* @see Integer#MIN_VALUE
|
||||
*
|
||||
* @param pNumber
|
||||
* @return the absolute value of <tt>pNumber</tt>
|
||||
* @return the absolute value of {@code pNumber}
|
||||
*
|
||||
* @throws ArithmeticException if <tt>pNumber == Integer.MIN_VALUE</tt>
|
||||
* @throws ArithmeticException if {@code pNumber == Integer.MIN_VALUE}
|
||||
*/
|
||||
public static int abs(final int pNumber) {
|
||||
if (pNumber == Integer.MIN_VALUE) {
|
||||
|
@ -49,7 +49,7 @@ public final class ReflectUtil {
|
||||
*
|
||||
* @return the primitive type
|
||||
*
|
||||
* @throws IllegalArgumentException if <tt>pType</tt> is not a primitive
|
||||
* @throws IllegalArgumentException if {@code pType} is not a primitive
|
||||
* wrapper
|
||||
*/
|
||||
public static Class unwrapType(Class pType) {
|
||||
@ -88,7 +88,7 @@ public final class ReflectUtil {
|
||||
*
|
||||
* @return the wrapper type
|
||||
*
|
||||
* @throws IllegalArgumentException if <tt>pType</tt> is not a primitive
|
||||
* @throws IllegalArgumentException if {@code pType} is not a primitive
|
||||
* type
|
||||
*/
|
||||
public static Class wrapType(Class pType) {
|
||||
@ -121,12 +121,12 @@ public final class ReflectUtil {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if the given type is a primitive wrapper.
|
||||
* Returns {@code true} if the given type is a primitive wrapper.
|
||||
*
|
||||
* @param pType
|
||||
*
|
||||
* @return <tt>true</tt> if the given type is a primitive wrapper, otherwise
|
||||
* <tt>false</tt>
|
||||
* @return {@code true} if the given type is a primitive wrapper, otherwise
|
||||
* {@code false}
|
||||
*/
|
||||
public static boolean isPrimitiveWrapper(Class pType) {
|
||||
return pType == Boolean.class || pType == Byte.class
|
||||
|
@ -1,7 +0,0 @@
|
||||
<HTML>
|
||||
|
||||
<BODY>
|
||||
Contains utils/helpers for classes in {@code java.lang}.
|
||||
</BODY>
|
||||
|
||||
</HTML>
|
@ -0,0 +1,4 @@
|
||||
/**
|
||||
*Contains utils/helpers for classes in {@code java.lang}.
|
||||
*/
|
||||
package com.twelvemonkeys.lang;
|
@ -127,7 +127,7 @@ public class HttpURLConnection extends java.net.HttpURLConnection {
|
||||
* properties to be appended into a single property.
|
||||
*
|
||||
* @param pKey the keyword by which the request is known
|
||||
* (e.g., "<code>accept</code>").
|
||||
* (e.g., "{@code accept}").
|
||||
* @param pValue the value associated with it.
|
||||
* @see #getRequestProperty(java.lang.String)
|
||||
*/
|
||||
@ -208,7 +208,7 @@ public class HttpURLConnection extends java.net.HttpURLConnection {
|
||||
* Returns the name of the specified header field.
|
||||
*
|
||||
* @param pName the name of a header field.
|
||||
* @return the value of the named header field, or <code>null</code>
|
||||
* @return the value of the named header field, or {@code null}
|
||||
* if there is no such field in the header.
|
||||
*/
|
||||
public String getHeaderField(String pName) {
|
||||
@ -216,16 +216,16 @@ public class HttpURLConnection extends java.net.HttpURLConnection {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the value for the <code>n</code><sup>th</sup> header field.
|
||||
* It returns <code>null</code> if there are fewer than
|
||||
* <code>n</code> fields.
|
||||
* Returns the value for the {@code n}<sup>th</sup> header field.
|
||||
* It returns {@code null} if there are fewer than
|
||||
* {@code n} fields.
|
||||
* <p/>
|
||||
* This method can be used in conjunction with the
|
||||
* <code>getHeaderFieldKey</code> method to iterate through all
|
||||
* {@code getHeaderFieldKey} method to iterate through all
|
||||
* the headers in the message.
|
||||
*
|
||||
* @param pIndex an index.
|
||||
* @return the value of the <code>n</code><sup>th</sup> header field.
|
||||
* @return the value of the {@code n}<sup>th</sup> header field.
|
||||
* @see java.net.URLConnection#getHeaderFieldKey(int)
|
||||
*/
|
||||
public String getHeaderField(int pIndex) {
|
||||
@ -247,11 +247,11 @@ public class HttpURLConnection extends java.net.HttpURLConnection {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the key for the <code>n</code><sup>th</sup> header field.
|
||||
* Returns the key for the {@code n}<sup>th</sup> header field.
|
||||
*
|
||||
* @param pIndex an index.
|
||||
* @return the key for the <code>n</code><sup>th</sup> header field,
|
||||
* or <code>null</code> if there are fewer than <code>n</code>
|
||||
* @return the key for the {@code n}<sup>th</sup> header field,
|
||||
* or {@code null} if there are fewer than {@code n}
|
||||
* fields.
|
||||
*/
|
||||
public String getHeaderFieldKey(int pIndex) {
|
||||
@ -641,9 +641,9 @@ public class HttpURLConnection extends java.net.HttpURLConnection {
|
||||
* Opens a communications link to the resource referenced by this
|
||||
* URL, if such a connection has not already been established.
|
||||
* <p/>
|
||||
* If the <code>connect</code> method is called when the connection
|
||||
* has already been opened (indicated by the <code>connected</code>
|
||||
* field having the value <code>true</code>), the call is ignored.
|
||||
* If the {@code connect} method is called when the connection
|
||||
* has already been opened (indicated by the {@code connected}
|
||||
* field having the value {@code true}), the call is ignored.
|
||||
* <p/>
|
||||
* URLConnection objects go through two phases: first they are
|
||||
* created, then they are connected. After being created, and
|
||||
@ -1062,7 +1062,7 @@ public class HttpURLConnection extends java.net.HttpURLConnection {
|
||||
|
||||
/**
|
||||
* Reads the chunk size from the chunk header
|
||||
* <CODE>chunk-size [SP chunk-extension] CRLF</CODE>.
|
||||
* {@code chunk-size [SP chunk-extension] CRLF}.
|
||||
* The chunk-extension is simply discarded.
|
||||
*
|
||||
* @return the length of the current chunk, or -1 if the current chunk
|
||||
|
@ -37,7 +37,7 @@ import java.util.Hashtable;
|
||||
/**
|
||||
* A simple Authenticator implementation.
|
||||
* Singleton class, obtain reference through the static
|
||||
* <CODE>getInstance</CODE> method.
|
||||
* {@code getInstance} method.
|
||||
* <P>
|
||||
* <EM>After swearing, sweating, pulling my hair, banging my head repeatedly
|
||||
* into the walls and reading the java.net.Authenticator API documentation
|
||||
|
@ -1,7 +0,0 @@
|
||||
<HTML>
|
||||
|
||||
<BODY>
|
||||
Provides classes for net access.
|
||||
</BODY>
|
||||
|
||||
</HTML>
|
4
twelvemonkeys-core/src/main/java/com/twelvemonkeys/net/package_info.java
Executable file
4
twelvemonkeys-core/src/main/java/com/twelvemonkeys/net/package_info.java
Executable file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
* Provides classes for net access.
|
||||
*/
|
||||
package com.twelvemonkeys.net;
|
@ -1,8 +0,0 @@
|
||||
<HTML>
|
||||
|
||||
<BODY>
|
||||
Provides a general purpose conversion framework, for conversion of values
|
||||
between string representations and objects.
|
||||
</BODY>
|
||||
|
||||
</HTML>
|
@ -0,0 +1,5 @@
|
||||
/**
|
||||
* Provides a general purpose conversion framework, for conversion of values
|
||||
* between string representations and objects.
|
||||
*/
|
||||
package com.twelvemonkeys.util.convert;
|
@ -1,7 +0,0 @@
|
||||
<HTML>
|
||||
|
||||
<BODY>
|
||||
Provides miscellaneous utility classes.
|
||||
</BODY>
|
||||
|
||||
</HTML>
|
@ -0,0 +1,4 @@
|
||||
/**
|
||||
* Provides miscellaneous utility classes.
|
||||
*/
|
||||
package com.twelvemonkeys.util;
|
@ -1,10 +0,0 @@
|
||||
<HTML>
|
||||
|
||||
<BODY>
|
||||
Provides functionality for regular expressions. This package contains a drop-in
|
||||
replacement for java.util.regex that will work on JDK1.2+.
|
||||
Plese see {@link Pattern} for more information on runtime dependencies and
|
||||
configuration.
|
||||
</BODY>
|
||||
|
||||
</HTML>
|
@ -0,0 +1,4 @@
|
||||
/**
|
||||
* Provides functionality for regular expressions.
|
||||
*/
|
||||
package com.twelvemonkeys.util.regex;
|
@ -1,10 +0,0 @@
|
||||
<HTML>
|
||||
|
||||
<BODY>
|
||||
Provides a service provider registry.
|
||||
<p/>
|
||||
This package contains a service provider registry, as specified in the
|
||||
<a href="http://java.sun.com/j2se/1.3/docs/guide/jar/jar.html#Service%20Provider">JAR File Specification</a>.
|
||||
</BODY>
|
||||
|
||||
</HTML>
|
@ -0,0 +1,9 @@
|
||||
/**
|
||||
* Provides a service provider registry.
|
||||
* <p/>
|
||||
* This package contains a service provider registry, as specified in the
|
||||
* <a href="http://java.sun.com/j2se/1.3/docs/guide/jar/jar.html#Service%20Provider">JAR File Specification</a>.
|
||||
*
|
||||
* @see <a href="http://java.sun.com/j2se/1.3/docs/guide/jar/jar.html#Service%20Provider">JAR File Specification</a>
|
||||
*/
|
||||
package com.twelvemonkeys.util.service;
|
@ -0,0 +1,4 @@
|
||||
/**
|
||||
* Provides XML support classes.
|
||||
*/
|
||||
package com.twelvemonkeys.xml;
|
@ -21,7 +21,7 @@ public abstract class ObjectAbstractTestCase extends TestCase {
|
||||
// TODO: Create Comparable test similar way
|
||||
|
||||
/**
|
||||
* Creates a <tt>TestCase</tt>.
|
||||
* Creates a {@code TestCase}.
|
||||
*
|
||||
* @param testName the test class name
|
||||
*/
|
||||
@ -216,7 +216,7 @@ public abstract class ObjectAbstractTestCase extends TestCase {
|
||||
}
|
||||
|
||||
/**
|
||||
* Sanity check method, makes sure that any <tt>Serializable</tt>
|
||||
* Sanity check method, makes sure that any {@code Serializable}
|
||||
* class can be serialized and de-serialized in memory,
|
||||
* using the handy makeObject() method
|
||||
*
|
||||
@ -306,7 +306,7 @@ public abstract class ObjectAbstractTestCase extends TestCase {
|
||||
|
||||
public static final class SanityTestTestCase extends ObjectAbstractTestCase {
|
||||
/**
|
||||
* Creates a <tt>TestCase</tt>.
|
||||
* Creates a {@code TestCase}.
|
||||
*
|
||||
*/
|
||||
public SanityTestTestCase() {
|
||||
|
@ -29,7 +29,7 @@ import java.util.*;
|
||||
* <b>Element Population Methods</b>
|
||||
* <p>
|
||||
* Override these if your collection restricts what kind of elements are
|
||||
* allowed (for instance, if <code>null</code> is not permitted):
|
||||
* allowed (for instance, if {@code null} is not permitted):
|
||||
* <ul>
|
||||
* <li>{@link #getFullElements()}
|
||||
* <li>{@link #getOtherElements()}
|
||||
@ -52,12 +52,12 @@ import java.util.*;
|
||||
* for the collection. Basically, the operation is performed against your
|
||||
* collection implementation, and an identical operation is performed against a
|
||||
* <i>confirmed</i> collection implementation. A confirmed collection
|
||||
* implementation is something like <code>java.util.ArrayList</code>, which is
|
||||
* implementation is something like {@code java.util.ArrayList}, which is
|
||||
* known to conform exactly to its collection interface's contract. After the
|
||||
* operation takes place on both your collection implementation and the
|
||||
* confirmed collection implementation, the two collections are compared to see
|
||||
* if their state is identical. The comparison is usually much more involved
|
||||
* than a simple <code>equals</code> test. This verification is used to ensure
|
||||
* than a simple {@code equals} test. This verification is used to ensure
|
||||
* proper modifications are made along with ensuring that the collection does
|
||||
* not change when read-only modifications are made.
|
||||
* <p>
|
||||
@ -164,7 +164,7 @@ public abstract class CollectionAbstractTestCase extends ObjectAbstractTestCase
|
||||
/**
|
||||
* Returns true if the collections produced by
|
||||
* {@link #makeCollection()} and {@link #makeFullCollection()}
|
||||
* support the <code>add</code> and <code>addAll</code>
|
||||
* support the {@code add} and {@code addAll}
|
||||
* operations.<P>
|
||||
* Default implementation returns true. Override if your collection
|
||||
* class does not support add or addAll.
|
||||
@ -176,9 +176,9 @@ public abstract class CollectionAbstractTestCase extends ObjectAbstractTestCase
|
||||
/**
|
||||
* Returns true if the collections produced by
|
||||
* {@link #makeCollection()} and {@link #makeFullCollection()}
|
||||
* support the <code>remove</code>, <code>removeAll</code>,
|
||||
* <code>retainAll</code>, <code>clear</code> and
|
||||
* <code>iterator().remove()</code> methods.
|
||||
* support the {@code remove}, {@code removeAll},
|
||||
* {@code retainAll}, {@code clear} and
|
||||
* {@code iterator().remove()} methods.
|
||||
* Default implementation returns true. Override if your collection
|
||||
* class does not support removal operations.
|
||||
*/
|
||||
@ -334,7 +334,7 @@ public abstract class CollectionAbstractTestCase extends ObjectAbstractTestCase
|
||||
* Returns a full collection to be used for testing. The collection
|
||||
* returned by this method should contain every element returned by
|
||||
* {@link #getFullElements()}. The default implementation, in fact,
|
||||
* simply invokes <code>addAll</code> on an empty collection with
|
||||
* simply invokes {@code addAll} on an empty collection with
|
||||
* the results of {@link #getFullElements()}. Override this default
|
||||
* if your collection doesn't support addAll.
|
||||
*/
|
||||
@ -1125,7 +1125,7 @@ public abstract class CollectionAbstractTestCase extends ObjectAbstractTestCase
|
||||
|
||||
|
||||
/**
|
||||
* Tests <code>toString</code> on a collection.
|
||||
* Tests {@code toString} on a collection.
|
||||
*/
|
||||
public void testCollectionToString() {
|
||||
resetEmpty();
|
||||
|
@ -64,7 +64,7 @@ import java.util.*;
|
||||
* collection views. Basically, the modification is performed against your
|
||||
* map implementation, and an identical modification is performed against
|
||||
* a <I>confirmed</I> map implementation. A confirmed map implementation is
|
||||
* something like <Code>java.util.HashMap</Code>, which is known to conform
|
||||
* something like {@code java.util.HashMap}, which is known to conform
|
||||
* exactly to the {@link Map} contract. After the modification takes place
|
||||
* on both your map implementation and the confirmed map implementation, the
|
||||
* two maps are compared to see if their state is identical. The comparison
|
||||
@ -99,7 +99,7 @@ import java.util.*;
|
||||
* this base set of cases. Simply override the test case (method) your map
|
||||
* fails and/or the methods that define the assumptions used by the test
|
||||
* cases. For example, if your map does not allow duplicate values, override
|
||||
* {@link #isAllowDuplicateValues()} and have it return <code>false</code>
|
||||
* {@link #isAllowDuplicateValues()} and have it return {@code false}
|
||||
*
|
||||
* @author Michael Smith
|
||||
* @author Rodney Waldhoff
|
||||
@ -151,7 +151,7 @@ public abstract class MapAbstractTestCase extends ObjectAbstractTestCase {
|
||||
/**
|
||||
* Returns true if the maps produced by
|
||||
* {@link #makeEmptyMap()} and {@link #makeFullMap()}
|
||||
* support the <code>put</code> and <code>putAll</code> operations
|
||||
* support the {@code put} and {@code putAll} operations
|
||||
* adding new mappings.
|
||||
* <p>
|
||||
* Default implementation returns true.
|
||||
@ -164,7 +164,7 @@ public abstract class MapAbstractTestCase extends ObjectAbstractTestCase {
|
||||
/**
|
||||
* Returns true if the maps produced by
|
||||
* {@link #makeEmptyMap()} and {@link #makeFullMap()}
|
||||
* support the <code>put</code> and <code>putAll</code> operations
|
||||
* support the {@code put} and {@code putAll} operations
|
||||
* changing existing mappings.
|
||||
* <p>
|
||||
* Default implementation returns true.
|
||||
@ -177,7 +177,7 @@ public abstract class MapAbstractTestCase extends ObjectAbstractTestCase {
|
||||
/**
|
||||
* Returns true if the maps produced by
|
||||
* {@link #makeEmptyMap()} and {@link #makeFullMap()}
|
||||
* support the <code>setValue</code> operation on entrySet entries.
|
||||
* support the {@code setValue} operation on entrySet entries.
|
||||
* <p>
|
||||
* Default implementation returns isPutChangeSupported().
|
||||
* Override if your collection class does not support setValue but does
|
||||
@ -190,7 +190,7 @@ public abstract class MapAbstractTestCase extends ObjectAbstractTestCase {
|
||||
/**
|
||||
* Returns true if the maps produced by
|
||||
* {@link #makeEmptyMap()} and {@link #makeFullMap()}
|
||||
* support the <code>remove</code> and <code>clear</code> operations.
|
||||
* support the {@code remove} and {@code clear} operations.
|
||||
* <p>
|
||||
* Default implementation returns true.
|
||||
* Override if your collection class does not support removal operations.
|
||||
@ -263,7 +263,7 @@ public abstract class MapAbstractTestCase extends ObjectAbstractTestCase {
|
||||
* method must return an array with the same length as {@link
|
||||
* #getSampleValues()} and all array elements must be different. The
|
||||
* default implementation constructs a set of String keys, and includes a
|
||||
* single null key if {@link #isAllowNullKey()} returns <code>true</code>.
|
||||
* single null key if {@link #isAllowNullKey()} returns {@code true}.
|
||||
*/
|
||||
public Object[] getSampleKeys() {
|
||||
Object[] result = new Object[] {
|
||||
@ -305,9 +305,9 @@ public abstract class MapAbstractTestCase extends ObjectAbstractTestCase {
|
||||
* method must return an array with the same length as
|
||||
* {@link #getSampleKeys()}. The default implementation constructs a set of
|
||||
* String values and includes a single null value if
|
||||
* {@link #isAllowNullValue()} returns <code>true</code>, and includes
|
||||
* {@link #isAllowNullValue()} returns {@code true}, and includes
|
||||
* two values that are the same if {@link #isAllowDuplicateValues()} returns
|
||||
* <code>true</code>.
|
||||
* {@code true}.
|
||||
*/
|
||||
public Object[] getSampleValues() {
|
||||
Object[] result = new Object[] {
|
||||
@ -327,9 +327,9 @@ public abstract class MapAbstractTestCase extends ObjectAbstractTestCase {
|
||||
* returned from this method should not be the same as those returned from
|
||||
* {@link #getSampleValues()}. The default implementation constructs a
|
||||
* set of String values and includes a single null value if
|
||||
* {@link #isAllowNullValue()} returns <code>true</code>, and includes two values
|
||||
* {@link #isAllowNullValue()} returns {@code true}, and includes two values
|
||||
* that are the same if {@link #isAllowDuplicateValues()} returns
|
||||
* <code>true</code>.
|
||||
* {@code true}.
|
||||
*/
|
||||
public Object[] getNewSampleValues() {
|
||||
Object[] result = new Object[] {
|
||||
@ -1548,10 +1548,10 @@ public abstract class MapAbstractTestCase extends ObjectAbstractTestCase {
|
||||
* Verifies that {@link #map} is still equal to {@link #confirmed}.
|
||||
* This method checks that the map is equal to the HashMap,
|
||||
* <I>and</I> that the map's collection views are still equal to
|
||||
* the HashMap's collection views. An <Code>equals</Code> test
|
||||
* the HashMap's collection views. An {@code equals} test
|
||||
* is done on the maps and their collection views; their size and
|
||||
* <Code>isEmpty</Code> results are compared; their hashCodes are
|
||||
* compared; and <Code>containsAll</Code> tests are run on the
|
||||
* {@code isEmpty} results are compared; their hashCodes are
|
||||
* compared; and {@code containsAll} tests are run on the
|
||||
* collection views.
|
||||
*/
|
||||
public void verifyAll() {
|
||||
|
@ -197,7 +197,7 @@ public abstract class ObjectAbstractTestCase extends MockObjectTestCase {
|
||||
* Subclasses can override this variable, indicating compatibility
|
||||
* with earlier Collections versions.
|
||||
*
|
||||
* @return The version, or <code>null</code> if this object shouldn't be
|
||||
* @return The version, or {@code null} if this object shouldn't be
|
||||
* tested for compatibility with previous versions.
|
||||
*/
|
||||
public String getCompatibilityVersion() {
|
||||
|
@ -1,4 +1,6 @@
|
||||
- Rename core to common
|
||||
- Remove util.BASE64, make clients use io.Base64.
|
||||
|
||||
- Rename core to common?
|
||||
- Split up into three sub modules?
|
||||
- common-core
|
||||
- lang
|
||||
|
@ -1,13 +0,0 @@
|
||||
JMagick plugin for ImageIO that uses JMagick, an open source Java interface for
|
||||
ImageMagick to read and write images.
|
||||
<p/>
|
||||
<!-- TODO: Describe the formats available -->
|
||||
<small>
|
||||
Note: The plugin relies on JMagick, which ues JNI and native code. You need
|
||||
to have the JMagick and ImageMagick shared libraries (or DLLs) in Java's
|
||||
<tt>java.library.path</tt> for this plugin to work.
|
||||
</small>
|
||||
<p/>
|
||||
See <a href="http://www.imagemagick.org/">ImageMagick homepage</a>
|
||||
or <a href="http://www.yeo.id.au/jmagick/">JMagick homepage</a>
|
||||
for more information.
|
@ -0,0 +1,15 @@
|
||||
/**
|
||||
* JMagick plugin for ImageIO that uses JMagick, an open source Java interface for
|
||||
* ImageMagick to read and write images.
|
||||
* <p/>
|
||||
* <!-- TODO: Describe the formats available -->
|
||||
* <small>
|
||||
* Note: The plugin relies on JMagick, which ues JNI and native code. You need
|
||||
* to have the JMagick and ImageMagick shared libraries (or DLLs) in Java's
|
||||
* {@code java.library.path} for this plugin to work.
|
||||
* </small>
|
||||
* <p/>
|
||||
* @see <a href="http://www.imagemagick.org/">ImageMagick homepage</a>
|
||||
* @see <a href="http://www.yeo.id.au/jmagick/">JMagick homepage</a>
|
||||
*/
|
||||
package com.twelvemonkeys.imageio.plugins.jmagick;
|
@ -1,38 +0,0 @@
|
||||
<HTML>
|
||||
|
||||
<BODY>
|
||||
Contains various image-outputting servlets, that should run under any servlet engine. To create your own image servlet, simply subclass the servlet
|
||||
<CODE>ImageServlet</CODE>. Optionally implement the interface
|
||||
<CODE>ImagePainterServlet</CODE>, if you want to do painting.
|
||||
<P>
|
||||
Some of these methods may require use of the native graphics libraries
|
||||
supported by the JVM, like the X libraries on Unix systems, and should be
|
||||
run with JRE <STRONG>1.4</STRONG> or later, and with the option:
|
||||
<DL>
|
||||
<DD><CODE>-Djawa.awt.headless=true</CODE></DD>
|
||||
</DL>
|
||||
See the document
|
||||
<A href="http://java.sun.com/j2se/1.4/docs/guide/awt/AWTChanges.html#headless">AWT Enhancements</A> and bugtraq report
|
||||
<A href="http://developer.java.sun.com/developer/bugParade/bugs/4281163.html">4281163</A> for more information on this issue.
|
||||
<P>
|
||||
If you cannot use JRE 1.4 for any reason, or do not want to use the X
|
||||
libraries, a possibilty is to use the
|
||||
<A href="http://www.eteks.com/pja/en/">PJA package</A> (com.eteks.pja),
|
||||
and start the JVM with the following options:
|
||||
<DL>
|
||||
<DD><CODE>-Xbootclasspath/a:<path to pja.jar></CODE></DD>
|
||||
<DD><CODE>-Dawt.toolkit=com.eteks.awt.PJAToolkit</CODE></DD>
|
||||
<DD><CODE>-Djava.awt.graphicsenv=com.eteks.java2d.PJAGraphicsEnvironment</CODE></DD>
|
||||
<DD><CODE>-Djava.awt.fonts=<path where True Type fonts files will be loaded from></CODE></DD>
|
||||
</DL>
|
||||
<P>
|
||||
Please note that creation of PNG images (from bytes or URL's) are only
|
||||
supported in JRE 1.3 and later, trying to load them from an earlier version,
|
||||
will result in errors.
|
||||
|
||||
@see com.twelvemonkeys.servlet.image.ImageServlet
|
||||
@see com.twelvemonkeys.servlet.image.ImagePainterServlet
|
||||
|
||||
</BODY>
|
||||
|
||||
</HTML>
|
@ -0,0 +1,34 @@
|
||||
/**
|
||||
* Contains various image-outputting servlets, that should run under any servlet engine. To create your own image servlet, simply subclass the servlet
|
||||
* {@code ImageServlet}. Optionally implement the interface
|
||||
* {@code ImagePainterServlet}, if you want to do painting.
|
||||
* <P>
|
||||
* Some of these methods may require use of the native graphics libraries
|
||||
* supported by the JVM, like the X libraries on Unix systems, and should be
|
||||
* run with JRE <STRONG>1.4</STRONG> or later, and with the option:
|
||||
* <DL>
|
||||
* <DD>{@code -Djawa.awt.headless=true}</DD>
|
||||
* </DL>
|
||||
* See the document
|
||||
* <A href="http://java.sun.com/j2se/1.4/docs/guide/awt/AWTChanges.html#headless">AWT Enhancements</A> and bugtraq report
|
||||
* <A href="http://developer.java.sun.com/developer/bugParade/bugs/4281163.html">4281163</A> for more information on this issue.
|
||||
* <P>
|
||||
* If you cannot use JRE 1.4 for any reason, or do not want to use the X
|
||||
* libraries, a possibilty is to use the
|
||||
* <A href="http://www.eteks.com/pja/en/">PJA package</A> (com.eteks.pja),
|
||||
* and start the JVM with the following options:
|
||||
* <DL>
|
||||
* <DD>{@code -Xbootclasspath/a:<path to pja.jar>}</DD>
|
||||
* <DD>{@code -Dawt.toolkit=com.eteks.awt.PJAToolkit}</DD>
|
||||
* <DD>{@code -Djava.awt.graphicsenv=com.eteks.java2d.PJAGraphicsEnvironment}</DD>
|
||||
* <DD>{@code -Djava.awt.fonts=<path where True Type fonts files will be loaded from>}</DD>
|
||||
* </DL>
|
||||
* <P>
|
||||
* Please note that creation of PNG images (from bytes or URL's) are only
|
||||
* supported in JRE 1.3 and later, trying to load them from an earlier version,
|
||||
* will result in errors.
|
||||
*
|
||||
* @see com.twelvemonkeys.servlet.image.ImageServlet
|
||||
* @see com.twelvemonkeys.servlet.image.ImagePainterServlet
|
||||
*/
|
||||
package com.twelvemonkeys.servlet.image;
|
@ -1,14 +0,0 @@
|
||||
<HTML>
|
||||
|
||||
<BODY>
|
||||
Dynamo Droplet-like functionality for JSP.
|
||||
|
||||
This package is early beta, not for commercial use! :-)
|
||||
Read: The interfaces and classes in this package (and subpackages) will be
|
||||
developed and modified for a while.
|
||||
|
||||
TODO: Insert taglib-descriptor here?
|
||||
|
||||
</BODY>
|
||||
|
||||
</HTML>
|
@ -0,0 +1,10 @@
|
||||
/**
|
||||
* Dynamo Droplet-like functionality for JSP.
|
||||
*
|
||||
* This package is early beta, not for commercial use! :-)
|
||||
* Read: The interfaces and classes in this package (and subpackages) will be
|
||||
* developed and modified for a while.
|
||||
*
|
||||
* TODO: Insert taglib-descriptor here?
|
||||
*/
|
||||
package com.twelvemonkeys.servlet.jsp.droplet;
|
@ -1,7 +0,0 @@
|
||||
<HTML>
|
||||
|
||||
<BODY>
|
||||
JSP
|
||||
</BODY>
|
||||
|
||||
</HTML>
|
@ -0,0 +1,4 @@
|
||||
/**
|
||||
* JSP support.
|
||||
*/
|
||||
package com.twelvemonkeys.servlet.jsp;
|
@ -1,7 +0,0 @@
|
||||
<HTML>
|
||||
|
||||
<BODY>
|
||||
The TwelveMonkeys common TagLib.
|
||||
</BODY>
|
||||
|
||||
</HTML>
|
@ -0,0 +1,4 @@
|
||||
/**
|
||||
* The TwelveMonkeys common TagLib.
|
||||
*/
|
||||
package com.twelvemonkeys.servlet.jsp.taglib;
|
@ -1,7 +0,0 @@
|
||||
<HTML>
|
||||
|
||||
<BODY>
|
||||
Contains servlet support classes.
|
||||
</BODY>
|
||||
|
||||
</HTML>
|
@ -0,0 +1,4 @@
|
||||
/**
|
||||
* Contains servlet support classes.
|
||||
*/
|
||||
package com.twelvemonkeys.servlet;
|
Loading…
x
Reference in New Issue
Block a user