corba/src/share/classes/org/omg/CORBA/UnknownUserException.java
author andrew
Sat, 16 Jan 2010 01:04:04 +0000
changeset 4623 e3aaa29eff65
parent 4 02bb8761fcce
child 5555 b2b5ed3f0d0d
permissions -rw-r--r--
6917485: Corba doc warnings Summary: Fix warnings generated by javadoc Reviewed-by: darcy
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4
02bb8761fcce Initial load
duke
parents:
diff changeset
     1
/*
02bb8761fcce Initial load
duke
parents:
diff changeset
     2
 * Copyright 1997-2006 Sun Microsystems, Inc.  All Rights Reserved.
02bb8761fcce Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
02bb8761fcce Initial load
duke
parents:
diff changeset
     4
 *
02bb8761fcce Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
02bb8761fcce Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
02bb8761fcce Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Sun designates this
02bb8761fcce Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
02bb8761fcce Initial load
duke
parents:
diff changeset
     9
 * by Sun in the LICENSE file that accompanied this code.
02bb8761fcce Initial load
duke
parents:
diff changeset
    10
 *
02bb8761fcce Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
02bb8761fcce Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
02bb8761fcce Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
02bb8761fcce Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
02bb8761fcce Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
02bb8761fcce Initial load
duke
parents:
diff changeset
    16
 *
02bb8761fcce Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
02bb8761fcce Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
02bb8761fcce Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
02bb8761fcce Initial load
duke
parents:
diff changeset
    20
 *
02bb8761fcce Initial load
duke
parents:
diff changeset
    21
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
02bb8761fcce Initial load
duke
parents:
diff changeset
    22
 * CA 95054 USA or visit www.sun.com if you need additional information or
02bb8761fcce Initial load
duke
parents:
diff changeset
    23
 * have any questions.
02bb8761fcce Initial load
duke
parents:
diff changeset
    24
 */
02bb8761fcce Initial load
duke
parents:
diff changeset
    25
02bb8761fcce Initial load
duke
parents:
diff changeset
    26
package org.omg.CORBA;
02bb8761fcce Initial load
duke
parents:
diff changeset
    27
02bb8761fcce Initial load
duke
parents:
diff changeset
    28
/**
02bb8761fcce Initial load
duke
parents:
diff changeset
    29
 * A class that contains user exceptions returned by the server.
02bb8761fcce Initial load
duke
parents:
diff changeset
    30
 * When the client uses the DII to make an invocation, any user exception
02bb8761fcce Initial load
duke
parents:
diff changeset
    31
 * returned from the server is enclosed in an <code>Any</code> object contained in the
02bb8761fcce Initial load
duke
parents:
diff changeset
    32
 * <code>UnknownUserException</code> object. This is available from the
02bb8761fcce Initial load
duke
parents:
diff changeset
    33
 * <code>Environment</code> object returned by the method <code>Request.env</code>.
02bb8761fcce Initial load
duke
parents:
diff changeset
    34
 *
02bb8761fcce Initial load
duke
parents:
diff changeset
    35
 * @see <A href="../../../../technotes/guides/idl/jidlExceptions.html">documentation on
02bb8761fcce Initial load
duke
parents:
diff changeset
    36
 * Java&nbsp;IDL exceptions</A>
02bb8761fcce Initial load
duke
parents:
diff changeset
    37
 * @see Request
02bb8761fcce Initial load
duke
parents:
diff changeset
    38
 */
02bb8761fcce Initial load
duke
parents:
diff changeset
    39
02bb8761fcce Initial load
duke
parents:
diff changeset
    40
public final class UnknownUserException extends UserException {
02bb8761fcce Initial load
duke
parents:
diff changeset
    41
02bb8761fcce Initial load
duke
parents:
diff changeset
    42
    /** The <code>Any</code> instance that contains the actual user exception thrown
02bb8761fcce Initial load
duke
parents:
diff changeset
    43
     *  by the server.
02bb8761fcce Initial load
duke
parents:
diff changeset
    44
     * @serial
02bb8761fcce Initial load
duke
parents:
diff changeset
    45
     */
02bb8761fcce Initial load
duke
parents:
diff changeset
    46
    public Any except;
02bb8761fcce Initial load
duke
parents:
diff changeset
    47
02bb8761fcce Initial load
duke
parents:
diff changeset
    48
    /**
02bb8761fcce Initial load
duke
parents:
diff changeset
    49
     * Constructs an <code>UnknownUserException</code> object.
02bb8761fcce Initial load
duke
parents:
diff changeset
    50
     */
02bb8761fcce Initial load
duke
parents:
diff changeset
    51
    public UnknownUserException() {
02bb8761fcce Initial load
duke
parents:
diff changeset
    52
        super();
02bb8761fcce Initial load
duke
parents:
diff changeset
    53
    }
02bb8761fcce Initial load
duke
parents:
diff changeset
    54
02bb8761fcce Initial load
duke
parents:
diff changeset
    55
    /**
02bb8761fcce Initial load
duke
parents:
diff changeset
    56
     * Constructs an <code>UnknownUserException</code> object that contains the given
02bb8761fcce Initial load
duke
parents:
diff changeset
    57
     * <code>Any</code> object.
02bb8761fcce Initial load
duke
parents:
diff changeset
    58
     *
4623
e3aaa29eff65 6917485: Corba doc warnings
andrew
parents: 4
diff changeset
    59
     * @param a an <code>Any</code> object that contains a user exception returned
4
02bb8761fcce Initial load
duke
parents:
diff changeset
    60
     *         by the server
02bb8761fcce Initial load
duke
parents:
diff changeset
    61
     */
02bb8761fcce Initial load
duke
parents:
diff changeset
    62
    public UnknownUserException(Any a) {
02bb8761fcce Initial load
duke
parents:
diff changeset
    63
        super();
02bb8761fcce Initial load
duke
parents:
diff changeset
    64
        except = a;
02bb8761fcce Initial load
duke
parents:
diff changeset
    65
    }
02bb8761fcce Initial load
duke
parents:
diff changeset
    66
}