Source for gnu.CORBA.CDR.EncapsulationStream

   1: /* EncapsulationOutput.java --
   2:    Copyright (C) 2005 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package gnu.CORBA.CDR;
  40: 
  41: import java.io.IOException;
  42: 
  43: /**
  44:  * The encapsulated data, as they are defined by CORBA specification.
  45:  * This includes the extra 0 byte (Big endian) in the beginning.
  46:  * When written to the parent steam, the encapsulated data are preceeded
  47:  * by the data length in bytes.
  48:  *
  49:  * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
  50:  */
  51: public class EncapsulationStream
  52:   extends AbstractCdrOutput
  53: {
  54:   /**
  55:    * The Big Endian (most siginificant byte first flag).
  56:    */
  57:   public static final byte BIG_ENDIAN = 0;
  58: 
  59:   /**
  60:    * The Little Endian (least siginificant byte first flag).
  61:    */
  62:   public static final byte LITTLE_ENDIAN = 1;
  63: 
  64:   /**
  65:    * The byte buffer.
  66:    */
  67:   public final AligningOutput buffer;
  68: 
  69:   /**
  70:    * The stream, where the data are being encapsulated.
  71:    */
  72:   public final org.omg.CORBA.portable.OutputStream parent;
  73: 
  74:   /**
  75:    * Create the EncapsulationOutput with the given parent stream
  76:    * and the specified encoding.
  77:    */
  78:   public EncapsulationStream(org.omg.CORBA.portable.OutputStream _parent,
  79:                             boolean use_big_endian)
  80:   {
  81:     super();
  82:     setBigEndian(use_big_endian);
  83:     buffer = new AligningOutput();
  84:     setOutputStream(buffer);
  85:     parent = _parent;
  86:     write(use_big_endian?BIG_ENDIAN:LITTLE_ENDIAN);
  87:   }
  88: 
  89:   /**
  90:    * Set the alignment offset, if the index of the first byte in the
  91:    * stream is different from 0.
  92:    */
  93:   public void setOffset(int an_offset)
  94:   {
  95:     buffer.setOffset(an_offset);
  96:   }
  97: 
  98:   /**
  99:    * Align the curretn position at the given natural boundary.
 100:    */
 101:   public void align(int boundary)
 102:   {
 103:     buffer.align(boundary);
 104:   }
 105: 
 106:   /**
 107:    * Writes the content of the encapsulated output into the parent
 108:    * buffer.
 109:    */
 110:   public void close()
 111:   {
 112:     try
 113:       {
 114:         parent.write_long(buffer.size());
 115:         buffer.writeTo(parent);
 116:       }
 117:     catch (IOException ex)
 118:       {
 119:         InternalError err = new InternalError();
 120:         err.initCause(ex);
 121:         throw err;
 122:       }
 123:   }
 124: 
 125:   /**
 126:    * Return the input stream that reads the previously written values.
 127:    */
 128:   public org.omg.CORBA.portable.InputStream create_input_stream()
 129:   {
 130:     BufferredCdrInput in = new BufferredCdrInput(buffer.toByteArray());
 131:     in.setOrb(orb);
 132: 
 133:     in.setVersion(giop);
 134:     in.setCodeSet(getCodeSet());
 135: 
 136:     return in;
 137:   }
 138: 
 139:   /**
 140:    * Resets (clears) the buffer.
 141:    */
 142:   public void reset()
 143:   {
 144:     buffer.reset();
 145:     setOutputStream(buffer);
 146:   }
 147: }