View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.collections.primitives.adapters.io;
18  
19  import java.io.IOException;
20  import java.io.InputStream;
21  import java.util.NoSuchElementException;
22  
23  import org.apache.commons.collections.primitives.ByteIterator;
24  
25  /**
26   * Adapts an {@link InputStream} to the {@link ByteIterator} interface.
27   * 
28   * @version $Revision: 480462 $ $Date: 2006-11-29 03:15:00 -0500 (Wed, 29 Nov 2006) $
29   * @author Rodney Waldhoff
30   */
31  public class InputStreamByteIterator implements ByteIterator {
32  
33      public InputStreamByteIterator(InputStream in) {
34          this.stream = in;
35      }
36  
37      public boolean hasNext() {
38          ensureNextAvailable();
39          return (-1 != next);
40      }
41  
42      public byte next() {
43          if(!hasNext()) {
44              throw new NoSuchElementException("No next element");
45          } else {
46              nextAvailable = false;
47              return (byte)next;
48          }
49      }
50      
51      /**
52       * Not supported.
53       * @throws UnsupportedOperationException
54       */
55      public void remove() throws UnsupportedOperationException {
56          throw new UnsupportedOperationException("remove() is not supported here");
57      }
58  
59      public static ByteIterator adapt(InputStream in) {
60          return null == in ? null : new InputStreamByteIterator(in);
61      }
62      
63      private void ensureNextAvailable() {
64          if(!nextAvailable) {
65              readNext();
66          }
67      }
68  
69      private void readNext() {
70          try {
71              next = stream.read();
72              nextAvailable = true;
73          } catch(IOException e) {
74              // TODO: Use a tunnelled exception instead? 
75              // See http://radio.weblogs.com/0122027/2003/04/01.html#a7, for example            
76              throw new RuntimeException(e.toString());
77          }
78      }
79      
80      private InputStream stream = null;
81      private boolean nextAvailable = false;
82      private int next;
83  }