* This method writes the specified byte (passed as an <code>int</code>)
* to the underlying output stream.
*
- * @param b The byte to write, passed as an <code>int</code>.
+ * @param value The <code>byte</code> to write, passed as an <code>int</code>.
*
* @exception IOException If an error occurs.
*/
- public synchronized void write (int b) throws IOException
+ public synchronized void write (int value) throws IOException
{
- out.write(b);
+ out.write (value);
++written;
}
}
/**
- * This method writes a Java <code>boolean</code> to the underlying output
- * stream. For a value of <code>true</code>, 1 is written to the stream.
- * For a value of <code>false</code>, 0 is written.
+ * This method writes a Java boolean value to an output stream. If
+ * <code>value</code> is <code>true</code>, a byte with the value of
+ * 1 will be written, otherwise a byte with the value of 0 will be
+ * written.
*
- * @param b The <code>boolean</code> value to write to the stream
+ * The value written can be read using the <code>readBoolean</code>
+ * method in <code>DataInput</code>.
+ *
+ * @param value The <code>boolean</code> value to write to the stream
*
* @exception IOException If an error occurs
+ *
+ * @see DataInput#readBoolean
*/
- public final void writeBoolean (boolean v) throws IOException
+ public final void writeBoolean (boolean value) throws IOException
{
- write (v ? 1 : 0);
+ write (value ? 1 : 0);
}
/**
- * This method writes a Java <code>byte</code> value to the underlying
- * output stream.
+ * This method writes a Java byte value to an output stream. The
+ * byte to be written will be in the lowest 8 bits of the
+ * <code>int</code> value passed.
+ *
+ * The value written can be read using the <code>readByte</code> or
+ * <code>readUnsignedByte</code> methods in <code>DataInput</code>.
*
- * @param b The <code>byte</code> to write to the stream, passed as
+ * @param value The <code>byte</code> to write to the stream, passed as
* the low eight bits of an <code>int</code>.
*
* @exception IOException If an error occurs
+ *
+ * @see DataInput#readByte
+ * @see DataInput#readUnsignedByte
*/
- public final void writeByte (int v) throws IOException
+ public final void writeByte (int value) throws IOException
{
- write (v & 0xff);
+ write (value & 0xff);
}
/**
- * This method writes a Java <code>short</code> to the stream, high byte
- * first. This method requires two bytes to encode the value.
+ * This method writes a Java short value to an output stream. The
+ * char to be written will be in the lowest 16 bits of the <code>int</code>
+ * value passed. These bytes will be written "big endian". That is,
+ * with the high byte written first in the following manner:
+ * <p>
+ * <code>byte0 = (byte)((value & 0xFF00) >> 8);<br>
+ * byte1 = (byte)(value & 0x00FF);</code>
+ * <p>
+ *
+ * The value written can be read using the <code>readShort</code> and
+ * <code>readUnsignedShort</code> methods in <code>DataInput</code>.
*
- * @param s The <code>short</code> value to write to the stream,
+ * @param value The <code>short</code> value to write to the stream,
* passed as an <code>int</code>.
*
* @exception IOException If an error occurs
+ *
+ * @see DataInput#readShort
+ * @see DataInput#readUnsignedShort
*/
- public final void writeShort (int v) throws IOException
+ public final void writeShort (int value) throws IOException
{
- write ((byte) (0xff & (v >> 8)));
- write ((byte) (0xff & v));
+ write ((byte) (0xff & (value >> 8)));
+ write ((byte) (0xff & value));
}
/**
- * This method writes a single <code>char</code> value to the stream,
- * high byte first.
+ * This method writes a Java char value to an output stream. The
+ * char to be written will be in the lowest 16 bits of the <code>int</code>
+ * value passed. These bytes will be written "big endian". That is,
+ * with the high byte written first in the following manner:
+ * <p>
+ * <code>byte0 = (byte)((value & 0xFF00) >> 8);<br>
+ * byte1 = (byte)(value & 0x00FF);</code>
+ * <p>
+ *
+ * The value written can be read using the <code>readChar</code>
+ * method in <code>DataInput</code>.
*
- * @param c The <code>char</code> value to write,
+ * @param value The <code>char</code> value to write,
* passed as an <code>int</code>.
*
* @exception IOException If an error occurs
+ *
+ * @see DataInput#readChar
*/
- public final void writeChar (int v) throws IOException
+ public final void writeChar (int value) throws IOException
{
- write ((byte) (0xff & (v >> 8)));
- write ((byte) (0xff & v));
+ write ((byte) (0xff & (value >> 8)));
+ write ((byte) (0xff & value));
}
/**
- * This method writes a Java <code>int</code> to the stream, high bytes
- * first. This method requires four bytes to encode the value.
+ * This method writes a Java int value to an output stream. The 4 bytes
+ * of the passed value will be written "big endian". That is, with
+ * the high byte written first in the following manner:
+ * <p>
+ * <code>byte0 = (byte)((value & 0xFF000000) >> 24);<br>
+ * byte1 = (byte)((value & 0x00FF0000) >> 16);<br>
+ * byte2 = (byte)((value & 0x0000FF00) >> 8);<br>
+ * byte3 = (byte)(value & 0x000000FF);</code>
+ * <p>
*
- * @param i The <code>int</code> value to write to the stream.
+ * The value written can be read using the <code>readInt</code>
+ * method in <code>DataInput</code>.
+ *
+ * @param value The <code>int</code> value to write to the stream
*
* @exception IOException If an error occurs
+ *
+ * @see DataInput#readInt
*/
- public final void writeInt (int v) throws IOException
+ public final void writeInt (int value) throws IOException
{
- write ((byte) (0xff & (v >> 24)));
- write ((byte) (0xff & (v >> 16)));
- write ((byte) (0xff & (v >> 8)));
- write ((byte) (0xff & v));
+ write ((byte) (0xff & (value >> 24)));
+ write ((byte) (0xff & (value >> 16)));
+ write ((byte) (0xff & (value >> 8)));
+ write ((byte) (0xff & value));
}
/**
- * This method writes a Java <code>long</code> to the stream, high bytes
- * first. This method requires eight bytes to encode the value.
+ * This method writes a Java long value to an output stream. The 8 bytes
+ * of the passed value will be written "big endian". That is, with
+ * the high byte written first in the following manner:
+ * <p>
+ * <code>byte0 = (byte)((value & 0xFF00000000000000L) >> 56);<br>
+ * byte1 = (byte)((value & 0x00FF000000000000L) >> 48);<br>
+ * byte2 = (byte)((value & 0x0000FF0000000000L) >> 40);<br>
+ * byte3 = (byte)((value & 0x000000FF00000000L) >> 32);<br>
+ * byte4 = (byte)((value & 0x00000000FF000000L) >> 24);<br>
+ * byte5 = (byte)((value & 0x0000000000FF0000L) >> 16);<br>
+ * byte6 = (byte)((value & 0x000000000000FF00L) >> 8);<br>
+ * byte7 = (byte)(value & 0x00000000000000FFL);</code>
+ * <p>
*
- * @param l The <code>long</code> value to write to the stream.
+ * The value written can be read using the <code>readLong</code>
+ * method in <code>DataInput</code>.
+ *
+ * @param value The <code>long</code> value to write to the stream
*
* @exception IOException If an error occurs
+ *
+ * @see DataInput#readLong
*/
- public final void writeLong (long v) throws IOException
+ public final void writeLong (long value) throws IOException
{
- write ((byte) (0xff & (v >> 56)));
- write ((byte) (0xff & (v >> 48)));
- write ((byte) (0xff & (v >> 40)));
- write ((byte) (0xff & (v >> 32)));
- write ((byte) (0xff & (v >> 24)));
- write ((byte) (0xff & (v >> 16)));
- write ((byte) (0xff & (v >> 8)));
- write ((byte) (0xff & v));
+ write ((byte) (0xff & (value >> 56)));
+ write ((byte) (0xff & (value>> 48)));
+ write ((byte) (0xff & (value>> 40)));
+ write ((byte) (0xff & (value>> 32)));
+ write ((byte) (0xff & (value>> 24)));
+ write ((byte) (0xff & (value>> 16)));
+ write ((byte) (0xff & (value>> 8)));
+ write ((byte) (0xff & value));
}
/**
* This method writes a Java <code>float</code> value to the stream. This
- * value is written by first calling the method
+ * value is written by first calling the method
* <code>Float.floatToIntBits</code>
* to retrieve an <code>int</code> representing the floating point number,
* then writing this <code>int</code> value to the stream exactly the same
* as the <code>writeInt()</code> method does.
*
- * @param f The floating point number to write to the stream.
+ * The value written can be read using the <code>readFloat</code>
+ * method in <code>DataInput</code>.
+ *
+ * @param value The <code>float</code> value to write to the stream
*
* @exception IOException If an error occurs
*
* @see writeInt
+ * @see DataInput#readFloat
+ * @see Float#floatToIntBits
*/
- public final void writeFloat (float v) throws IOException
+ public final void writeFloat (float value) throws IOException
{
- writeInt (Float.floatToIntBits(v));
+ writeInt (Float.floatToIntBits (value));
}
/**
* then writing this <code>long</code> value to the stream exactly the same
* as the <code>writeLong()</code> method does.
*
- * @param d The double precision floating point number to write to
- * the stream.
+ * The value written can be read using the <code>readDouble</code>
+ * method in <code>DataInput</code>.
+ *
+ * @param value The <code>double</code> value to write to the stream
*
* @exception IOException If an error occurs
*
* @see writeLong
+ * @see DataInput#readDouble
+ * @see Double#doubleToLongBits
*/
- public final void writeDouble (double v) throws IOException
+ public final void writeDouble (double value) throws IOException
{
- writeLong (Double.doubleToLongBits(v));
+ writeLong (Double.doubleToLongBits (value));
}
/**
* This method writes all the bytes in a <code>String</code> out to the
* stream. One byte is written for each character in the
* <code>String</code>.
- * The high eight bits of each character are discarded.
+ * The high eight bits of each character are discarded, thus this
+ * method is inappropriate for completely representing Unicode characters.
*
- * @param s The <code>String</code> to write to the stream
+ * @param value The <code>String</code> to write to the stream
*
* @exception IOException If an error occurs
*/
- public final void writeBytes (String s) throws IOException
+ public final void writeBytes (String value) throws IOException
{
- int len = s.length();
+ int len = value.length();
for (int i = 0; i < len; ++i)
- writeByte (s.charAt(i));
+ writeByte (value.charAt(i));
}
/**
- * This method writes all the characters in a <code>String</code> to the
- * stream. There will be two bytes for each character value. The high
- * byte of the character will be written first.
+ * This method writes all the characters of a <code>String</code> to an
+ * output stream as an array of <code>char</code>'s. Each character
+ * is written using the method specified in the <code>writeChar</code>
+ * method.
*
- * @param s The <code>String</code> to write to the stream.
+ * @param value The <code>String</code> to write to the stream
*
* @exception IOException If an error occurs
+ *
+ * @see writeChar
*/
- public final void writeChars (String s) throws IOException
+ public final void writeChars (String value) throws IOException
{
- int len = s.length();
+ int len = value.length();
for (int i = 0; i < len; ++i)
- writeChar (s.charAt(i));
+ writeChar (value.charAt(i));
}
/**
* character value are stored in bits 0-5 of byte three, with the high bits
* of that byte set to "10".
*
- * @param s The <code>String</code> to write to the output in UTF format
+ * The value written can be read using the <code>readUTF</code>
+ * method in <code>DataInput</code>.
+ *
+ * @param value The <code>String</code> to write to the output in UTF format
*
* @exception IOException If an error occurs
+ *
+ * @see DataInput#readUTF
*/
public final void writeUTF (String s) throws IOException
{
checkWrite();
return performCreate();
}
-
+
+ /*
+ * This native method handles the actual deleting of the file
+ */
private native boolean performDelete ();
/**
*
* @exception SecurityException If deleting of the file is not allowed
*/
- public boolean delete ()
+ public synchronized boolean delete ()
{
- SecurityManager s = System.getSecurityManager();
- String name = path;
+ SecurityManager s = System.getSecurityManager ();
+
if (s != null)
- s.checkDelete(path);
+ s.checkDelete (path);
+
return performDelete ();
}
{
if (! (obj instanceof File))
return false;
+
File other = (File) obj;
if (caseSensitive)
- return (path.equals(other.path));
+ return path.equals(other.path);
else
- return (path.equalsIgnoreCase(other.path));
+ return path.equalsIgnoreCase(other.path);
}
/**
*
* @since 1.2
*/
- public boolean isHidden()
+ public boolean isHidden ()
{
checkRead();
return _stat (ISHIDDEN);
checkRead();
return attr (LENGTH);
}
+
+ /*
+ * This native function actually produces the list of file in this
+ * directory
+ */
private final native Object[] performList (FilenameFilter filter,
FileFilter fileFilter,
*
* @since 1.2
*/
- public File[] listFiles()
+ public File[] listFiles ()
{
checkRead();
return (File[]) performList (null, null, File.class);
*
* @since 1.2
*/
- public File[] listFiles(FilenameFilter filter)
+ public File[] listFiles (FilenameFilter filter)
{
checkRead();
return (File[]) performList (filter, null, File.class);
}
-
+
/**
* This method returns an array of <code>File</code> objects representing
* all the files in the directory represented by this object. If this
*
* @since 1.2
*/
- public File[] listFiles(FileFilter filter)
+ public File[] listFiles (FileFilter filter)
{
checkRead();
return (File[]) performList (null, filter, File.class);
+ (isDirectory() ? "/" : ""));
}
+ /*
+ * This native method actually creates the directory
+ */
private final native boolean performMkdir ();
/**
throw new IOException ("cannot create temporary file");
}
+ /*
+ * This native method sets the permissions to make the file read only.
+ */
private native boolean performSetReadOnly();
/**
*
* @since 1.2
*/
- public boolean setReadOnly()
+ public boolean setReadOnly ()
{
checkWrite();
return performSetReadOnly();
*
* @since 1.2
*/
- public static File[] listRoots()
+ public static File[] listRoots ()
{
File[] roots = performListRoots();
return compareTo (other);
}
+ /*
+ * This native method actually performs the rename.
+ */
private native boolean performRenameTo (File dest);
/**
* @exception SecurityException If write access is not allowed to the
* file by the <code>SecurityMananger</code>.
*/
- public boolean renameTo (File dest)
+ public synchronized boolean renameTo (File dest)
{
SecurityManager s = System.getSecurityManager();
String sname = getName();
return performRenameTo (dest);
}
+ /*
+ * This method does the actual setting of the modification time.
+ */
private native boolean performSetLastModified(long time);
/**
*
* @since 1.2
*/
- public boolean setLastModified(long time)
+ public boolean setLastModified (long time)
{
checkWrite();
return performSetLastModified(time);
private void checkWrite ()
{
- SecurityManager s = System.getSecurityManager();
+ // Check the SecurityManager
+ SecurityManager s = System.getSecurityManager ();
+
if (s != null)
- s.checkWrite(path);
+ s.checkWrite (path);
}
private void checkRead ()
{
- SecurityManager s = System.getSecurityManager();
+ // Check the SecurityManager
+ SecurityManager s = System.getSecurityManager ();
+
if (s != null)
- s.checkRead(path);
+ s.checkRead (path);
}
/**
// FIXME: This should use the ShutdownHook API once we implement that.
public void deleteOnExit ()
{
+ // Check the SecurityManager
SecurityManager sm = System.getSecurityManager ();
if (sm != null)
sm.checkDelete (getName ());
// If the file was from an OS with a different dir separator,
// fixup the path to use the separator on this OS.
char oldSeparatorChar = ois.readChar ();
+
if (oldSeparatorChar != separatorChar)
path = path.replace (oldSeparatorChar, separatorChar);
}
+} // class File
-}
package java.io;
+
import gnu.gcj.convert.*;
/**
+ * This class reads characters from a byte input stream. The characters
+ * read are converted from bytes in the underlying stream by a
+ * decoding layer. The decoding layer transforms bytes to chars according
+ * to an encoding standard. There are many available encodings to choose
+ * from. The desired encoding can either be specified by name, or if no
+ * encoding is selected, the system default encoding will be used. The
+ * system default encoding name is determined from the system property
+ * <code>file.encoding</code>. The only encodings that are guaranteed to
+ * be availalbe are "8859_1" (the Latin-1 character set) and "UTF8".
+ * Unforunately, Java does not provide a mechanism for listing the
+ * ecodings that are supported in a given implementation.
+ * <p>
+ * Here is a list of standard encoding names that may be available:
+ * <p>
+ * <ul>
+ * <li>8859_1 (ISO-8859-1/Latin-1)
+ * <li>8859_2 (ISO-8859-2/Latin-2)
+ * <li>8859_3 (ISO-8859-3/Latin-3)
+ * <li>8859_4 (ISO-8859-4/Latin-4)
+ * <li>8859_5 (ISO-8859-5/Latin-5)
+ * <li>8859_6 (ISO-8859-6/Latin-6)
+ * <li>8859_7 (ISO-8859-7/Latin-7)
+ * <li>8859_8 (ISO-8859-8/Latin-8)
+ * <li>8859_9 (ISO-8859-9/Latin-9)
+ * <li>ASCII (7-bit ASCII)
+ * <li>UTF8 (UCS Transformation Format-8)
+ * <li>More later
+ * </ul>
+ * <p>
+ * It is recommended that applications do not use
+ * <code>InputStreamReader</code>'s
+ * directly. Rather, for efficiency purposes, an object of this class
+ * should be wrapped by a <code>BufferedReader</code>.
+ * <p>
+ * Due to a deficiency the Java class library design, there is no standard
+ * way for an application to install its own byte-character encoding.
+ *
+ * @see BufferedReader
+ * @see InputStream
+ *
+ * @author Aaron M. Renn (arenn@urbanophile.com)
* @author Per Bothner <bothner@cygnus.com>
* @date April 22, 1998.
*/
-/* Written using "Java Class Libraries", 2nd edition, plus online
- * API docs for JDK 1.2 beta from http://www.javasoft.com.
- * Status: Believed complete and correct, but only supports 8859_1.
- */
-
public class InputStreamReader extends Reader
{
BufferedInputStream in;
BytesToUnicode converter;
+ /**
+ * This method initializes a new instance of <code>InputStreamReader</code>
+ * to read from the specified stream using the default encoding.
+ *
+ * @param in The <code>InputStream</code> to read from
+ */
public InputStreamReader(InputStream in)
{
this(in, BytesToUnicode.getDefaultDecoder());
}
+ /**
+ * This method initializes a new instance of <code>InputStreamReader</code>
+ * to read from the specified stream using a caller supplied character
+ * encoding scheme. Note that due to a deficiency in the Java language
+ * design, there is no way to determine which encodings are supported.
+ *
+ * @param in The <code>InputStream</code> to read from
+ * @param encoding_name The name of the encoding scheme to use
+ *
+ * @exception UnsupportedEncodingException If the encoding scheme
+ * requested is not available.
+ */
public InputStreamReader(InputStream in, String encoding_name)
throws UnsupportedEncodingException
{
projects / gcc.git / commitdiff