libjava/java/nio/channels/Pipe.java

   1 /* Pipe.java --
   2    Copyright (C) 2002 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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 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 package java.nio.channels;
  39
  40 import java.io.IOException;
  41 import java.nio.channels.spi.AbstractSelectableChannel;
  42 import java.nio.channels.spi.SelectorProvider;
  43
  44 /**
  45  * @author Michael Koch
  46  * @since 1.4
  47  */
  48 public abstract class Pipe
  49 {
  50   public abstract static class SinkChannel
  51     extends AbstractSelectableChannel
  52     implements WritableByteChannel, GatheringByteChannel
  53   {
  54     /**
  55      * Initializes the channel.
  56      */
  57     protected SinkChannel (SelectorProvider provider)
  58     {
  59       super (provider);
  60     }
  61
  62     /**
  63      * Returns an operation set that is valid on this channel.
  64      *
  65      * The only valid operation on this channel is @see SelectionKey.OP_WRITE.
  66      */
  67     public final int validOps ()
  68     {
  69       return SelectionKey.OP_WRITE;
  70     }
  71   }
  72
  73   public abstract static class SourceChannel
  74     extends AbstractSelectableChannel
  75     implements ReadableByteChannel, ScatteringByteChannel
  76   {
  77     /**
  78      * Initializes the channel.
  79      */
  80     protected SourceChannel (SelectorProvider provider)
  81     {
  82       super (provider);
  83     }
  84
  85     /**
  86      * Returns an operation set that is valid on this channel.
  87      *
  88      * The only valid operation on this channel is @see SelectionKey.OP_READ.
  89      */
  90     public final int validOps ()
  91     {
  92       return SelectionKey.OP_READ;
  93     }
  94   }
  95
  96   /**
  97    * Initializes the pipe.
  98    */
  99   protected Pipe()
 100   {
 101   }
 102
 103   /**
 104    * Opens a pipe.
 105    *
 106    * @exception IOException If an error occurs
 107    */
 108   public static Pipe open() throws IOException
 109   {
 110     return SelectorProvider.provider ().openPipe();
 111   }
 112
 113   /**
 114    * Returns a pipe's sink channel.
 115    */
 116   public abstract Pipe.SinkChannel sink();
 117
 118   /**
 119    * Returns a pipe's source channel
 120    */
 121   public abstract Pipe.SourceChannel source();
 122 }