libcore/luni/src/main/java/java/nio/charset/UnsupportedCharsetException.java

   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 java.nio.charset;
  19
  20 /**
  21  * An {@code UnsupportedCharsetException} is thrown when an unsupported charset
  22  * name is encountered.
  23  */
  24 public class UnsupportedCharsetException extends IllegalArgumentException {
  25
  26     /*
  27      * This constant is used during deserialization to check the version
  28      * which created the serialized object.
  29      */
  30     private static final long serialVersionUID = 1490765524727386367L;
  31
  32     // the unsupported charset name
  33     private String charsetName;
  34
  35     /**
  36      * Constructs a new {@code UnsupportedCharsetException} with the supplied
  37      * charset name.
  38      *
  39      * @param charsetName
  40      *            the encountered unsupported charset name.
  41      */
  42     public UnsupportedCharsetException(String charsetName) {
  43         super((charsetName != null) ? charsetName : "null");
  44         this.charsetName = charsetName;
  45     }
  46
  47     /**
  48      * Gets the encountered unsupported charset name.
  49      *
  50      * @return the encountered unsupported charset name.
  51      */
  52     public String getCharsetName() {
  53         return charsetName;
  54     }
  55 }