IndirectionException.java revision 608:7e06bf1dcb09 
1/*
2 * Copyright (c) 1999, 2003, 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/*
26 * Licensed Materials - Property of IBM
27 * RMI-IIOP v1.0
28 * Copyright IBM Corp. 1998 1999  All Rights Reserved
29 *
30 */
31
32package org.omg.CORBA.portable;
33
34import org.omg.CORBA.SystemException;
35/**
36 * The Indirection exception is a Java specific system exception.
37 * It is thrown when the ORB's input stream is called to demarshal
38 * a value that is encoded as an indirection that is in the process
39 * of being demarshaled. This can occur when the ORB input stream
40 * calls the ValueHandler to demarshal an RMI value whose state
41 * contains a recursive reference to itself. Because the top-level
42 * ValueHandler.read_value() call has not yet returned a value,
43 * the ORB input stream's indirection table does not contain an entry
44 * for an object with the stream offset specified by the indirection
45 * tag. The stream offset is returned in the exception's offset field.
46 * @see org.omg.CORBA_2_3.portable.InputStream
47 * @see org.omg.CORBA_2_3.portable.OutputStream
48 */
49public class IndirectionException extends SystemException {
50
51    /**
52     * Points to the stream's offset.
53     */
54    public int offset;
55
56    /**
57     * Creates an IndirectionException with the right offset value.
58     * The stream offset is returned in the exception's offset field.
59     * This exception is constructed and thrown during reading
60     * recursively defined values off of a stream.
61     *
62     * @param offset the stream offset where recursion is detected.
63     */
64    public IndirectionException(int offset){
65        super("", 0, org.omg.CORBA.CompletionStatus.COMPLETED_MAYBE);
66        this.offset = offset;
67    }
68}
69