BAD_PARAM.java revision 608:7e06bf1dcb09 
1/*
2 * Copyright (c) 1995, 2006, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package org.omg.CORBA;
27
28/**
29 * Exception  thrown
30 * when a parameter passed to a call is out of range or
31 * otherwise considered illegal. An ORB may raise this exception
32 * if null values or null pointers are passed to an operation (for
33 * language mappings where the concept of a null pointers or null
34 * values applies). BAD_PARAM can also be raised as a result of a
35 * client generating requests with incorrect parameters using the DII. <P>
36 * It contains a minor code, which gives more detailed information about
37 * what caused the exception, and a completion status. It may also contain
38 * a string describing the exception.
39 *
40 * @see <A href="../../../../technotes/guides/idl/jidlExceptions.html">documentation on
41 * Java&nbsp;IDL exceptions</A>
42 * @see <A href="../../../../technotes/guides/idl/jidlExceptions.html#minorcodemeanings">meaning of
43 * minor codes</A>
44 * @since       JDK1.2
45 */
46
47public final class BAD_PARAM extends SystemException {
48
49    /**
50     * Constructs a <code>BAD_PARAM</code> exception with a default
51     * minor code of 0 and a completion state of COMPLETED_NO.
52     */
53    public BAD_PARAM() {
54        this("");
55    }
56
57    /**
58     * Constructs a <code>BAD_PARAM</code> exception with the specified detail
59     * message, a minor code of 0, and a completion state of COMPLETED_NO.
60     *
61     * @param s the String containing a detail message describing this
62     *          exception
63     */
64    public BAD_PARAM(String s) {
65        this(s, 0, CompletionStatus.COMPLETED_NO);
66    }
67
68    /**
69     * Constructs a <code>BAD_PARAM</code> exception with the specified
70     * minor code and completion status.
71     * @param minor the minor code
72     * @param completed the completion status
73     */
74    public BAD_PARAM(int minor, CompletionStatus completed) {
75        this("", minor, completed);
76    }
77
78    /**
79     * Constructs a <code>BAD_PARAM</code> exception with the specified detail
80     * message, minor code, and completion status.
81     * A detail message is a <code>String</code> that describes
82     * this particular exception.
83     *
84     * @param s the <code>String</code> containing a detail message
85     * @param minor the minor code
86     * @param completed the completion status
87     */
88    public BAD_PARAM(String s, int minor, CompletionStatus completed) {
89        super(s, minor, completed);
90    }
91}
92