1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
|
/* FileDescriptor.java -- Opaque file handle class
Copyright (C) 1998 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA.
As a special exception, if you link this library with other files to
produce an executable, this library does not by itself cause the
resulting executable to be covered by the GNU General Public License.
This exception does not however invalidate any other reasons why the
executable file might be covered by the GNU General Public License. */
package java.io;
import gnu.classpath.Configuration;
/**
* This class represents an opaque file handle as a Java class. It should
* be used only to pass to other methods that expect an object of this
* type. No system specific information can be obtained from this object.
*
* @version 0.1
*
* @author Aaron M. Renn (arenn@urbanophile.com)
*/
public final class FileDescriptor
{
/*************************************************************************/
/*
* Class Variables and Initializers
*/
/**
* This is a <code>FileDescriptor</code> object representing the standard
* input stream.
*/
public static final FileDescriptor in = new FileDescriptor(0);
/**
* This is a <code>FileDescriptor</code> object representing the standard
* output stream.
*/
public static final FileDescriptor out = new FileDescriptor(1);
/**
* This is a <code>FileDescriptor</code> object representing the standard
* error stream.
*/
public static final FileDescriptor err = new FileDescriptor(2);
static
{
if (Configuration.INIT_LOAD_LIBRARY)
{
System.loadLibrary ("javaio");
}
}
/*************************************************************************/
/**
* Instance Variables
*/
/**
* This is the actual native file descriptor value
*/
private int native_fd;
/*************************************************************************/
/*
* Class Methods
*/
private static FileDescriptor
getFileDescriptor(int native_fd)
{
return(new FileDescriptor(native_fd));
}
/*************************************************************************/
/*
* Constructors
*/
/**
* This method is used to initialize an invalid FileDescriptor object.
*/
public
FileDescriptor()
{
;
}
/*************************************************************************/
/**
* This method is used to initialize a <code>FileDescriptor</code> that will
* represent the specified native file handle.
*
* @param native_fd The native file handle this object should represent
*/
FileDescriptor(int native_fd)
{
this.native_fd = native_fd;
}
/*************************************************************************/
/*
* Instance Methods
*/
/**
* This method forces all data that has not yet been physically written to
* the underlying storage medium associated with this <code>FileDescriptor</code>
* to be written out. This method will not return until all data has
* been fully written to the underlying device. If the device does not
* support this functionality or if an error occurs, then an exception
* will be thrown.
*/
public void
sync() throws SyncFailedException
{
syncInternal(native_fd);
}
/*************************************************************************/
/**
* This is the native method where the actual sync'ing of data to disk
* is performed.
*
* @param native_fd The native file handle
*
* @exception SyncFailedException If an error occurs or sync is not supported
*/
native void
syncInternal(int native_fd);
/*************************************************************************/
/**
* This methods tests whether or not this object represents a valid open
* native file handle.
*
* @return <code>true</code> if this object represents a valid native file handle, <code>false</code> otherwise
*/
public boolean
valid()
{
return(validInternal(native_fd));
}
/*************************************************************************/
/**
* This is the native method which actually tests whether or not this
* object represents a valid native file handle.
*
* @param native_fd The native file handle
*
* @return <code>true</code> if this object represents a valid native file handle, <code>false</code> otherwise
*/
native boolean
validInternal(int native_fd);
/*************************************************************************/
/**
* This method eturns the native file handle represented by this object
*
* @return The native file handle this object represents
*/
int
getNativeFD()
{
return(native_fd);
}
/*************************************************************************/
/**
* This method sets the native file descriptor this object represents to
* the specified value.
*
* @param The native file handle this object should represent.
*/
void
setNativeFD(int native_fd)
{
this.native_fd = native_fd;
}
} // class FileDescriptor
|