jdk/src/java.desktop/share/classes/javax/swing/text/ChangedCharSetException.java
author darcy
Tue, 14 Apr 2015 15:43:14 -0700
changeset 30462 507bcb03c954
parent 25859 3317bb8137f4
permissions -rw-r--r--
8076624: Fix missing doclint warnings in javax.swing.text Reviewed-by: serb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
30462
507bcb03c954 8076624: Fix missing doclint warnings in javax.swing.text
darcy
parents: 25859
diff changeset
     2
 * Copyright (c) 1998, 2015, 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
package javax.swing.text;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
import java.io.IOException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
 * ChangedCharSetException as the name indicates is an exception
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * thrown when the charset is changed.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * @author Sunita Mani
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 */
23697
e556a715949f 8034169: Fix serial lint warnings in javax.swing
darcy
parents: 5506
diff changeset
    35
@SuppressWarnings("serial") // Same-version serialization only
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
public class ChangedCharSetException extends IOException {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
    String charSetSpec;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
    boolean charSetKey;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
30462
507bcb03c954 8076624: Fix missing doclint warnings in javax.swing.text
darcy
parents: 25859
diff changeset
    41
    /**
507bcb03c954 8076624: Fix missing doclint warnings in javax.swing.text
darcy
parents: 25859
diff changeset
    42
     * Constructs a {@code ChangedCharSetException}.
507bcb03c954 8076624: Fix missing doclint warnings in javax.swing.text
darcy
parents: 25859
diff changeset
    43
     * @param charSetSpec name of the char set specification
507bcb03c954 8076624: Fix missing doclint warnings in javax.swing.text
darcy
parents: 25859
diff changeset
    44
     * @param charSetKey char set key
507bcb03c954 8076624: Fix missing doclint warnings in javax.swing.text
darcy
parents: 25859
diff changeset
    45
     */
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
    public ChangedCharSetException(String charSetSpec, boolean charSetKey) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
        this.charSetSpec = charSetSpec;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
        this.charSetKey = charSetKey;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
30462
507bcb03c954 8076624: Fix missing doclint warnings in javax.swing.text
darcy
parents: 25859
diff changeset
    51
    /**
507bcb03c954 8076624: Fix missing doclint warnings in javax.swing.text
darcy
parents: 25859
diff changeset
    52
     * Returns the char set specification.
507bcb03c954 8076624: Fix missing doclint warnings in javax.swing.text
darcy
parents: 25859
diff changeset
    53
     * @return the char set specification
507bcb03c954 8076624: Fix missing doclint warnings in javax.swing.text
darcy
parents: 25859
diff changeset
    54
     */
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
    public String getCharSetSpec() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
        return charSetSpec;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
30462
507bcb03c954 8076624: Fix missing doclint warnings in javax.swing.text
darcy
parents: 25859
diff changeset
    59
    /**
507bcb03c954 8076624: Fix missing doclint warnings in javax.swing.text
darcy
parents: 25859
diff changeset
    60
     * Returns the char set key.
507bcb03c954 8076624: Fix missing doclint warnings in javax.swing.text
darcy
parents: 25859
diff changeset
    61
     * @return the char set key
507bcb03c954 8076624: Fix missing doclint warnings in javax.swing.text
darcy
parents: 25859
diff changeset
    62
     */
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
    public boolean keyEqualsCharSet() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
        return charSetKey;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
}