corba/src/java.corba/share/classes/org/omg/CORBA/LocalObject.java
changeset 32688 936c391804a5
parent 30384 ff19c1d6f92a
--- a/corba/src/java.corba/share/classes/org/omg/CORBA/LocalObject.java	Wed Jul 05 20:49:25 2017 +0200
+++ b/corba/src/java.corba/share/classes/org/omg/CORBA/LocalObject.java	Sun Sep 13 23:31:47 2015 +0300
@@ -30,26 +30,26 @@
 /**
  * Used as a base class for implementation of a local IDL interface in the
  * Java language mapping.  It is a class which implements all the operations
- * in the <tt>org.omg.CORBA.Object</tt> interface.
+ * in the {@code org.omg.CORBA.Object} interface.
  * <P>Local interfaces are implemented by using CORBA::LocalObject
- *  to provide implementations of <code>Object</code> pseudo
- *  operations and any other ORB-specific support mechanisms that are
- *  appropriate for such objects.  Object implementation techniques are
- *  inherently language-mapping specific.  Therefore, the
- *  <code>LocalObject</code> type is not defined in IDL, but is specified
- *  in each language mapping.
- *  <P>Methods that do not apply to local objects throw
- *  an <code>org.omg.CORBA.NO_IMPLEMENT</code> exception with the message,
- *  "This is a locally contrained object."  Attempting to use a
- *  <TT>LocalObject</TT> to create a DII request results in NO_IMPLEMENT
- *  system exception.  Attempting to marshal or stringify a
- *  <TT>LocalObject</TT> results in a MARSHAL system exception.  Narrowing
- *  and widening references to <TT>LocalObjects</TT> must work as for regular
- *  object references.
- *  <P><code>LocalObject</code> is to be used as the base class of locally
- *  constrained objects, such as those in the PortableServer module.
- *  The specification here is based on the CORBA Components
- *  Volume I - orbos/99-07-01
+ * to provide implementations of {@code Object} pseudo
+ * operations and any other ORB-specific support mechanisms that are
+ * appropriate for such objects.  Object implementation techniques are
+ * inherently language-mapping specific.  Therefore, the
+ * {@code LocalObject} type is not defined in IDL, but is specified
+ * in each language mapping.
+ * <P>Methods that do not apply to local objects throw
+ * an {@code org.omg.CORBA.NO_IMPLEMENT} exception with the message,
+ * "This is a locally contrained object."  Attempting to use a
+ * {@code LocalObject} to create a DII request results in NO_IMPLEMENT
+ * system exception.  Attempting to marshal or stringify a
+ * {@code LocalObject} results in a MARSHAL system exception.  Narrowing
+ * and widening references to {@code LocalObjects} must work as for regular
+ * object references.
+ * <P>{@code LocalObject} is to be used as the base class of locally
+ * constrained objects, such as those in the PortableServer module.
+ * The specification here is based on the CORBA Components
+ * Volume I - orbos/99-07-01
  *
  * @see <a href="package-summary.html#unimpl"><code>CORBA</code> package
  *      comments for unimplemented features</a>
@@ -60,7 +60,7 @@
     private static String reason = "This is a locally constrained object.";
 
     /**
-     * Constructs a default <code>LocalObject</code> instance.
+     * Constructs a default {@code LocalObject} instance.
      */
     public LocalObject() {}
 
@@ -75,9 +75,9 @@
      * <P>Default implementation of the org.omg.CORBA.Object method.
      *
      * @param that the object reference with which to check for equivalence
-     * @return <code>true</code> if this object reference is known to be
+     * @return {@code true} if this object reference is known to be
      *         equivalent to the given object reference.
-     *         Note that <code>false</code> indicates only that the two
+     *         Note that {@code false} indicates only that the two
      *         object references are distinct, not necessarily that
      *         they reference distinct objects.
      */
@@ -86,11 +86,11 @@
     }
 
     /**
-     * Always returns <code>false</code>.
+     * Always returns {@code false}.
      * This method is the default implementation of the
-     * <code>org.omg.CORBA.Object</code> method.
+     * {@code org.omg.CORBA.Object} method.
      *
-     * @return <code>false</code>
+     * @return {@code false}
      */
     public boolean _non_existent() {
         return false;
@@ -100,9 +100,9 @@
      * Returns a hash value that is consistent for the
      * lifetime of the object, using the given number as the maximum.
      * This method is the default implementation of the
-     * <code>org.omg.CORBA.Object</code> method.
+     * {@code org.omg.CORBA.Object} method.
      *
-     * @param maximum an <code>int</code> identifying maximum value of
+     * @param maximum an {@code int} identifying maximum value of
      *                the hashcode
      * @return this instance's hashcode
      */
@@ -111,13 +111,13 @@
     }
 
     /**
-     * Throws an <code>org.omg.CORBA.NO_IMPLEMENT</code> exception with
+     * Throws an {@code org.omg.CORBA.NO_IMPLEMENT} exception with
      * the message "This is a locally constrained object."  This method
      * does not apply to local objects and is therefore not implemented.
      * This method is the default implementation of the
-     * <code>org.omg.CORBA.Object</code> method.
+     * {@code org.omg.CORBA.Object} method.
      *
-     * @param repository_id a <code>String</code>
+     * @param repository_id a {@code String}
      * @return NO_IMPLEMENT because this is a locally constrained object
      *      and this method does not apply to local objects
      * @exception NO_IMPLEMENT because this is a locally constrained object
@@ -130,12 +130,12 @@
     }
 
     /**
-     * Throws an <code>org.omg.CORBA.NO_IMPLEMENT</code> exception with
+     * Throws an {@code org.omg.CORBA.NO_IMPLEMENT} exception with
      * the message "This is a locally constrained object."
      * This method is the default implementation of the
-     * <code>org.omg.CORBA.Object</code> method.
+     * {@code org.omg.CORBA.Object} method.
      *
-     * @return a duplicate of this <code>LocalObject</code> instance.
+     * @return a duplicate of this {@code LocalObject} instance.
      * @exception NO_IMPLEMENT
      * @see <a href="package-summary.html#unimpl"><code>CORBA</code> package
      *      comments for unimplemented features</a>
@@ -145,10 +145,10 @@
     }
 
     /**
-     * Throws an <code>org.omg.CORBA.NO_IMPLEMENT</code> exception with
+     * Throws an {@code org.omg.CORBA.NO_IMPLEMENT} exception with
      * the message "This is a locally constrained object."
      * This method is the default implementation of the
-     * <code>org.omg.CORBA.Object</code> method.
+     * {@code org.omg.CORBA.Object} method.
      *
      * @exception NO_IMPLEMENT
      * @see <a href="package-summary.html#unimpl"><code>CORBA</code> package
@@ -159,14 +159,14 @@
     }
 
     /**
-     * Throws an <code>org.omg.CORBA.NO_IMPLEMENT</code> exception with
+     * Throws an {@code org.omg.CORBA.NO_IMPLEMENT} exception with
      * the message "This is a locally constrained object."
      * This method is the default implementation of the
-     * <code>org.omg.CORBA.Object</code> method.
+     * {@code org.omg.CORBA.Object} method.
      *
-     * @param operation a <code>String</code> giving the name of an operation
+     * @param operation a {@code String} giving the name of an operation
      *        to be performed by the request that is returned
-     * @return a <code>Request</code> object with the given operation
+     * @return a {@code Request} object with the given operation
      * @exception NO_IMPLEMENT
      * @see <a href="package-summary.html#unimpl"><code>CORBA</code> package
      *      comments for unimplemented features</a>
@@ -176,20 +176,20 @@
     }
 
     /**
-     * Throws an <code>org.omg.CORBA.NO_IMPLEMENT</code> exception with
+     * Throws an {@code org.omg.CORBA.NO_IMPLEMENT} exception with
      * the message "This is a locally constrained object."
      * This method is the default implementation of the
-     * <code>org.omg.CORBA.Object</code> method.
+     * {@code org.omg.CORBA.Object} method.
      *
-     * @param ctx          a <code>Context</code> object containing
+     * @param ctx          a {@code Context} object containing
      *                     a list of properties
-     * @param operation    the <code>String</code> representing the name of the
+     * @param operation    the {@code String} representing the name of the
      *                     method to be invoked
-     * @param arg_list     an <code>NVList</code> containing the actual arguments
+     * @param arg_list     an {@code NVList} containing the actual arguments
      *                     to the method being invoked
-     * @param result       a <code>NamedValue</code> object to serve as a
+     * @param result       a {@code NamedValue} object to serve as a
      *                     container for the method's return value
-     * @return a new <code>Request</code> object initialized with the given
+     * @return a new {@code Request} object initialized with the given
      * arguments
      * @exception NO_IMPLEMENT
      * @see <a href="package-summary.html#unimpl"><code>CORBA</code> package
@@ -203,25 +203,25 @@
     }
 
     /**
-     * Throws an <code>org.omg.CORBA.NO_IMPLEMENT</code> exception with
+     * Throws an {@code org.omg.CORBA.NO_IMPLEMENT} exception with
      * the message "This is a locally constrained object."
      * This method is the default implementation of the
-     * <code>org.omg.CORBA.Object</code> method.
+     * {@code org.omg.CORBA.Object} method.
      *
-     * @param ctx          a <code>Context</code> object containing
+     * @param ctx          a {@code Context} object containing
      *                     a list of properties
      * @param operation    the name of the method to be invoked
-     * @param arg_list     an <code>NVList</code> containing the actual arguments
+     * @param arg_list     an {@code NVList} containing the actual arguments
      *                     to the method being invoked
-     * @param result       a <code>NamedValue</code> object to serve as a
+     * @param result       a {@code NamedValue} object to serve as a
      *                     container for the method's return value
-     * @param exceptions   an <code>ExceptionList</code> object containing a
+     * @param exceptions   an {@code ExceptionList} object containing a
      *                     list of possible exceptions the method can throw
-     * @param contexts     a <code>ContextList</code> object containing a list of
+     * @param contexts     a {@code ContextList} object containing a list of
      *                     context strings that need to be resolved and sent
      *                     with the
-     *                     <code>Request</code> instance
-     * @return the new <code>Request</code> object initialized with the given
+     *                     {@code Request} instance
+     * @return the new {@code Request} object initialized with the given
      * arguments
      * @exception NO_IMPLEMENT
      * @see <a href="package-summary.html#unimpl"><code>CORBA</code> package
@@ -237,11 +237,11 @@
     }
 
     /**
-     * Throws an <code>org.omg.CORBA.NO_IMPLEMENT</code> exception with
+     * Throws an {@code org.omg.CORBA.NO_IMPLEMENT} exception with
      * the message "This is a locally constrained object." This method
      * does not apply to local objects and is therefore not implemented.
      * This method is the default implementation of the
-     * <code>org.omg.CORBA.Object</code> method.
+     * {@code org.omg.CORBA.Object} method.
      *
      * @return NO_IMPLEMENT because this is a locally constrained object
      *      and this method does not apply to local objects
@@ -256,10 +256,10 @@
     }
 
     /**
-     * Throws an <code>org.omg.CORBA.NO_IMPLEMENT</code> exception with
+     * Throws an {@code org.omg.CORBA.NO_IMPLEMENT} exception with
      * the message "This is a locally constrained object."
      * This method is the default implementation of the
-     * <code>org.omg.CORBA.Object</code> method.
+     * {@code org.omg.CORBA.Object} method.
      *
      * @exception NO_IMPLEMENT
      * @see <a href="package-summary.html#unimpl"><code>CORBA</code> package
@@ -278,12 +278,12 @@
     }
 
     /**
-     * Throws an <code>org.omg.CORBA.NO_IMPLEMENT</code> exception with
+     * Throws an {@code org.omg.CORBA.NO_IMPLEMENT} exception with
      * the message "This is a locally constrained object."
      * This method is the default implementation of the
-     * <code>org.omg.CORBA.Object</code> method.
+     * {@code org.omg.CORBA.Object} method.
      * @return the ORB instance that created the Delegate contained in this
-     * <code>ObjectImpl</code>
+     * {@code ObjectImpl}
      * @exception NO_IMPLEMENT
      * @see <a href="package-summary.html#unimpl"><code>CORBA</code> package
      *      comments for unimplemented features</a>
@@ -293,13 +293,13 @@
     }
 
     /**
-     * Throws an <code>org.omg.CORBA.NO_IMPLEMENT</code> exception with
+     * Throws an {@code org.omg.CORBA.NO_IMPLEMENT} exception with
      * the message "This is a locally constrained object." This method
      * does not apply to local objects and is therefore not implemented.
      * This method is the default implementation of the
-     * <code>org.omg.CORBA.Object</code> method.
+     * {@code org.omg.CORBA.Object} method.
      *
-     * @param policy_type  an <code>int</code>
+     * @param policy_type  an {@code int}
      * @return NO_IMPLEMENT because this is a locally constrained object
      *      and this method does not apply to local objects
      * @exception NO_IMPLEMENT because this is a locally constrained object
@@ -313,11 +313,11 @@
 
 
     /**
-     * Throws an <code>org.omg.CORBA.NO_IMPLEMENT</code> exception with
+     * Throws an {@code org.omg.CORBA.NO_IMPLEMENT} exception with
      * the message "This is a locally constrained object." This method
      * does not apply to local objects and is therefore not implemented.
      * This method is the default implementation of the
-     * <code>org.omg.CORBA.Object</code> method.
+     * {@code org.omg.CORBA.Object} method.
      *
      * @exception NO_IMPLEMENT
      * @see <a href="package-summary.html#unimpl"><code>CORBA</code> package
@@ -328,11 +328,11 @@
     }
 
     /**
-     * Throws an <code>org.omg.CORBA.NO_IMPLEMENT</code> exception with
+     * Throws an {@code org.omg.CORBA.NO_IMPLEMENT} exception with
      * the message "This is a locally constrained object." This method
      * does not apply to local objects and is therefore not implemented.
      * This method is the default implementation of the
-     * <code>org.omg.CORBA.Object</code> method.
+     * {@code org.omg.CORBA.Object} method.
      *
      * @param policies an array
      * @param set_add a flag
@@ -351,13 +351,13 @@
 
 
     /**
-     * Throws an <code>org.omg.CORBA.NO_IMPLEMENT</code> exception with
+     * Throws an {@code org.omg.CORBA.NO_IMPLEMENT} exception with
      * the message "This is a locally constrained object."
      * This method is the default implementation of the
-     * <code>org.omg.CORBA.Object</code> method.<P>
-     * Returns <code>true</code> for this <code>LocalObject</code> instance.
+     * {@code org.omg.CORBA.Object} method.<P>
+     * Returns {@code true} for this {@code LocalObject} instance.
      *
-     * @return <code>true</code> always
+     * @return {@code true} always
      * @exception NO_IMPLEMENT
      * @see <a href="package-summary.html#unimpl"><code>CORBA</code> package
      *      comments for unimplemented features</a>
@@ -367,12 +367,12 @@
     }
 
     /**
-     * Throws an <code>org.omg.CORBA.NO_IMPLEMENT</code> exception with
+     * Throws an {@code org.omg.CORBA.NO_IMPLEMENT} exception with
      * the message "This is a locally constrained object."
      * This method is the default implementation of the
-     * <code>org.omg.CORBA.Object</code> method.
+     * {@code org.omg.CORBA.Object} method.
      *
-     * @param operation a <code>String</code> indicating which operation
+     * @param operation a {@code String} indicating which operation
      *                  to preinvoke
      * @param expectedType the class of the type of operation mentioned above
      * @return NO_IMPLEMENT because this is a locally constrained object
@@ -388,10 +388,10 @@
     }
 
     /**
-     * Throws an <code>org.omg.CORBA.NO_IMPLEMENT</code> exception with
+     * Throws an {@code org.omg.CORBA.NO_IMPLEMENT} exception with
      * the message "This is a locally constrained object."
      * This method is the default implementation of the
-     * <code>org.omg.CORBA.Object</code> method.
+     * {@code org.omg.CORBA.Object} method.
      *
      * @param servant the servant object on which to post-invoke
      * @exception NO_IMPLEMENT
@@ -408,17 +408,17 @@
      */
 
     /**
-     * Throws an <code>org.omg.CORBA.NO_IMPLEMENT</code> exception with
+     * Throws an {@code org.omg.CORBA.NO_IMPLEMENT} exception with
      * the message "This is a locally constrained object."
      * This method is the default implementation of the
-     * <code>org.omg.CORBA.Object</code> method.
+     * {@code org.omg.CORBA.Object} method.
      * <P>Called by a stub to obtain an OutputStream for
      * marshaling arguments. The stub must supply the operation name,
      * and indicate if a response is expected (i.e is this a oneway call).
      *
      * @param operation the name of the operation being requested
-     * @param responseExpected <code>true</code> if a response is expected,
-     *                         <code>false</code> if it is a one-way call
+     * @param responseExpected {@code true} if a response is expected,
+     *                         {@code false} if it is a one-way call
      * @return NO_IMPLEMENT because this is a locally constrained object
      *      and this method does not apply to local objects
      * @exception NO_IMPLEMENT because this is a locally constrained object
@@ -432,32 +432,32 @@
     }
 
     /**
-     * Throws an <code>org.omg.CORBA.NO_IMPLEMENT</code> exception with
+     * Throws an {@code org.omg.CORBA.NO_IMPLEMENT} exception with
      * the message "This is a locally constrained object."
      * This method is the default implementation of the
-     * <code>org.omg.CORBA.Object</code> method.
+     * {@code org.omg.CORBA.Object} method.
      * <P>Called to invoke an operation. The stub provides an
-     * <code>OutputStream</code> that was previously returned by a
-     * <code>_request()</code>
-     * call. <code>_invoke</code> returns an <code>InputStream</code> which
+     * {@code OutputStream} that was previously returned by a
+     * {@code _request()}
+     * call. {@code _invoke} returns an {@code InputStream} which
      * contains the
-     * marshaled reply. If an exception occurs, <code>_invoke</code> may throw an
-     * <code>ApplicationException</code> object which contains an
-     * <code>InputStream</code> from
+     * marshaled reply. If an exception occurs, {@code _invoke} may throw an
+     * {@code ApplicationException} object which contains an
+     * {@code InputStream} from
      * which the user exception state may be unmarshaled.
      *
-     * @param output the <code>OutputStream</code> to invoke
+     * @param output the {@code OutputStream} to invoke
      * @return NO_IMPLEMENT because this is a locally constrained object
      *      and this method does not apply to local objects
      * @throws ApplicationException If an exception occurs,
-     * <code>_invoke</code> may throw an
-     * <code>ApplicationException</code> object which contains
-     * an <code>InputStream</code> from
+     * {@code _invoke} may throw an
+     * {@code ApplicationException} object which contains
+     * an {@code InputStream} from
      * which the user exception state may be unmarshaled.
      * @throws RemarshalException If an exception occurs,
-     * <code>_invoke</code> may throw an
-     * <code>ApplicationException</code> object which contains
-     * an <code>InputStream</code> from
+     * {@code _invoke} may throw an
+     * {@code ApplicationException} object which contains
+     * an {@code InputStream} from
      * which the user exception state may be unmarshaled.
      * @exception NO_IMPLEMENT because this is a locally constrained object
      *      and this method does not apply to local objects
@@ -471,17 +471,17 @@
     }
 
     /**
-     * Throws an <code>org.omg.CORBA.NO_IMPLEMENT</code> exception with
+     * Throws an {@code org.omg.CORBA.NO_IMPLEMENT} exception with
      * the message "This is a locally constrained object."
      * This method is the default implementation of the
-     * <code>org.omg.CORBA.Object</code> method.
+     * {@code org.omg.CORBA.Object} method.
      * <P>May optionally be called by a stub to release a
      * reply stream back to the ORB when the unmarshaling has
-     * completed. The stub passes the <code>InputStream</code> returned by
-     * <code>_invoke()</code> or
-     * <code>ApplicationException.getInputStream()</code>.
+     * completed. The stub passes the {@code InputStream} returned by
+     * {@code _invoke()} or
+     * {@code ApplicationException.getInputStream()}.
      * A null
-     * value may also be passed to <code>_releaseReply</code>, in which case the
+     * value may also be passed to {@code _releaseReply}, in which case the
      * method is a no-op.
      *
      * @param input the reply stream back to the ORB or null
@@ -494,11 +494,11 @@
     }
 
     /**
-     * Throws an <code>org.omg.CORBA.NO_IMPLEMENT</code> exception with
+     * Throws an {@code org.omg.CORBA.NO_IMPLEMENT} exception with
      * the message "This is a locally constrained object." This method
      * does not apply to local objects and is therefore not implemented.
      * This method is the default implementation of the
-     * <code>org.omg.CORBA.Object</code> method.
+     * {@code org.omg.CORBA.Object} method.
      *
      * @return NO_IMPLEMENT because this is a locally constrained object
      *      and this method does not apply to local objects