libjava/classpath/java/nio/channels/Channels.java

   1 /* Channels.java --
   2    Copyright (C) 2002, 2003, 2004, 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 java.nio.channels;
  40
  41 import gnu.java.nio.ChannelReader;
  42 import gnu.java.nio.ChannelWriter;
  43 import gnu.java.nio.InputStreamChannel;
  44 import gnu.java.nio.OutputStreamChannel;
  45
  46 import java.io.InputStream;
  47 import java.io.OutputStream;
  48 import java.io.Reader;
  49 import java.io.Writer;
  50 import java.nio.charset.Charset;
  51 import java.nio.charset.CharsetDecoder;
  52 import java.nio.charset.CharsetEncoder;
  53 import java.nio.charset.UnsupportedCharsetException;
  54
  55
  56 /**
  57  * @since 1.4
  58  */
  59 public final class Channels
  60 {
  61   /**
  62    * This class isn't intended to be instantiated.
  63    */
  64   private Channels()
  65   {
  66     // Do nothing here.
  67   }
  68
  69   /**
  70    * Constructs a stream that reads bytes from the given channel.
  71    */
  72   public static InputStream newInputStream(ReadableByteChannel ch)
  73   {
  74     return VMChannels.newInputStream(ch);
  75   }
  76
  77   /**
  78    * Constructs a stream that writes bytes to the given channel.
  79    */
  80   public static OutputStream newOutputStream(WritableByteChannel ch)
  81   {
  82     return VMChannels.newOutputStream(ch);
  83   }
  84
  85   /**
  86    * Constructs a channel that reads bytes from the given stream.
  87    */
  88   public static ReadableByteChannel newChannel(InputStream in)
  89   {
  90     return new InputStreamChannel(in);
  91   }
  92
  93   /**
  94    * Constructs a channel that writes bytes to the given stream.
  95    */
  96   public static WritableByteChannel newChannel(OutputStream out)
  97   {
  98     return new OutputStreamChannel(out);
  99   }
 100
 101   /**
 102    * Constructs a reader that decodes bytes from the given channel using the
 103    * given decoder.
 104    */
 105   public static Reader newReader(ReadableByteChannel ch, CharsetDecoder dec,
 106                                  int minBufferCap)
 107   {
 108     return new ChannelReader(ch, dec, minBufferCap);
 109   }
 110
 111   /**
 112    * Constructs a reader that decodes bytes from the given channel according to
 113    * the named charset.
 114    *
 115    * @exception UnsupportedCharsetException If no support for the named charset
 116    * is available in this instance of the Java virtual machine.
 117    */
 118   public static Reader newReader(ReadableByteChannel ch, String csName)
 119   {
 120     return newReader(ch, Charset.forName(csName).newDecoder(), -1);
 121   }
 122
 123   /**
 124    * Constructs a writer that encodes characters using the given encoder and
 125    * writes the resulting bytes to the given channel.
 126    */
 127   public static Writer newWriter(WritableByteChannel ch, CharsetEncoder enc,
 128                                  int minBufferCap)
 129   {
 130     return new ChannelWriter(ch, enc, minBufferCap);
 131   }
 132
 133   /**
 134    * Constructs a writer that encodes characters according to the named charset
 135    * and writes the resulting bytes to the given channel.
 136    *
 137    * @exception UnsupportedCharsetException If no support for the named charset
 138    * is available in this instance of the Java virtual machine.
 139    */
 140   public static Writer newWriter(WritableByteChannel ch, String csName)
 141   {
 142     return newWriter(ch, Charset.forName(csName).newEncoder(), -1);
 143   }
 144 }