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  
18  package org.apache.commons.id;
19  
20  /**
21   * Thrown when there is a failure condition during the encoding process.  This
22   * exception is thrown when an Encoder encounters a encoding specific exception
23   * such as invalid data, inability to calculate a checksum, characters outside of the 
24   * expected range.
25   * 
26   * @author Apache Software Foundation
27   * @version $Id: EncoderException.java 480488 2006-11-29 08:57:26Z bayard $
28   */
29  public class EncoderException extends Exception {
30  
31      /**
32       * Declares the Serial Version Uid.
33       * 
34       * @see <a href="http://c2.com/cgi/wiki?AlwaysDeclareSerialVersionUid">Always Declare Serial Version Uid</a>
35       */
36      private static final long serialVersionUID = 1L;
37  
38      /**
39       * Creates a new instance of this exception with an useful message.
40       * 
41       * @param pMessage a useful message relating to the encoder specific error.
42       */
43      public EncoderException(String pMessage) {
44          super(pMessage);
45      }
46  }  
47