src/java.base/share/classes/java/nio/charset/UnmappableCharacterException.java
author darcy
Thu, 29 Aug 2019 16:31:34 -0700
changeset 57956 e0b8b019d2f5
parent 47216 71c04702a3d5
permissions -rw-r--r--
8229997: Apply java.io.Serial annotations in java.base Reviewed-by: alanb, rriggs
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
57956
e0b8b019d2f5 8229997: Apply java.io.Serial annotations in java.base
darcy
parents: 47216
diff changeset
     2
 * Copyright (c) 2001, 2019, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.nio.charset;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
 * Checked exception thrown when an input character (or byte) sequence
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * is valid but cannot be mapped to an output byte (or character)
18164
68f1bc4eadd4 8016370: javadoc warnings, unexpected </p> mostly
alanb
parents: 5506
diff changeset
    32
 * sequence.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * @since 1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
public class UnmappableCharacterException
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
    extends CharacterCodingException
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
{
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
57956
e0b8b019d2f5 8229997: Apply java.io.Serial annotations in java.base
darcy
parents: 47216
diff changeset
    41
    @java.io.Serial
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
    private static final long serialVersionUID = -7026962371537706123L;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
    private int inputLength;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
19034
d068b8fff162 8020971: Fix doclint issues in java.nio.*
darcy
parents: 18164
diff changeset
    46
    /**
d068b8fff162 8020971: Fix doclint issues in java.nio.*
darcy
parents: 18164
diff changeset
    47
     * Constructs an {@code UnmappableCharacterException} with the
d068b8fff162 8020971: Fix doclint issues in java.nio.*
darcy
parents: 18164
diff changeset
    48
     * given length.
d068b8fff162 8020971: Fix doclint issues in java.nio.*
darcy
parents: 18164
diff changeset
    49
     * @param inputLength the length of the input
d068b8fff162 8020971: Fix doclint issues in java.nio.*
darcy
parents: 18164
diff changeset
    50
     */
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
    public UnmappableCharacterException(int inputLength) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
        this.inputLength = inputLength;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
19034
d068b8fff162 8020971: Fix doclint issues in java.nio.*
darcy
parents: 18164
diff changeset
    55
    /**
d068b8fff162 8020971: Fix doclint issues in java.nio.*
darcy
parents: 18164
diff changeset
    56
     * Returns the length of the input.
d068b8fff162 8020971: Fix doclint issues in java.nio.*
darcy
parents: 18164
diff changeset
    57
     * @return the length of the input
d068b8fff162 8020971: Fix doclint issues in java.nio.*
darcy
parents: 18164
diff changeset
    58
     */
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
    public int getInputLength() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
        return inputLength;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
19034
d068b8fff162 8020971: Fix doclint issues in java.nio.*
darcy
parents: 18164
diff changeset
    63
    /**
d068b8fff162 8020971: Fix doclint issues in java.nio.*
darcy
parents: 18164
diff changeset
    64
     * Returns the message.
d068b8fff162 8020971: Fix doclint issues in java.nio.*
darcy
parents: 18164
diff changeset
    65
     * @return the message
d068b8fff162 8020971: Fix doclint issues in java.nio.*
darcy
parents: 18164
diff changeset
    66
     */
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
    public String getMessage() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
        return "Input length = " + inputLength;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
}