stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8079075: some docs cleanup for CORBA - part 1

Browse Source 
Some fix for CORBA docs

Reviewed-by: rriggs
This commit is contained in:
Alexander Stepanov 2015-05-05 15:17:13 +04:00
parent cbb7a567ca
commit 9e57400034
86 changed files with 155 additions and 397 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
corba/src/java.corba/share/classes/com/sun/corba/se/impl/corba/AnyImpl.java
View File

@ -222,7 +222,7 @@ public class AnyImpl extends Any
/**
* returns the type of the element contained in the Any.
*
* @result the TypeCode for the element in the Any
* @return the TypeCode for the element in the Any
*/
public TypeCode type() {
return typeCode;
@ -267,7 +267,7 @@ public class AnyImpl extends Any
* checks for equality between Anys.
*
* @param otherAny the Any to be compared with.
* @result true if the Anys are equal, false otherwise.
* @return true if the Anys are equal, false otherwise.
*/
public boolean equal(Any otherAny)
{
@ -508,7 +508,7 @@ public class AnyImpl extends Any
/**
* returns an output stream that an Any value can be marshaled into.
*
* @result the OutputStream to marshal value of Any into
* @return the OutputStream to marshal value of Any into
*/
public org.omg.CORBA.portable.OutputStream create_output_stream()
{
@ -525,7 +525,7 @@ public class AnyImpl extends Any
/**
* returns an input stream that an Any value can be marshaled out of.
*
* @result the InputStream to marshal value of Any out of.
* @return the InputStream to marshal value of Any out of.
*/
public org.omg.CORBA.portable.InputStream create_input_stream()
{

2
corba/src/java.corba/share/classes/com/sun/corba/se/impl/encoding/CDROutputObject.java
View File

@ -166,7 +166,7 @@ public class CDROutputObject extends CorbaOutputObject
* Write the contents of the CDROutputStream to the specified
* output stream. Has the side-effect of pushing any current
* Message onto the Message list.
* @param s The output stream to write to.
* @param connection The output stream to write to.
*/
public void writeTo(CorbaConnection connection)
throws java.io.IOException

5
corba/src/java.corba/share/classes/com/sun/corba/se/impl/encoding/CodeSetConversion.java
View File

@ -54,8 +54,9 @@ import com.sun.corba.se.spi.logging.CORBALogDomains;
* use NIO ByteBuffer and NIO CharBuffer, the interaction
* and interface between this class and the CDR streams
* should be looked at more closely for optimizations to
* avoid unnecessary copying of data between char[] &
* CharBuffer and byte[] & ByteBuffer, especially
* avoid unnecessary copying of data between
* {@code char[] & CharBuffer} and
* {@code byte[] & ByteBuffer}, especially
* DirectByteBuffers.
*
*/

1
corba/src/java.corba/share/classes/com/sun/corba/se/impl/ior/GenericIdentifiable.java
View File

@ -33,7 +33,6 @@ import org.omg.CORBA_2_3.portable.OutputStream;
import com.sun.corba.se.spi.ior.Identifiable ;
/**
* @author
* This is used for unknown components and profiles. A TAG_MULTICOMPONENT_PROFILE will be represented this way.
*/
public abstract class GenericIdentifiable implements Identifiable

5
corba/src/java.corba/share/classes/com/sun/corba/se/impl/ior/GenericTaggedComponent.java
View File

@ -34,9 +34,6 @@ import com.sun.corba.se.spi.ior.iiop.GIOPVersion ;
import com.sun.corba.se.spi.ior.TaggedComponent ;
/**
* @author
*/
public class GenericTaggedComponent extends GenericIdentifiable
implements TaggedComponent
{
@ -52,8 +49,6 @@ public class GenericTaggedComponent extends GenericIdentifiable
/**
* @return org.omg.IOP.TaggedComponent
* @exception
* @author
*/
public org.omg.IOP.TaggedComponent getIOPComponent( ORB orb )
{

3
corba/src/java.corba/share/classes/com/sun/corba/se/impl/ior/GenericTaggedProfile.java
View File

@ -39,9 +39,6 @@ import com.sun.corba.se.spi.ior.iiop.GIOPVersion ;
import com.sun.corba.se.impl.encoding.EncapsOutputStream ;
/**
* @author
*/
public class GenericTaggedProfile extends GenericIdentifiable implements TaggedProfile
{
private ORB orb ;

1
corba/src/java.corba/share/classes/com/sun/corba/se/impl/ior/IORTemplateImpl.java
View File

@ -47,7 +47,6 @@ import com.sun.corba.se.spi.orb.ORB ;
/**
* This class is a container of TaggedProfileTemplates.
* @author
*/
public class IORTemplateImpl extends IdentifiableContainerBase implements IORTemplate
{

2
corba/src/java.corba/share/classes/com/sun/corba/se/impl/ior/ObjectAdapterIdNumber.java
View File

@ -31,7 +31,7 @@ import org.omg.CORBA_2_3.portable.OutputStream ;
/** ObjectAdapterIdNumber is used to represent pre-JDK 1.4 POA adapter
* IDs. The POA ID was simply represented as a single integer, which was
* mapped to the actual POA instance. Here, we just represent these
* internally as arrays of the form { "OldRootPOA", "<number>" },
* internally as arrays of the form {@code { "OldRootPOA", "<number>" }},
* and provide an extra method to get the number back.
*/
public class ObjectAdapterIdNumber extends ObjectAdapterIdArray {

3
corba/src/java.corba/share/classes/com/sun/corba/se/impl/ior/ObjectIdImpl.java
View File

@ -29,9 +29,6 @@ import java.util.Arrays ;
import com.sun.corba.se.spi.ior.ObjectId ;
import org.omg.CORBA_2_3.portable.OutputStream ;
/**
* @author
*/
public final class ObjectIdImpl implements ObjectId
{
private byte[] id;

3
corba/src/java.corba/share/classes/com/sun/corba/se/impl/ior/ObjectKeyTemplateBase.java
View File

@ -47,9 +47,6 @@ import com.sun.corba.se.impl.encoding.EncapsOutputStream ;
import com.sun.corba.se.impl.logging.IORSystemException ;
/**
* @author
*/
public abstract class ObjectKeyTemplateBase implements ObjectKeyTemplate
{
// Fixed constants for Java IDL object key template forms

3
corba/src/java.corba/share/classes/com/sun/corba/se/impl/ior/POAObjectKeyTemplate.java
View File

@ -42,9 +42,6 @@ import com.sun.corba.se.spi.ior.ObjectAdapterId ;
import com.sun.corba.se.impl.ior.ObjectKeyFactoryImpl ;
/**
* @author
*/
public final class POAObjectKeyTemplate extends NewObjectKeyTemplateBase
{
/** This constructor reads the template ONLY from the stream.

2
corba/src/java.corba/share/classes/com/sun/corba/se/impl/ior/StubIORImpl.java
View File

@ -245,7 +245,7 @@ public class StubIORImpl
/**
* Returns a string representation of this stub. Returns the same string
* for all stubs that represent the same remote object.
* "SimpleIORImpl[<typeName>,[<profileID>]data, ...]"
* {@code "SimpleIORImpl[<typeName>,[<profileID>]data, ...]"}
* @return a string representation of this stub.
*/
public String toString()

3
corba/src/java.corba/share/classes/com/sun/corba/se/impl/ior/TaggedProfileFactoryFinderImpl.java
View File

@ -33,9 +33,6 @@ import com.sun.corba.se.impl.ior.IdentifiableFactoryFinderBase ;
import org.omg.CORBA_2_3.portable.InputStream ;
/**
* @author
*/
public class TaggedProfileFactoryFinderImpl extends
IdentifiableFactoryFinderBase
{

3
corba/src/java.corba/share/classes/com/sun/corba/se/impl/ior/iiop/CodeSetsComponentImpl.java
View File

@ -38,9 +38,6 @@ import com.sun.corba.se.impl.encoding.CodeSetComponentInfo ;
import com.sun.corba.se.impl.encoding.MarshalOutputStream ;
import com.sun.corba.se.impl.encoding.MarshalInputStream ;
/**
* @author
*/
public class CodeSetsComponentImpl extends TaggedComponentBase
implements CodeSetsComponent
{

3
corba/src/java.corba/share/classes/com/sun/corba/se/impl/ior/iiop/IIOPAddressBase.java
View File

@ -32,9 +32,6 @@ import org.omg.CORBA_2_3.portable.OutputStream ;
import com.sun.corba.se.spi.ior.iiop.IIOPAddress ;
/**
* @author
*/
abstract class IIOPAddressBase implements IIOPAddress
{
// Ports are marshalled as shorts on the wire. The IDL

3
corba/src/java.corba/share/classes/com/sun/corba/se/impl/ior/iiop/IIOPAddressClosureImpl.java
View File

@ -32,9 +32,6 @@ import org.omg.CORBA_2_3.portable.OutputStream ;
import com.sun.corba.se.spi.orbutil.closure.Closure ;
/**
* @author
*/
public final class IIOPAddressClosureImpl extends IIOPAddressBase
{
private Closure host;

3
corba/src/java.corba/share/classes/com/sun/corba/se/impl/ior/iiop/IIOPAddressImpl.java
View File

@ -36,9 +36,6 @@ import com.sun.corba.se.spi.logging.CORBALogDomains ;
import com.sun.corba.se.impl.logging.IORSystemException ;
/**
* @author
*/
public final class IIOPAddressImpl extends IIOPAddressBase
{
private ORB orb ;

3
corba/src/java.corba/share/classes/com/sun/corba/se/impl/ior/iiop/IIOPProfileImpl.java
View File

@ -76,9 +76,6 @@ import com.sun.corba.se.impl.util.JDKBridge;
import com.sun.corba.se.impl.logging.IORSystemException;
/**
* @author
*/
public class IIOPProfileImpl extends IdentifiableBase implements IIOPProfile
{
private ORB orb ;

1
corba/src/java.corba/share/classes/com/sun/corba/se/impl/ior/iiop/IIOPProfileTemplateImpl.java
View File

@ -55,7 +55,6 @@ import com.sun.corba.se.spi.ior.iiop.GIOPVersion ;
import com.sun.corba.se.spi.orb.ORB ;
/**
* @author
* If getMinorVersion==0, this does not contain any tagged components
*/
public class IIOPProfileTemplateImpl extends TaggedProfileTemplateBase

3
corba/src/java.corba/share/classes/com/sun/corba/se/impl/ior/iiop/JavaCodebaseComponentImpl.java
View File

@ -33,9 +33,6 @@ import com.sun.corba.se.spi.ior.TaggedComponentBase ;
import com.sun.corba.se.spi.ior.iiop.JavaCodebaseComponent ;
/**
* @author
*/
public class JavaCodebaseComponentImpl extends TaggedComponentBase
implements JavaCodebaseComponent
{

2
corba/src/java.corba/share/classes/com/sun/corba/se/impl/naming/cosnaming/BindingIteratorImpl.java
View File

@ -92,7 +92,7 @@ public abstract class BindingIteratorImpl extends BindingIteratorPOA
* Return the next n bindings. It also returns true or false, indicating
* whether there were more bindings.
* @param how_many The number of requested bindings in the BindingList.
* @param bl The BindingList as an out parameter.
* @param blh The BindingList as an out parameter.
* @return true if there were more bindings.
* @exception org.omg.CORBA.SystemException One of a fixed set of CORBA
* system exceptions.

2
corba/src/java.corba/share/classes/com/sun/corba/se/impl/naming/cosnaming/NamingUtils.java
View File

@ -90,7 +90,7 @@ public class NamingUtils {
/**
* Create a error print stream to the supplied file.
* @param logFile the file to which error messages will go.
* @param errFile the file to which error messages will go.
* @exception IOException thrown if the file cannot be opened for output.
*/
public static void makeErrStream(File errFile)

2
corba/src/java.corba/share/classes/com/sun/corba/se/impl/naming/namingutil/CorbanameURL.java
View File

@ -33,7 +33,7 @@ import com.sun.corba.se.spi.logging.CORBALogDomains;
* will be stored in this object. This object is capable of storing CorbaLoc
* profiles as defined in the CorbaName grammer.
*
* @Author Hemanth
* @author Hemanth
*/
public class CorbanameURL extends INSURLBase
{

2
corba/src/java.corba/share/classes/com/sun/corba/se/impl/naming/namingutil/IIOPEndpointInfo.java
View File

@ -32,7 +32,7 @@ import com.sun.corba.se.impl.orbutil.ORBConstants;
* host information used in creating the Service Object reference
* from the -ORBInitDef and -ORBDefaultInitDef definitions.
*
* @Author Hemanth
* @author Hemanth
*/
public class IIOPEndpointInfo
{

2
corba/src/java.corba/share/classes/com/sun/corba/se/impl/naming/namingutil/INSURL.java
View File

@ -29,7 +29,7 @@ package com.sun.corba.se.impl.naming.namingutil;
* INS URL is a generic interface for two different types of URL's specified
* in INS spec.
*
* @Author Hemanth
* @author Hemanth
*/
public interface INSURL {
public boolean getRIRFlag( );

2
corba/src/java.corba/share/classes/com/sun/corba/se/impl/naming/namingutil/INSURLHandler.java
View File

@ -30,7 +30,7 @@ import java.util.StringTokenizer;
/**
* This class is the entry point to parse different types of INS URL's.
*
* @Author Hemanth
* @author Hemanth
*/
public class INSURLHandler {

2
corba/src/java.corba/share/classes/com/sun/corba/se/impl/naming/namingutil/Utility.java
View File

@ -36,7 +36,7 @@ import com.sun.corba.se.spi.logging.CORBALogDomains;
/**
* Utility methods for Naming.
*
* @Author Hemanth
* @author Hemanth
*/
class Utility {
private static NamingSystemException wrapper =

4
corba/src/java.corba/share/classes/com/sun/corba/se/impl/naming/pcosnaming/NameService.java
View File

@ -186,7 +186,7 @@ public class NameService
/**
* getObjectReferenceFromKey returns the Object reference from the objectkey using POA.create_reference_with_id method
* @param Object Key as String
* @returns reference an CORBA.Object.
* @return a CORBA.Object reference.
*/
org.omg.CORBA.Object getObjectReferenceFromKey( String key )
{
@ -205,7 +205,7 @@ public class NameService
/**
* getObjectKey gets the Object Key from the reference using POA.reference_to_id method
* @param reference an CORBA.Object.
* @returns Object Key as String
* @return Object Key as String
*/
String getObjectKey( org.omg.CORBA.Object reference )
{

28
corba/src/java.corba/share/classes/com/sun/corba/se/impl/naming/pcosnaming/NamingContextImpl.java
View File

@ -1140,10 +1140,9 @@ public class NamingContextImpl
/**
* This operation creates a stringified name from the array of Name
* components.
* @param n Name of the object <p>
* @param n Name of the object
* @exception org.omg.CosNaming.NamingContextExtPackage.InvalidName
* Indicates the name does not identify a binding.<p>
*
* Indicates the name does not identify a binding.
*/
public String to_string(org.omg.CosNaming.NameComponent[] n)
throws org.omg.CosNaming.NamingContextPackage.InvalidName
@ -1167,10 +1166,9 @@ public class NamingContextImpl
/**
* This operation converts a Stringified Name into an equivalent array
* of Name Components.
* @param sn Stringified Name of the object <p>
* @param sn Stringified Name of the object
* @exception org.omg.CosNaming.NamingContextExtPackage.InvalidName
* Indicates the name does not identify a binding.<p>
*
* Indicates the name does not identify a binding.
*/
public org.omg.CosNaming.NameComponent[] to_name(String sn)
throws org.omg.CosNaming.NamingContextPackage.InvalidName
@ -1204,14 +1202,13 @@ public class NamingContextImpl
* This operation creates a URL based "iiopname://" format name
* from the Stringified Name of the object.
* @param addr internet based address of the host machine where
* Name Service is running <p>
* @param sn Stringified Name of the object <p>
* Name Service is running
* @param sn Stringified Name of the object
* @exception org.omg.CosNaming.NamingContextExtPackage.InvalidName
* Indicates the name does not identify a binding.<p>
* Indicates the name does not identify a binding.
* @exception org.omg.CosNaming.NamingContextPackage.InvalidAddress
* Indicates the internet based address of the host machine is
* incorrect <p>
*
* incorrect
*/
public String to_url(String addr, String sn)
@ -1247,14 +1244,13 @@ public class NamingContextImpl
/**
* This operation resolves the Stringified name into the object
* reference.
* @param sn Stringified Name of the object <p>
* @param sn Stringified Name of the object
* @exception org.omg.CosNaming.NamingContextPackage.NotFound
* Indicates there is no object reference for the given name. <p>
* Indicates there is no object reference for the given name.
* @exception org.omg.CosNaming.NamingContextPackage.CannotProceed
* Indicates that the given compound name is incorrect <p>
* Indicates that the given compound name is incorrect
* @exception org.omg.CosNaming.NamingContextExtPackage.InvalidName
* Indicates the name does not identify a binding.<p>
*
* Indicates the name does not identify a binding.
*/
public org.omg.CORBA.Object resolve_str(String sn)
throws org.omg.CosNaming.NamingContextPackage.NotFound,

16
corba/src/java.corba/share/classes/com/sun/corba/se/impl/orb/ORBImpl.java
View File

@ -585,7 +585,7 @@ public class ORBImpl extends com.sun.corba.se.spi.orb.ORB
* Create an NVList
*
* @param count size of list to create
* @result NVList created
* @return NVList created
*
* @see NVList
*/
@ -599,7 +599,7 @@ public class ORBImpl extends com.sun.corba.se.spi.orb.ORB
* Create an NVList corresponding to an OperationDef
*
* @param oper operation def to use to create list
* @result NVList created
* @return NVList created
*
* @see NVList
*/
@ -612,7 +612,7 @@ public class ORBImpl extends com.sun.corba.se.spi.orb.ORB
/**
* Create a NamedValue
*
* @result NamedValue created
* @return NamedValue created
*/
public synchronized NamedValue create_named_value(String s, Any any, int flags)
{
@ -623,7 +623,7 @@ public class ORBImpl extends com.sun.corba.se.spi.orb.ORB
/**
* Create an ExceptionList
*
* @result ExceptionList created
* @return ExceptionList created
*/
public synchronized org.omg.CORBA.ExceptionList create_exception_list()
{
@ -634,7 +634,7 @@ public class ORBImpl extends com.sun.corba.se.spi.orb.ORB
/**
* Create a ContextList
*
* @result ContextList created
* @return ContextList created
*/
public synchronized org.omg.CORBA.ContextList create_context_list()
{
@ -645,7 +645,7 @@ public class ORBImpl extends com.sun.corba.se.spi.orb.ORB
/**
* Get the default Context object
*
* @result the default Context object
* @return the default Context object
*/
public synchronized org.omg.CORBA.Context get_default_context()
{
@ -656,7 +656,7 @@ public class ORBImpl extends com.sun.corba.se.spi.orb.ORB
/**
* Create an Environment
*
* @result Environment created
* @return Environment created
*/
public synchronized org.omg.CORBA.Environment create_environment()
{
@ -719,7 +719,7 @@ public class ORBImpl extends com.sun.corba.se.spi.orb.ORB
/**
* Get the next request that has gotten a response.
*
* @result the next request ready with a response.
* @return the next request ready with a response.
*/
public org.omg.CORBA.Request get_next_response()
throws org.omg.CORBA.WrongTransaction

4
corba/src/java.corba/share/classes/com/sun/corba/se/impl/orbutil/GetPropertyAction.java
View File

@ -35,7 +35,7 @@ package com.sun.corba.se.impl.orbutil ;
* <code>AccessController.doPrivileged</code>.
*
* <p>The following code retrieves the value of the system
* property named <code>"prop"</code> as a privileged action: <p>
* property named <code>"prop"</code> as a privileged action:
*
* <pre>
* String s = (String) java.security.AccessController.doPrivileged(
@ -67,7 +67,7 @@ public class GetPropertyAction implements java.security.PrivilegedAction {
* value of that property.
*
* @param theProp the name of the system property.
* @param defaulVal the default value.
* @param defaultVal the default value.
*/
public GetPropertyAction(String theProp, String defaultVal) {
this.theProp = theProp;

1
corba/src/java.corba/share/classes/com/sun/corba/se/impl/orbutil/concurrent/Mutex.java
View File

@ -126,7 +126,6 @@ package com.sun.corba.se.impl.orbutil.concurrent;
* // ... other similar traversal and update methods ...
* }
* </pre>
* <p>
* @see Semaphore
* <p>[<a href="http://gee.cs.oswego.edu/dl/classes/EDU/oswego/cs/dl/util/concurrent/intro.html"> Introduction to this package. </a>]
**/

5
corba/src/java.corba/share/classes/com/sun/corba/se/impl/orbutil/concurrent/Sync.java
View File

@ -276,10 +276,9 @@ package com.sun.corba.se.impl.orbutil.concurrent;
* For example, you can use an ObservableSync
* (perhaps as part of a LayeredSync) in order to obtain callbacks
* before and after each method invocation for a given class.
* <p>
*
* <p>[<a href="http://gee.cs.oswego.edu/dl/classes/EDU/oswego/cs/dl/util/concurrent/intro.html"> Introduction to this package. </a>]
**/
**/
public interface Sync {

6
corba/src/java.corba/share/classes/com/sun/corba/se/pept/transport/Acceptor.java
View File

@ -59,7 +59,7 @@ public interface Acceptor
/**
* Used to determine if an <code>Acceptor</code> has been initialized.
*
* @return <code>true</code. if the <code>Acceptor</code> has been
* @return <code>true</code> if the <code>Acceptor</code> has been
* initialized.
*/
public boolean initialized();
@ -74,7 +74,7 @@ public interface Acceptor
/**
* Set the
* {@link com.sun.corba.se.pept.transport.Inbound.ConnectionCache InboundConnectionCache}
* {@link com.sun.corba.se.pept.transport.InboundConnectionCache InboundConnectionCache}
* to be used by this <code>Acceptor</code>.
*
* PEPt uses separate caches for each type of <code>Acceptor</code>
@ -88,7 +88,7 @@ public interface Acceptor
/**
* Get the
* {@link com.sun.corba.se.pept.transport.Inbound.ConnectionCache InboundConnectionCache}
* {@link com.sun.corba.se.pept.transport.InboundConnectionCache InboundConnectionCache}
* used by this <code>Acceptor</code>
*
* PEPt uses separate caches for each type of <code>Acceptor</code>

2
corba/src/java.corba/share/classes/com/sun/corba/se/spi/extension/ServantCachingPolicy.java
View File

@ -44,7 +44,7 @@ import com.sun.corba.se.impl.orbutil.ORBConstants ;
* <ol>
* <li>POA current semantics
* <li>Proper handling of POA destroy.
* <ol>
* </ol>
* POA current semantics requires maintaining a ThreadLocal stack of
* invocation information that is always available for POACurrent operations.
* Maintaining this stack is expensive on the timescale of optimized co-located

3
corba/src/java.corba/share/classes/com/sun/corba/se/spi/legacy/interceptor/RequestInfoExt.java
View File

@ -30,8 +30,7 @@ import com.sun.corba.se.spi.legacy.connection.Connection;
/**
* This interface is implemented by our implementation of
* PortableInterceptor.ClientRequestInfo and
* PortableInterceptor.ServerRequestInfo. <p>
*
* PortableInterceptor.ServerRequestInfo.
*/
public interface RequestInfoExt

14
corba/src/java.corba/share/classes/com/sun/corba/se/spi/monitoring/LongMonitoredAttributeBase.java
View File

@ -27,13 +27,9 @@ package com.sun.corba.se.spi.monitoring;
import java.util.*;
/**
* <p>
*
* @author Hemanth Puttaswamy
* </p>
* <p>
*
* A Cleaner Abstraction to provide a Monitored Attribute of type 'Long'
* </p>
*/
public abstract class LongMonitoredAttributeBase extends MonitoredAttributeBase {
@ -42,20 +38,14 @@ public abstract class LongMonitoredAttributeBase extends MonitoredAttributeBase
/**
* <p>
* Constructs LongMonitoredAttribute, by creating the
* MonitoredAttributeInfo with 'Long' as the class type.
* Users are expected to extend this class and provide the implementation
* for getValue() and if needed clearState() as well.
* </p>
* <p>
*
* @param name of tthe MonitoredAttribute
* </p>
* <p>
* @param name of the MonitoredAttribute
* @param description of the Attribute, Please provid a well thought out
* description, so that the admin can make sense of the attribute supplied.
* </p>
*/
public LongMonitoredAttributeBase(String name, String description) {
super( name );

30
corba/src/java.corba/share/classes/com/sun/corba/se/spi/monitoring/MonitoredAttribute.java
View File

@ -28,15 +28,11 @@ import com.sun.corba.se.spi.monitoring.MonitoredAttributeInfo;
import java.util.*;
/**
* <p>
*
* @author Hemanth Puttaswamy
* </p>
* <p>
*
* Monitored Attribute is the interface to represent a Monitorable
* Attribute. Using this interface, one can get the value of the attribute
* and set the value if it is a writeable attribute.
* </p>
*/
public interface MonitoredAttribute {
@ -44,34 +40,25 @@ public interface MonitoredAttribute {
// operations
/**
* <p>
* Gets the Monitored Attribute Info for the attribute.
* </p>
* <p>
*
* @param monitoredAttributeInfo for this Monitored Attribute.
* </p>
*/
public MonitoredAttributeInfo getAttributeInfo();
/**
* <p>
* Sets the value for the Monitored Attribute if isWritable() is false, the
* method will throw ILLEGAL Operation exception.
*
* Also, the type of 'value' should be same as specified in the
* MonitoredAttributeInfo for a particular instance.
* </p>
* <p>
*
* @param value should be any one of the Basic Java Type Objects which are
* Long, Double, Float, String, Integer, Short, Character, Byte.
* </p>
*/
public void setValue(Object value);
/**
* <p>
* Gets the value of the Monitored Attribute. The value can be obtained
* from different parts of the module. User may choose to delegate the call
* to getValue() to other variables.
@ -79,34 +66,21 @@ public interface MonitoredAttribute {
* NOTE: It is important to make sure that the type of Object returned in
* getvalue is same as the one specified in MonitoredAttributeInfo for this
* attribute.
* </p>
* <p>
*
* </p>
* <p>
*
* @param value is the current value for this MonitoredAttribute
* </p>
*/
public Object getValue();
/**
* <p>
* Gets the name of the Monitored Attribute.
* </p>
* <p>
*
* @param name of this Attribute
* </p>
* @return name of this Attribute
*/
public String getName();
/**
* <p>
* If this attribute needs to be cleared, the user needs to implement this
* method to reset the state to initial state. If the Monitored Attribute
* doesn't change like for example (ConnectionManager High Water Mark),
* then clearState() is a No Op.
* </p>
*
*/
public void clearState();

7
corba/src/java.corba/share/classes/com/sun/corba/se/spi/monitoring/MonitoredAttributeBase.java
View File

@ -27,16 +27,11 @@ package com.sun.corba.se.spi.monitoring;
import java.util.*;
/**
* <p>
*
* @author Hemanth Puttaswamy
* </p>
* <p>
*
* A Convenient class provided to help users extend and implement only
* getValue(), if there is no need to clear the state and the attribute is not
* writable.
*
* </p>
*/
public abstract class MonitoredAttributeBase implements MonitoredAttribute {
String name;

35
corba/src/java.corba/share/classes/com/sun/corba/se/spi/monitoring/MonitoredAttributeInfo.java
View File

@ -27,14 +27,10 @@ package com.sun.corba.se.spi.monitoring;
import java.util.*;
/**
* <p>
*
* @author Hemanth Puttaswamy
* </p>
* <p>
*
* Monitored AttributeInfo contains the meta information of the Monitored
* Attribute.
* </p>
*/
public interface MonitoredAttributeInfo {
@ -42,45 +38,38 @@ public interface MonitoredAttributeInfo {
// operations
/**
* <p>
* If the Attribute is writable from ASAdmin then isWritable() will return
* true.
* </p>
* <p>
*
* @return a boolean with true or false
* </p>
*/
public boolean isWritable();
/**
* <p>
* isStatistic() is true if the attribute is presented as a Statistic.
* </p>
* <p>
*
* @return a boolean with true or false
* </p>
*/
public boolean isStatistic();
/**
* <p>
* Class Type: We will allow only basic class types: 1)Boolean 2)Integer
* 3)Byte 4)Long 5)Float 6)Double 7)String 8)Character
* </p>
* <p>
* Class Type: We will allow only basic class types:
* <ol>
* <li>Boolean</li>
* <li>Integer</li>
* <li>Byte</li>
* <li>Long</li>
* <li>Float</li>
* <li>Double</li>
* <li>String</li>
* <li>Character</li>
* </ol>
*
* @return a Class Type
* </p>
*/
public Class type();
/**
* <p>
* Get's the description for the Monitored Attribute.
* </p>
* <p>
*
* @return a String with description
* </p>
*/
public String getDescription();

7
corba/src/java.corba/share/classes/com/sun/corba/se/spi/monitoring/MonitoredAttributeInfoFactory.java
View File

@ -25,17 +25,12 @@
package com.sun.corba.se.spi.monitoring;
/**
* <p>
*
* @author Hemanth Puttaswamy
* </p>
* <p>
*
* MonitoredAttributeInfoFactory used mostly by internal classes. If the
* User needs to define some special MonitoredAttributes like a Character
* type Monitored Attribute, they can use this factory to build the meta
* information.
*
* </p>
*/
public interface MonitoredAttributeInfoFactory {

64
corba/src/java.corba/share/classes/com/sun/corba/se/spi/monitoring/MonitoredObject.java
View File

@ -30,161 +30,101 @@ import java.util.*;
import java.util.Collection;
/**
* <p>
*
* @author Hemanth Puttaswamy
* </p>
* <p>
*
* Monitored Object provides an Hierarchichal view of the ORB Monitoring
* System. It can contain multiple children and a single parent. Each
* Monitored Object may also contain Multiple Monitored Attributes.
* </p>
*/
public interface MonitoredObject {
///////////////////////////////////////
// operations
/**
* <p>
* Gets the name of this MonitoredObject
* </p><p>
*
* @return a String with name of this Monitored Object
* </p>
*/
public String getName();
/**
* <p>
* Gets the description of MonitoredObject
* </p><p>
*
* @return a String with Monitored Object Description.
* </p>
*/
public String getDescription();
/**
* <p>
* This method will add a child Monitored Object to this Monitored Object.
* </p>
* <p>
* </p>
*/
public void addChild( MonitoredObject m );
/**
* <p>
* This method will remove child Monitored Object identified by the given name
* </p>
* <p>
*
* @param name of the ChildMonitored Object
* </p>
*/
public void removeChild( String name );
/**
* <p>
* Gets the child MonitoredObject associated with this MonitoredObject
* instance using name as the key. The name should be fully qualified name
* like orb.connectionmanager
* </p>
* <p>
*
* @return a MonitoredObject identified by the given name
* </p>
* <p>
* @param name of the ChildMonitored Object
* </p>
*/
public MonitoredObject getChild(String name);
/**
* <p>
* Gets all the Children registered under this instance of Monitored
* Object.
* </p>
* <p>
*
* @return Collection of immediate Children associated with this MonitoredObject.
* </p>
*/
public Collection getChildren();
/**
* <p>
* Sets the parent for this Monitored Object.
* </p>
* <p>
* </p>
*/
public void setParent( MonitoredObject m );
/**
* <p>
* There will be only one parent for an instance of MontoredObject, this
* call gets parent and returns null if the Monitored Object is the root.
* </p>
* <p>
*
* @return a MonitoredObject which is a Parent of this Monitored Object instance
* </p>
*/
public MonitoredObject getParent();
/**
* <p>
* Adds the attribute with the given name.
* </p>
* <p>
*
* </p>
* <p>
* @param value is the MonitoredAttribute which will be set as one of the
* attribute of this MonitoredObject.
* </p>
*/
public void addAttribute(MonitoredAttribute value);
/**
* <p>
* Removes the attribute with the given name.
* </p>
* <p>
*
* </p>
* <p>
* @param name is the MonitoredAttribute name
* </p>
*/
public void removeAttribute(String name);
/**
* <p>
* Gets the Monitored Object registered by the given name
* </p>
*
* <p>
* @return a MonitoredAttribute identified by the given name
* </p>
* <p>
* @param name of the attribute
* </p>
*/
public MonitoredAttribute getAttribute(String name);
/**
* <p>
* Gets all the Monitored Attributes for this Monitored Objects. It doesn't
* include the Child Monitored Object, that needs to be traversed using
* getChild() or getChildren() call.
* </p>
* <p>
*
* @return Collection of all the Attributes for this MonitoredObject
* </p>
*/
public Collection getAttributes();
/**
* <p>
* Clears the state of all the Monitored Attributes associated with the
* Monitored Object. It will also clear the state on all it's child
* Monitored Object. The call to clearState will be initiated from
* CORBAMBean.startMonitoring() call.
* </p>
*
*/
public void clearState();

18
corba/src/java.corba/share/classes/com/sun/corba/se/spi/monitoring/MonitoringFactories.java
View File

@ -29,17 +29,13 @@ import com.sun.corba.se.impl.monitoring.MonitoredAttributeInfoFactoryImpl;
import com.sun.corba.se.impl.monitoring.MonitoringManagerFactoryImpl;
/**
* <p>
*
* @author Hemanth Puttaswamy
* </p>
* <p>
*
* This is used for getting the default factories for
* MonitoredObject, MonitoredAttributeInfo and MonitoringManager. We do not
* expect users to use the MonitoredAttributeInfo factory most of the time
* because the Info is automatically built by StringMonitoredAttributeBase
* and LongMonitoredAttributeBase.
* </p>
*/
public class MonitoringFactories {
///////////////////////////////////////
@ -57,20 +53,15 @@ public class MonitoringFactories {
// operations
/**
* <p>
* Gets the MonitoredObjectFactory
* </p>
* <p>
*
* @return a MonitoredObjectFactory
* </p>
*/
public static MonitoredObjectFactory getMonitoredObjectFactory( ) {
return monitoredObjectFactory;
}
/**
* <p>
* Gets the MonitoredAttributeInfoFactory. The user is not expected to use this
* Factory, since the MonitoredAttributeInfo is internally created by
* StringMonitoredAttributeBase, LongMonitoredAttributeBase and
@ -79,11 +70,8 @@ public class MonitoringFactories {
* build a DoubleMonitoredAttributeBase like LongMonitoredAttributeBase
* and build a MonitoredAttributeInfo required by MonitoredAttributeBase
* internally by using this Factory.
* </p>
* <p>
*
* @return a MonitoredAttributeInfoFactory
* </p>
*/
public static MonitoredAttributeInfoFactory
getMonitoredAttributeInfoFactory( )
@ -92,18 +80,14 @@ public class MonitoringFactories {
}
/**
* <p>
* Gets the MonitoredManagerFactory. The user is not expected to use this
* Factory, since the ORB will be automatically initialized with the
* MonitoringManager.
*
* User can get hold of MonitoringManager associated with ORB by calling
* orb.getMonitoringManager( )
* </p>
* <p>
*
* @return a MonitoredManagerFactory
* </p>
*/
public static MonitoringManagerFactory getMonitoringManagerFactory( ) {
return monitoringManagerFactory;

13
corba/src/java.corba/share/classes/com/sun/corba/se/spi/monitoring/MonitoringManager.java
View File

@ -30,15 +30,11 @@ import com.sun.corba.se.spi.monitoring.MonitoredObject;
import java.util.*;
/**
* <p>
* Monitoring Manager will have a 1 to 1 association with the ORB. This
* gives access to the top level Monitored Object, using which more
* Monitored Objects and Attributes can be added and traversed.
* </p>
* <p>
*
* @author Hemanth Puttaswamy
* </p>
*/
public interface MonitoringManager extends Closeable {
@ -46,23 +42,14 @@ public interface MonitoringManager extends Closeable {
// operations
/**
* <p>
* Gets the Root Monitored Object which contains a Hierarchy Of Monitored
* Objects exposing various Monitorable Attributes of Various modules.
* </p>
* <p>
*
* @param MonitoredObject ...
* </p>
*/
public MonitoredObject getRootMonitoredObject();
/**
* <p>
* Initialize is called whenever there is a start monitoring call to CORBA
* MBean. This will result in triaging initialize to all the
* MonitoredObjects and it's Monitored Attributes.
* </p>
*
*/
public void clearState();

6
corba/src/java.corba/share/classes/com/sun/corba/se/spi/monitoring/MonitoringManagerFactory.java
View File

@ -25,14 +25,10 @@
package com.sun.corba.se.spi.monitoring;
/**
* <p>
*
* @author Hemanth Puttaswamy
* </p>
* <p>
*
* MonitoringObjectFactory is used internally by the ORB, It is not for
* general public use.
* </p>
*/
public interface MonitoringManagerFactory {
/**

19
corba/src/java.corba/share/classes/com/sun/corba/se/spi/monitoring/StatisticMonitoredAttribute.java
View File

@ -27,15 +27,11 @@ package com.sun.corba.se.spi.monitoring;
import java.util.*;
/**
* <p>
*
* @author Hemanth Puttaswamy
* </p>
* <p>
*
* StatisticsMonitoredAttribute is provided as a convenience to collect the
* Statistics of any entity. The getValue() call will be delegated to the
* StatisticsAccumulator set by the user.
* </p>
*/
public class StatisticMonitoredAttribute extends MonitoredAttributeBase {
@ -55,32 +51,19 @@ public class StatisticMonitoredAttribute extends MonitoredAttributeBase {
/**
* <p>
* Constructs the StaisticMonitoredAttribute, builds the required
* MonitoredAttributeInfo with Long as the class type and is always
* readonly attribute.
* </p>
* <p>
*
* @param name Of this attribute
* </p>
* <p>
* @return a StatisticMonitoredAttribute
* </p>
* <p>
* @param desc should provide a good description on the kind of statistics
* collected, a good example is "Connection Response Time Stats will Provide the
* detailed stats based on the samples provided from every request completion
* time"
* </p>
* <p>
* @param s is the StatisticsAcumulator that user will use to accumulate the
* samples and this Attribute Object will get the computed statistics values
* from.
* </p>
* <p>
* @param mutex using which clearState() and getValue() calls need to be locked.
* </p>
*/
public StatisticMonitoredAttribute(String name, String desc,
StatisticsAccumulator s, Object mutex)

25
corba/src/java.corba/share/classes/com/sun/corba/se/spi/monitoring/StatisticsAccumulator.java
View File

@ -27,11 +27,8 @@ package com.sun.corba.se.spi.monitoring;
import java.util.*;
/**
* <p>
*
* @author Hemanth Puttaswamy
* </p>
* <p>
*
* StatisticsAccumulator accumulates the samples provided by the user and
* computes the value of minimum, maximum, sum and sample square sum. When
* the StatisticMonitoredAttribute calls getValue(), it will compute all
@ -42,7 +39,6 @@ import java.util.*;
* Users can easily extend this class and provide the implementation of
* toString() method to format the stats as desired. By default all the stats
* are printed in a single line.
* </p>
*/
public class StatisticsAccumulator {
@ -72,19 +68,12 @@ public class StatisticsAccumulator {
/**
* <p>
* User will use this method to just register a sample with the
* StatisticsAccumulator. This is the only method that User will use to
* expose the statistics, internally the StatisticMonitoredAttribute will
* collect the information when requested from the ASAdmin.
* </p>
* <p>
*
* </p>
* <p>
*
* @param value a double value to make it more precise
* </p>
*/
public void sample(double value) {
sampleCount++;
@ -137,19 +126,11 @@ public class StatisticsAccumulator {
}
/**
* <p>
* Construct the Statistics Accumulator by providing the unit as a String.
* The examples of units are &quot;Hours&quot;, &quot;Minutes&quot;,
* &quot;Seconds&quot;, &quot;MilliSeconds&quot;, &quot;Micro Seconds&quot;
* etc.,
* </p>
* <p>
* The examples of units are "Hours", "Minutes",
* "Seconds", "MilliSeconds", "Micro Seconds" etc.
*
* @return a StatisticsAccumulator with ...
* </p>
* <p>
* @param unit a String representing the units for the samples collected
* </p>
*/
public StatisticsAccumulator( String unit ) {
this.unit = unit;

15
corba/src/java.corba/share/classes/com/sun/corba/se/spi/monitoring/StringMonitoredAttributeBase.java
View File

@ -27,14 +27,10 @@ package com.sun.corba.se.spi.monitoring;
import java.util.*;
/**
* <p>
*
* @author Hemanth Puttaswamy
* </p>
* <p>
*
* A Convenient Abstraction to present String type Monitored Attribute. One
* of the examples of StringMonitoredAttribute is the State information.
* </p>
*/
public abstract class StringMonitoredAttributeBase
extends MonitoredAttributeBase
@ -45,20 +41,11 @@ public abstract class StringMonitoredAttributeBase
/**
* <p>
* Constructs StringMonitoredAttribute with the MonitoredAttributeInfo
* built with the class type of String.
* </p>
* <p>
*
* @param name of this attribute
* </p>
* <p>
* @param description of this attribute
* </p>
* <p>
* @return a StringMonitoredAttributeBase
* </p>
*/
public StringMonitoredAttributeBase(String name, String description) {
super( name );

2
corba/src/java.corba/share/classes/com/sun/corba/se/spi/oa/ObjectAdapter.java
View File

@ -111,7 +111,7 @@ import com.sun.corba.se.spi.ior.IORTemplate ;
* <li>oa.returnServant()</li>
* <li>oa.exit()</li>
* <li>pop info</li>
* <ol>
* </ol>
* </li>
* REVISIT: Is this the required order for exit/pop? Cna they be nested instead?
* Note that getInvocationServant and returnServant may throw exceptions. In such cases,

4
corba/src/java.corba/share/classes/com/sun/corba/se/spi/orbutil/fsm/Action.java
View File

@ -46,8 +46,8 @@ public interface Action
* in the state machine, as the state could be corrupted.
* Any exception thrown by the Action for the transition
* will be propagated to doIt.
* @param FSM fsm is the state machine causing this action.
* @param Input in is the input that caused the transition.
* @param fsm the state machine causing this action.
* @param in the input that caused the transition.
*/
public void doIt( FSM fsm, Input in ) ;
}

3
corba/src/java.corba/share/classes/com/sun/corba/se/spi/servicecontext/ServiceContext.java
View File

@ -42,9 +42,8 @@ import com.sun.corba.se.impl.orbutil.ORBUtility ;
* the service context and provides any needed methods for manipulating
* the service context. Each subclass must provide the following
* members:
* <p>
* <ul>
* </li>a public static final int SERVICE_CONTEXT_ID that gives the OMG
* <li>a public static final int SERVICE_CONTEXT_ID that gives the OMG
* (or other) defined id for the service context. This is needed for the
* registration mechanism defined in ServiceContexts. OMG defined
* service context ids are taken from section 13.6.7 of ptc/98-12-04.</li>

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/AttributeEntry.java
View File

@ -80,7 +80,7 @@ public class AttributeEntry extends MethodEntry
} // generate
/** Access the attribute generator.
@returns an object which implements the AttributeGen interface.
@return an object which implements the AttributeGen interface.
@see AttributeGen */
public Generator generator ()
{

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/ConstEntry.java
View File

@ -90,7 +90,7 @@ public class ConstEntry extends SymtabEntry
} // generate
/** Access the constant generator.
@returns an object which implements the ConstGen interface.
@return an object which implements the ConstGen interface.
@see ConstGen */
public Generator generator ()
{

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/EnumEntry.java
View File

@ -84,7 +84,7 @@ public class EnumEntry extends SymtabEntry
} // generate
/** Access the enumerator generator.
@returns an object which implements the EnumGen interface.
@return an object which implements the EnumGen interface.
@see EnumGen */
public Generator generator ()
{

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/ExceptionEntry.java
View File

@ -80,7 +80,7 @@ public class ExceptionEntry extends StructEntry
} // generate
/** Access the exception generator.
@returns an object which implements the ExceptionGen interface.
@return an object which implements the ExceptionGen interface.
@see ExceptionGen */
public Generator generator ()
{

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/ForwardEntry.java
View File

@ -83,7 +83,7 @@ public class ForwardEntry extends SymtabEntry implements InterfaceType
} // generate
/** Access the interface generator.
@returns an object which implements the InterfaceGen interface.
@return an object which implements the InterfaceGen interface.
@see InterfaceGen */
public Generator generator ()
{

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/ForwardValueEntry.java
View File

@ -79,7 +79,7 @@ public class ForwardValueEntry extends ForwardEntry
} // generate
/** Access the interface generator.
@returns an object which implements the ForwardValueGen interface.
@return an object which implements the ForwardValueGen interface.
@see ValueGen */
public Generator generator ()
{

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/IncludeEntry.java
View File

@ -81,7 +81,7 @@ public class IncludeEntry extends SymtabEntry
} // generate
/** Access the Include type generator.
@returns an object which implements the IncludeGen interface.
@return an object which implements the IncludeGen interface.
@see IncludeGen */
public Generator generator ()
{

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/InterfaceEntry.java
View File

@ -111,7 +111,7 @@ public class InterfaceEntry extends SymtabEntry implements InterfaceType
} // generate
/** Access the interface generator.
@returns an object which implements the InterfaceGen interface.
@return an object which implements the InterfaceGen interface.
@see InterfaceGen */
public Generator generator ()
{

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/MethodEntry.java
View File

@ -89,7 +89,7 @@ public class MethodEntry extends SymtabEntry
} // generate
/** Access the method generator.
@returns an object which implements the MethodGen interface.
@return an object which implements the MethodGen interface.
@see MethodGen */
public Generator generator ()
{

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/ModuleEntry.java
View File

@ -84,7 +84,7 @@ public class ModuleEntry extends SymtabEntry
} // generate
/** Access the module generator.
@returns an object which implements the ModuleGen interface.
@return an object which implements the ModuleGen interface.
@see ModuleGen */
public Generator generator ()
{

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/NativeEntry.java
View File

@ -73,7 +73,7 @@ public class NativeEntry extends SymtabEntry
} // generate
/** Access the constant generator.
@returns an object which implements the ConstGen interface.
@return an object which implements the ConstGen interface.
@see ConstGen */
public Generator generator ()
{

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/ParameterEntry.java
View File

@ -88,7 +88,7 @@ public class ParameterEntry extends SymtabEntry
} // generate
/** Access the parameter generator.
@returns an object which implements the ParameterGen interface.
@return an object which implements the ParameterGen interface.
@see ParameterGen */
public Generator generator ()
{

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/PragmaEntry.java
View File

@ -80,7 +80,7 @@ public class PragmaEntry extends SymtabEntry
} // generate
/** Access the Include type generator.
@returns an object which implements the IncludeGen interface.
@return an object which implements the IncludeGen interface.
@see IncludeGen */
public Generator generator ()
{

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/PrimitiveEntry.java
View File

@ -81,7 +81,7 @@ public class PrimitiveEntry extends SymtabEntry
} // generate
/** Access the primitive type generator.
@returns an object which implements the PrimitiveGen interface.
@return an object which implements the PrimitiveGen interface.
@see PrimitiveGen */
public Generator generator ()
{

4
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/RepositoryID.java
View File

@ -68,8 +68,8 @@ public class RepositoryID
/**
* Determine is a supplied string meets the minimal format requirement
* for a Repository ID.
* @return true iff supplied string has form '<format>:<string>', where
* <format> is any non-empty string not containing ':'.
* @return true if supplied string has form {@code '<format>:<string>'}, where
* {@code <format>} is any non-empty string not containing ':'.
**/
public static boolean hasValidForm (String string)
{

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/SequenceEntry.java
View File

@ -101,7 +101,7 @@ public class SequenceEntry extends SymtabEntry
} // generate
/** Access the sequence generator.
@returns an object which implements the SequenceGen interface.
@return an object which implements the SequenceGen interface.
@see SequenceGen */
public Generator generator ()
{

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/StringEntry.java
View File

@ -91,7 +91,7 @@ public class StringEntry extends SymtabEntry
} // generate
/** Access the primitive type generator.
@returns an object which implements the PrimitiveGen interface.
@return an object which implements the PrimitiveGen interface.
@see PrimitiveGen */
public Generator generator ()
{

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/StructEntry.java
View File

@ -90,7 +90,7 @@ public class StructEntry extends SymtabEntry
} // generate
/** Access the struct generator.
@returns an object which implements the StructGen interface.
@return an object which implements the StructGen interface.
@see StructGen */
public Generator generator ()
{

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/SymtabEntry.java
View File

@ -127,7 +127,7 @@ public class SymtabEntry
/** Get the name of this entry's module. If there are modules within
modules, each module name is separated by '/'.
@returns this entry's module name. */
@return this entry's module name. */
public String module ()
{
return _module;

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/SymtabFactory.java
View File

@ -97,7 +97,7 @@ public interface SymtabFactory
char, octet, short, long, etc. The reason it is not limited to
these is that, as an extender, you may wish to override these names.
For instance, when generating Java code, octet translates to byte,
so there is an entry in Compile.overrideNames: <"octet", "byte">
so there is an entry in Compile.overrideNames: {@code <"octet", "byte">}
and a PrimitiveEntry in the symbol table for "byte". */
PrimitiveEntry primitiveEntry (String name);

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/Token.java
View File

@ -332,7 +332,7 @@ class Token
* @param boolean[] collidesWithKeyword is an array containing one value: a flag
* representing whether this string is an identifier that collides with a keyword.
* This is set by this method.
* @returns Token The resulting Token corresponding to string.
* @return Token The resulting Token corresponding to string.
*/
public static Token makeKeywordToken(
String string, float corbaLevel, boolean escapedOK, boolean[] collision )

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/TypedefEntry.java
View File

@ -110,7 +110,7 @@ public class TypedefEntry extends SymtabEntry
}
/** Access the typedef generator.
@returns an object which implements the TypedefGen interface.
@return an object which implements the TypedefGen interface.
@see TypedefGen */
public Generator generator ()
{

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/UnionEntry.java
View File

@ -93,7 +93,7 @@ public class UnionEntry extends SymtabEntry
} // generate
/** Access the union generator.
@returns an object which implements the UnionGen interface.
@return an object which implements the UnionGen interface.
@see UnionGen */
public Generator generator ()
{

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/ValueBoxEntry.java
View File

@ -77,7 +77,7 @@ public class ValueBoxEntry extends ValueEntry
} // generate
/** Access the value generator.
@returns an object which implements the ValueGen interface.
@return an object which implements the ValueGen interface.
@see ValueGen */
public Generator generator ()
{

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/ValueEntry.java
View File

@ -86,7 +86,7 @@ public class ValueEntry extends InterfaceEntry
} // generate
/** Access the value generator.
@returns an object which implements the ValueGen interface.
@return an object which implements the ValueGen interface.
@see ValueGen */
public Generator generator ()
{

4
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/constExpr/Terminal.java
View File

@ -43,11 +43,11 @@ import java.math.BigInteger;
/**
* This class contains values. Objects of this class are the terminal
* nodes of an expression tree.
* <b>
* <p>
* Note that there is a constructor for Double values, but not Float.
* CORBA defines that all floating point expressions are evaluated as
* double, and that the result is coerced back to float if necessary.
* <b>
* <p>
* Note also that there is a constructor for long values, but not for
* int or short. CORBA defines that all integral expressions are evaluated
* as unsigned long. A CORBA long is a Java int. There is no unsigned int

2
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/toJavaPortable/Arguments.java
View File

@ -260,7 +260,7 @@ public class Arguments extends com.sun.tools.corba.se.idl.Arguments
} // packageFromProps
/**
* d57482 <klr> method added so default emitter check could be overriden.
* d57482 (klr) method added so default emitter check could be overriden.
**/
protected void setDefaultEmitter () {
// If the flag -fclient was not found, assume it.

4
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/toJavaPortable/AttributeGen24.java
View File

@ -64,7 +64,7 @@ public class AttributeGen24 extends MethodGenClone24
} // ctor
/**
* <d62023-klr> Added for 2.4 RTF
* (d62023-klr) Added for 2.4 RTF
**/
protected void abstractMethod (Hashtable symbolTable, MethodEntry m, PrintWriter stream)
{
@ -83,7 +83,7 @@ public class AttributeGen24 extends MethodGenClone24
} // abstractMethod
/**
* <d62023-klr> Added for 2.4 RTF
* (d62023-klr) Added for 2.4 RTF
**/
protected void interfaceMethod (Hashtable symbolTable, MethodEntry m, PrintWriter stream)
{

16
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/toJavaPortable/Helper24.java
View File

@ -70,7 +70,7 @@ public class Helper24 extends Helper
/**
* Generate the heading, including package, imports, class statements,
* and open curly.
* <d62023> - don't implement ValueHelper, make non-boxed helpers abstract
* d62023 - don't implement ValueHelper, make non-boxed helpers abstract
**/
protected void writeHeading ()
{
@ -92,8 +92,10 @@ public class Helper24 extends Helper
/**
* Generate the instance variables.
* <d62023> - no helper instance except for boxed valuetypes.
* - move truncatable_ids to mapped class.
* <pre>
* d62023 - no helper instance except for boxed valuetypes;
* - move truncatable_ids to mapped class.
* </pre>
**/
protected void writeInstVars ()
{
@ -110,9 +112,9 @@ public class Helper24 extends Helper
} // writeInstVars
/**
* <d62023> generate members of BoxedValueHelper interface if boxed
* d62023 - generate members of BoxedValueHelper interface if boxed
*
* <d62023> Hook in here to write factory methods for non-boxed ValueTypes
* d62023 - hook in here to write factory methods for non-boxed ValueTypes
* into Helper.
**/
protected void writeValueHelperInterface ()
@ -143,8 +145,8 @@ public class Helper24 extends Helper
} // writeHelperFactories
/**
* <d62023> Generate constructors only for boxed valuetype helpers
* All other helpers are abstract.
* d62023 - generate constructors only for boxed valuetype helpers.
* All other helpers are abstract.
**/
protected void writeCtors ()
{

16
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/toJavaPortable/InterfaceGen.java
View File

@ -190,17 +190,19 @@ public class InterfaceGen implements com.sun.tools.corba.se.idl.InterfaceGen, Ja
/**
* Generate the interface. Provides general algorithm for binding generation:
* 1.) Initialize members unique to this generator. - init ()
* 2.) Open print stream - openStream ()
* 3.) Write class heading (package, prologue, class statement, open curly - writeHeading ()
* 4.) Write class body (member data and methods) - write*Body ()
* 5.) Write class closing (close curly) - writeClosing ()
* 6.) Close the print stream - closeStream ()
* <ol>
* <li> Initialize members unique to this generator - init()</li>
* <li> Open print stream - openStream()</li>
* <li> Write class heading (package, prologue, class statement, open curly - writeHeading()</li>
* <li> Write class body (member data and methods) - write*Body()</li>
* <li> Write class closing (close curly) - writeClosing()</li>
* <li> Close the print stream - closeStream ()</li>
* </ol>
*
* For CORBA 2.3, interfaces are mapped to Operations and Signature
* interfaces. The Operations interface contains the method definitions.
* The Signature interface extends the Operations interface and adds
* CORBA::Object. <klr>
* CORBA::Object. (klr)
**/
protected void generateInterface ()
{

12
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/toJavaPortable/MethodGen24.java
View File

@ -96,7 +96,7 @@ public class MethodGen24 extends MethodGen
}
/**
* <d62023> Write the methodEntry for a valuetype factory method into
* d62023 - write the methodEntry for a valuetype factory method into
* the Value Helper class. Contents from email from Simon,
* 4/25/99.
**/
@ -135,7 +135,7 @@ public class MethodGen24 extends MethodGen
} // helperFactoryMethod
/**
* <d62023> - write an abstract method definition
* d62023 - write an abstract method definition
**/
protected void abstractMethod (Hashtable symbolTable, MethodEntry m, PrintWriter stream)
{
@ -152,8 +152,8 @@ public class MethodGen24 extends MethodGen
} // abstractMethod
/**
* <d62023> - write a default factory method implementation for the
* <value>DefaultFactory. m is a methodEntry for a factory
* d62023 - write a default factory method implementation for the
* {@code <value>DefaultFactory}. m is a methodEntry for a factory
* method contained in a non-abstract ValueEntry.
**/
protected void defaultFactoryMethod (Hashtable symbolTable, MethodEntry m, PrintWriter stream)
@ -176,7 +176,7 @@ public class MethodGen24 extends MethodGen
} // defaultFactoryMethod
/**
* <d62023> - remove all valueInitializer junk
* d62023 - remove all valueInitializer junk
**/
protected void writeMethodSignature ()
{
@ -242,7 +242,7 @@ public class MethodGen24 extends MethodGen
} // writeMethodSignature
/**
* <d62023> - delete method templates for valuetypes
* d62023 - delete method templates for valuetypes
**/
protected void interfaceMethod (Hashtable symbolTable, MethodEntry m, PrintWriter stream)
{

4
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/toJavaPortable/MethodGenClone24.java
View File

@ -74,7 +74,7 @@ public class MethodGenClone24 extends AttributeGen
} // ctor
/**
* <d62023> - write an abstract method definition
* d62023 - write an abstract method definition
**/
protected void abstractMethod (Hashtable symbolTable, MethodEntry m, PrintWriter stream)
{
@ -91,7 +91,7 @@ public class MethodGenClone24 extends AttributeGen
} // abstractMethod
/**
* <d62023> - delete method templates for valuetypes
* d62023 - delete method templates for valuetypes
**/
protected void interfaceMethod (Hashtable symbolTable, MethodEntry m, PrintWriter stream)
{

6
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/toJavaPortable/ValueBoxGen24.java
View File

@ -69,7 +69,7 @@ public class ValueBoxGen24 extends ValueBoxGen
} // ctor
/**
* <d62023> - Move from helper to mapped class
* d62023 - Move from helper to mapped class
**/
protected void writeTruncatable () // <d60929>
{
@ -84,7 +84,7 @@ public class ValueBoxGen24 extends ValueBoxGen
/**
* <d62023>
* d62023
**/
public void helperRead (String entryName, SymtabEntry entry, PrintWriter stream)
{
@ -144,7 +144,7 @@ public class ValueBoxGen24 extends ValueBoxGen
} // helperWrite
/**
* <d62023>
* d62023
**/
public int write (int index, String indent, String name, SymtabEntry entry, PrintWriter stream)
{

27
corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/toJavaPortable/ValueGen24.java
View File

@ -73,15 +73,17 @@ public class ValueGen24 extends ValueGen
} // ctor
/**
* <d62023> - delete constructor; helper is abstract
* d62023 - delete constructor; helper is abstract
**/
protected void writeConstructor ()
{
} // writeConstructor
/**
* <d62023> - delete write_value from non-boxed helpers
* - delete _write from non-boxed helpers
* <pre>
* d62023 - delete write_value from non-boxed helpers
* - delete _write from non-boxed helpers
* </pre>
**/
public void helperWrite (SymtabEntry entry, PrintWriter stream)
{
@ -91,7 +93,7 @@ public class ValueGen24 extends ValueGen
} // helperWrite
/**
* <d62023>
* d62023
**/
public void helperRead (String entryName, SymtabEntry entry, PrintWriter stream)
{
@ -101,7 +103,7 @@ public class ValueGen24 extends ValueGen
} // helperRead
/**
* <d62023> - suppress initializers from mapped value; now generated in
* d62023 - suppress initializers from mapped value; now generated in
* the Helper class and Factory class
**/
protected void writeInitializers ()
@ -110,7 +112,7 @@ public class ValueGen24 extends ValueGen
} // writeInitializers
/**
* <d62023> - Goes in mapped class, not Helper
* d62023 - goes in mapped class, not Helper
**/
protected void writeTruncatable () // <d60929>
{
@ -155,7 +157,7 @@ public class ValueGen24 extends ValueGen
}
/**
* <d62023> CustomMarshal -> CustomValue for custom valuetypes
* d62023 - CustomMarshal {@literal ->} CustomValue for custom valuetypes
* mapped class is abstract
**/
protected void writeHeading ()
@ -217,7 +219,7 @@ public class ValueGen24 extends ValueGen
} // writeHeading
/**
* <d62023> - private state maps to protected, not default
* d62023 - private state maps to protected, not default
**/
protected void writeMembers ()
{
@ -245,8 +247,7 @@ public class ValueGen24 extends ValueGen
} // writeMembers
/**
* <d62023> Methods need to be abstract
* writeStreamable
* d62023 - methods need to be abstract writeStreamable
**/
protected void writeMethods ()
{
@ -294,7 +295,7 @@ public class ValueGen24 extends ValueGen
} // writeMethods
/**
* <d62023> Call super._read()
* d62023 - call super._read()
**/
public int read (int index, String indent, String name, SymtabEntry entry, PrintWriter stream)
{
@ -335,7 +336,7 @@ public class ValueGen24 extends ValueGen
} // read
/**
* <d62023> Call super._write()
* d62023 - call super._write()
**/
public int write (int index, String indent, String name, SymtabEntry entry, PrintWriter stream)
{
@ -374,7 +375,7 @@ public class ValueGen24 extends ValueGen
} // write
/**
* <62023> - generate factory interface and default factory
* d62023 - generate factory interface and default factory
**/
public void generate (Hashtable symbolTable, ValueEntry v, PrintWriter str)
{

4
corba/src/jdk.rmic/share/classes/sun/rmi/rmic/iiop/Type.java
View File

@ -51,7 +51,7 @@ import sun.rmi.rmic.Names;
* conformance checking and name mapping as defined in the "Java to IDL
* Mapping" OMG specification. The family is composed of the following
* fixed set of types:
* <pre>
* <pre>{@literal
*
* +- RemoteType <-- AbstractType
* |
@ -67,7 +67,7 @@ import sun.rmi.rmic.Names;
* |
* +- NCClassType
*
* </pre>
* }</pre>
* PrimitiveType represents a primitive or a void type.
* <p>
* CompoundType is an abstract base representing any non-special class