Class BinaryStdOut

Object
  extended by BinaryStdOut

public final class BinaryStdOut
extends Object

Binary standard output. This class provides methods for converting primtive type variables (boolean, byte, char, int, long, float, and double) to sequences of bits and writing them to standard output. Uses big-endian (most-significant byte first).

The client must flush() the output stream when finished writing bits.

The client should not intermixing calls to BinaryStdOut with calls to StdOut or System.out; otherwise unexpected behavior will result.


Method Summary
static void close()
          Flush and close standard output.
static void flush()
          Flush standard output, padding 0s if number of bits written so far is not a multiple of 8.
static void main(String[] args)
          Test client.
static void write(boolean x)
          Write the specified bit to standard output.
static void write(byte x)
          Write the 8-bit byte to standard output.
static void write(char x)
          Write the 8-bit char to standard output.
static void write(char x, int r)
          Write the r-bit char to standard output.
static void write(double x)
          Write the 64-bit double to standard output.
static void write(float x)
          Write the 32-bit float to standard output.
static void write(int x)
          Write the 32-bit int to standard output.
static void write(int x, int r)
          Write the r-bit int to standard output.
static void write(long x)
          Write the 64-bit long to standard output.
static void write(short x)
          Write the 16-bit int to standard output.
static void write(String s)
          Write the string of 8-bit characters to standard output.
static void write(String s, int r)
          Write the String of r-bit characters to standard output.
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

flush

public static void flush()
Flush standard output, padding 0s if number of bits written so far is not a multiple of 8.


close

public static void close()
Flush and close standard output. Once standard output is closed, you can no longer write bits to it.


write

public static void write(boolean x)
Write the specified bit to standard output.

Parameters:
x - the boolean to write.

write

public static void write(byte x)
Write the 8-bit byte to standard output.

Parameters:
x - the byte to write.

write

public static void write(int x)
Write the 32-bit int to standard output.

Parameters:
x - the int to write.

write

public static void write(int x,
                         int r)
Write the r-bit int to standard output.

Parameters:
x - the int to write.
r - the number of relevant bits in the char.
Throws:
RuntimeException - if r is not between 1 and 32.
RuntimeException - if x is not between 0 and 2r - 1.

write

public static void write(double x)
Write the 64-bit double to standard output.

Parameters:
x - the double to write.

write

public static void write(long x)
Write the 64-bit long to standard output.

Parameters:
x - the long to write.

write

public static void write(float x)
Write the 32-bit float to standard output.

Parameters:
x - the float to write.

write

public static void write(short x)
Write the 16-bit int to standard output.

Parameters:
x - the short to write.

write

public static void write(char x)
Write the 8-bit char to standard output.

Parameters:
x - the char to write.
Throws:
RuntimeException - if x is not betwen 0 and 255.

write

public static void write(char x,
                         int r)
Write the r-bit char to standard output.

Parameters:
x - the char to write.
r - the number of relevant bits in the char.
Throws:
RuntimeException - if r is not between 1 and 16.
RuntimeException - if x is not between 0 and 2r - 1.

write

public static void write(String s)
Write the string of 8-bit characters to standard output.

Parameters:
s - the String to write.
Throws:
RuntimeException - if any character in the string is not between 0 and 255.

write

public static void write(String s,
                         int r)
Write the String of r-bit characters to standard output.

Parameters:
s - the String to write.
r - the number of relevants bits in each character.
Throws:
RuntimeException - if r is not between 1 and 16.
RuntimeException - if any character in the string is not between 0 and 2r - 1.

main

public static void main(String[] args)
Test client.