Package com.google.common.io

Class LittleEndianDataOutputStream

  • All Implemented Interfaces:
    , , , 
    @Beta
@GwtIncompatible
public final class LittleEndianDataOutputStream
extends 
implements
    An implementation of that uses little-endian byte ordering for writing char, short, int, float, double, and long values.

    Note: This class intentionally violates the specification of its supertype DataOutput, which explicitly requires big-endian byte order.

    Since:
    8.0
    Author:
    Chris Nokleberg, Keith Bottner

    • Field Summary

      • Fields inherited from class java.io.

    • Constructor Summary

      Constructors 
      Constructor Description
       out)
      Creates a LittleEndianDataOutputStream that wraps the given stream.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void close()
      Closes this output stream and releases any system resources associated with the stream.
      void write​(byte[] b, int off, int len)
      Writes len bytes from the specified byte array starting at offset off to this output stream.
      void writeBoolean​(boolean v)
      Writes a boolean value to this output stream.
      void writeByte​(int v)
      Writes to the output stream the eight low- order bits of the argument v.
      void  s)
      Deprecated.
      The semantics of writeBytes(String s) are considered dangerous.
      void writeChar​(int v)
      Writes a char as specified by , except using little-endian byte order.
      void  s)
      Writes a String as specified by , except each character is written using little-endian byte order.
      void writeDouble​(double v)
      Writes a double as specified by , except using little-endian byte order.
      void writeFloat​(float v)
      Writes a float as specified by , except using little-endian byte order.
      void writeInt​(int v)
      Writes an int as specified by , except using little-endian byte order.
      void writeLong​(long v)
      Writes a long as specified by , except using little-endian byte order.
      void writeShort​(int v)
      Writes a short as specified by , except using little-endian byte order.
      void  str)
      Writes two bytes of length information to the output stream, followed by the modified UTF-8 representation of every character in the string s.

      • Methods inherited from class java.io.

        , ,

      • Methods inherited from class java.io.

      • Methods inherited from class java.lang.

        , , , , , , , , , ,

      • Methods inherited from interface java.io.

        ,

    • Constructor Detail

      • LittleEndianDataOutputStream

        public  out)
        Creates a LittleEndianDataOutputStream that wraps the given stream.
        Parameters:
        out - the stream to delegate to

    • Method Detail

      • write

        public void write​(byte[] b,
                  int off,
                  int len)
           throws
        Description copied from class: 
        Writes len bytes from the specified byte array starting at offset off to this output stream.

        The write method of FilterOutputStream calls the write method of one argument on each byte to output.

        Note that this method does not call the write method of its underlying output stream with the same arguments. Subclasses of FilterOutputStream should provide a more efficient implementation of this method.

        Specified by:
         in interface 
        Overrides:
         in class 
        Parameters:
        b - the data.
        off - the start offset in the data.
        len - the number of bytes to write.
        Throws:
        - if an I/O error occurs.
        See Also:

      • writeBoolean

        public void writeBoolean​(boolean v)
                  throws
        Description copied from interface: 
        Writes a boolean value to this output stream. If the argument v is true, the value (byte)1 is written; if v is false, the value (byte)0 is written. The byte written by this method may be read by the readBoolean method of interface DataInput, which will then return a boolean equal to v.
        Specified by:
         in interface 
        Parameters:
        v - the boolean to be written.
        Throws:
        - if an I/O error occurs.

      • writeByte

        public void writeByte​(int v)
               throws
        Description copied from interface: 
        Writes to the output stream the eight low- order bits of the argument v. The 24 high-order bits of v are ignored. (This means that writeByte does exactly the same thing as write for an integer argument.) The byte written by this method may be read by the readByte method of interface DataInput, which will then return a byte equal to (byte)v.
        Specified by:
         in interface 
        Parameters:
        v - the byte value to be written.
        Throws:
        - if an I/O error occurs.

      • writeBytes

        public void  s)
                throws
        Deprecated.
        The semantics of writeBytes(String s) are considered dangerous. Please use writeUTF(String s), writeChars(String s) or another write method instead.
        Description copied from interface: 
        Writes a string to the output stream. For every character in the string s, taken in order, one byte is written to the output stream. If s is null, a NullPointerException is thrown.

        If s.length is zero, then no bytes are written. Otherwise, the character s[0] is written first, then s[1], and so on; the last character written is s[s.length-1]. For each character, one byte is written, the low-order byte, in exactly the manner of the writeByte method . The high-order eight bits of each character in the string are ignored.

        Specified by:
         in interface 
        Parameters:
        s - the string of bytes to be written.
        Throws:
        - if an I/O error occurs.

      • writeChar

        public void writeChar​(int v)
               throws
        Writes a char as specified by , except using little-endian byte order.
        Specified by:
         in interface 
        Parameters:
        v - the char value to be written.
        Throws:
        - if an I/O error occurs

      • writeChars

        public void  s)
                throws
        Writes a String as specified by , except each character is written using little-endian byte order.
        Specified by:
         in interface 
        Parameters:
        s - the string value to be written.
        Throws:
        - if an I/O error occurs

      • writeDouble

        public void writeDouble​(double v)
                 throws
        Writes a double as specified by , except using little-endian byte order.
        Specified by:
         in interface 
        Parameters:
        v - the double value to be written.
        Throws:
        - if an I/O error occurs

      • writeFloat

        public void writeFloat​(float v)
                throws
        Writes a float as specified by , except using little-endian byte order.
        Specified by:
         in interface 
        Parameters:
        v - the float value to be written.
        Throws:
        - if an I/O error occurs

      • writeInt

        public void writeInt​(int v)
              throws
        Writes an int as specified by , except using little-endian byte order.
        Specified by:
         in interface 
        Parameters:
        v - the int value to be written.
        Throws:
        - if an I/O error occurs

      • writeLong

        public void writeLong​(long v)
               throws
        Writes a long as specified by , except using little-endian byte order.
        Specified by:
         in interface 
        Parameters:
        v - the long value to be written.
        Throws:
        - if an I/O error occurs

      • writeShort

        public void writeShort​(int v)
                throws
        Writes a short as specified by , except using little-endian byte order.
        Specified by:
         in interface 
        Parameters:
        v - the short value to be written.
        Throws:
        - if an I/O error occurs

      • writeUTF

        public void  str)
              throws
        Description copied from interface: 
        Writes two bytes of length information to the output stream, followed by the modified UTF-8 representation of every character in the string s. If s is null, a NullPointerException is thrown. Each character in the string s is converted to a group of one, two, or three bytes, depending on the value of the character.

        If a character c is in the range \u0001 through \u007f, it is represented by one byte: 

        (byte)c

        If a character c is \u0000 or is in the range \u0080 through \u07ff, then it is represented by two bytes, to be written in the order shown: 

        
 (byte)(0xc0 | (0x1f & (c >> 6)))
 (byte)(0x80 | (0x3f & c))

        If a character c is in the range \u0800 through uffff, then it is represented by three bytes, to be written in the order shown: 

        
 (byte)(0xe0 | (0x0f & (c >> 12)))
 (byte)(0x80 | (0x3f & (c >>  6)))
 (byte)(0x80 | (0x3f & c))

        First, the total number of bytes needed to represent all the characters of s is calculated. If this number is larger than 65535, then a UTFDataFormatException is thrown. Otherwise, this length is written to the output stream in exactly the manner of the writeShort method; after this, the one-, two-, or three-byte representation of each character in the string s is written.

        The bytes written by this method may be read by the readUTF method of interface DataInput , which will then return a String equal to s.

        Specified by:
         in interface 
        Parameters:
        str - the string value to be written.
        Throws:
        - if an I/O error occurs.

      • close

        public void close()
           throws
        Description copied from class: 
        Closes this output stream and releases any system resources associated with the stream.

        When not already closed, the close method of FilterOutputStream calls its flush method, and then calls the close method of its underlying output stream.

        Specified by:
         in interface 
        Specified by:
         in interface 
        Overrides:
         in class 
        Throws:
        - if an I/O error occurs.
        See Also:
        ,