001/* Channels.java --
002   Copyright (C) 2002, 2003, 2004, 2005  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package java.nio.channels;
040
041import gnu.java.nio.ChannelReader;
042import gnu.java.nio.ChannelWriter;
043import gnu.java.nio.InputStreamChannel;
044import gnu.java.nio.OutputStreamChannel;
045
046import java.io.InputStream;
047import java.io.OutputStream;
048import java.io.Reader;
049import java.io.Writer;
050import java.nio.charset.Charset;
051import java.nio.charset.CharsetDecoder;
052import java.nio.charset.CharsetEncoder;
053import java.nio.charset.UnsupportedCharsetException;
054
055
056/**
057 * @since 1.4
058 */
059public final class Channels
060{
061  /**
062   * This class isn't intended to be instantiated.
063   */
064  private Channels()
065  {
066    // Do nothing here.
067  }
068
069  /**
070   * Constructs a stream that reads bytes from the given channel.
071   */
072  public static InputStream newInputStream(ReadableByteChannel ch)
073  {
074    return VMChannels.newInputStream(ch);
075  }
076
077  /**
078   * Constructs a stream that writes bytes to the given channel.
079   */
080  public static OutputStream newOutputStream(WritableByteChannel ch)
081  {
082    return VMChannels.newOutputStream(ch);
083  }
084
085  /**
086   * Constructs a channel that reads bytes from the given stream.
087   */
088  public static ReadableByteChannel newChannel(InputStream in)
089  {
090    return new InputStreamChannel(in);
091  }
092
093  /**
094   * Constructs a channel that writes bytes to the given stream.
095   */
096  public static WritableByteChannel newChannel(OutputStream out)
097  {
098    return new OutputStreamChannel(out);
099  }
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}