summaryrefslogtreecommitdiff
path: root/java/io/DataOutput.java
blob: 1e1e732c155faf1dd50816514dcad730dda31093 (plain)
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
/*************************************************************************
/* DataOutput.java -- Interface for writing data from a stream
/*
/* Copyright (c) 1998 by Aaron M. Renn (arenn@urbanophile.com)
/*
/* This program is free software; you can redistribute it and/or modify
/* it under the terms of the GNU Library General Public License as published 
/* by the Free Software Foundation, version 2. (see COPYING.LIB)
/*
/* This program 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 Library General Public License
/* along with this program; if not, write to the Free Software Foundation
/* Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307 USA
/*************************************************************************/

package java.io;

/**
  * This interface is implemented by classes that can wrte data to streams 
  * from Java primitive types.
  *
  * @version 0.0
  *
  * @author Aaron M. Renn (arenn@urbanophile.com)
  */
public interface DataOutput
{

/**
  * This method writes a Java boolean value to an output stream
  *
  * @param value The boolean value to write
  *
  * @exception IOException If an error occurs
  */
public abstract void
writeBoolean(boolean value) throws IOException;

/*************************************************************************/

/**
  * This method writes a Java byte value to an output stream
  *
  * @param value The int value to write
  *
  * @exception IOException If an error occurs
  */
public abstract void
writeByte(int value) throws IOException;

/*************************************************************************/

/**
  * This method writes a Java char value to an output stream
  *
  * @param value The char value to write
  *
  * @exception IOException If an error occurs
  */
public abstract void
writeChar(int value) throws IOException;

/*************************************************************************/

/**
  * This method writes a Java int value to an output stream as a 16 bit value
  *
  * @param value The int value to write as a 16-bit value
  *
  * @exception IOException If an error occurs
  */
public abstract void
writeShort(int value) throws IOException;

/*************************************************************************/

/**
  * This method writes a Java int value to an output stream
  *
  * @param value The int value to write
  *
  * @exception IOException If an error occurs
  */
public abstract void
writeInt(int value) throws IOException;

/*************************************************************************/

/**
  * This method writes a Java long value to an output stream
  *
  * @param value The long value to write
  *
  * @exception IOException If an error occurs
  */
public abstract void
writeLong(long value) throws IOException;

/*************************************************************************/

/**
  * This method writes a Java float value to an output stream
  *
  * @param value The float value to write
  *
  * @exception IOException If an error occurs
  */
public abstract void
writeFloat(float value) throws IOException;

/*************************************************************************/

/**
  * This method writes a Java double value to an output stream
  *
  * @param value The double value to write
  *
  * @exception IOException If any other error occurs
  */
public abstract void
writeDouble(double value) throws IOException;

/*************************************************************************/

/**
  * This method writes a String to an output stream as an array of bytes
  *
  * @param value The String to write
  *
  * @exception IOException If an error occurs
  */
public abstract void
writeBytes(String value) throws IOException;

/*************************************************************************/

/**
  * This method writes a String to an output stream as an array of char's
  *
  * @param value The String to write
  *
  * @exception IOException If an error occurs
  */
public abstract void
writeChars(String value) throws IOException;

/*************************************************************************/

/**
  * This method writes a String to an output stream encoded in
  * UTF-8 format.
  *
  * @param value The String to write
  *
  * @exception IOException If an error occurs
  */
public abstract void
writeUTF(String value) throws IOException;

/*************************************************************************/

/**
  * This method writes an 8-bit value (passed into the method as a Java
  * int) to an output stream.
  *
  * @param value The byte to write to the output stream
  *
  * @exception IOException If an error occurs
  */
public abstract void
write(int value) throws IOException;

/*************************************************************************/

/**
  * This method writes the raw byte array passed in to the output stream.
  *
  * @param buf The byte array to write
  *
  * @exception IOException If an error occurs
  */
public abstract void
write(byte[] buf) throws IOException;

/*************************************************************************/

/**
  * This method writes raw bytes from the passed array @code{buf} starting
  * @code{offset} bytes into the buffer.  The number of bytes written will be
  * exactly @code{len}. 
  *
  * @param buf The buffer from which to write the data
  * @param offset The offset into the buffer to start writing data from
  * @param len The number of bytes to write from the buffer to the output stream
  *
  * @exception IOException If any other error occurs
  */
public abstract void
write(byte[] buf, int offset, int len) throws IOException;

} // interface DataOutput