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;
18  
19  import java.util.NoSuchElementException;
20  
21  /***
22   * The BufferUnderflowException is used when the buffer is already empty.
23   * <p>
24   * NOTE: From version 3.0, this exception extends NoSuchElementException.
25   * 
26   * @since Commons Collections 2.1
27   * @version $Revision: 555824 $ $Date: 2007-07-13 01:27:15 +0100 (Fri, 13 Jul 2007) $
28   *
29   * @author Avalon
30   * @author Berin Loritsch
31   * @author Jeff Turner
32   * @author Paul Jack
33   * @author Stephen Colebourne
34   */
35  public class BufferUnderflowException extends NoSuchElementException {
36      
37      /*** The root cause throwable */
38      private final Throwable throwable;
39  
40      /***
41       * Constructs a new <code>BufferUnderflowException</code>.
42       */
43      public BufferUnderflowException() {
44          super();
45          throwable = null;
46      }
47  
48      /*** 
49       * Construct a new <code>BufferUnderflowException</code>.
50       * 
51       * @param message  the detail message for this exception
52       */
53      public BufferUnderflowException(String message) {
54          this(message, null);
55      }
56  
57      /*** 
58       * Construct a new <code>BufferUnderflowException</code>.
59       * 
60       * @param message  the detail message for this exception
61       * @param exception  the root cause of the exception
62       */
63      public BufferUnderflowException(String message, Throwable exception) {
64          super(message);
65          throwable = exception;
66      }
67  
68      /***
69       * Gets the root cause of the exception.
70       *
71       * @return the root cause
72       */
73      public final Throwable getCause() {
74          return throwable;
75      }
76      
77  }