#96701# API review

4 files changed, 138 insertions, 20 deletions

diff --git a/jurt/com/sun/star/uno/AnyConverter.java b/jurt/com/sun/star/uno/AnyConverter.java
index 40d2c6ab4e29..bef10f2b4ebc 100644
--- a/jurt/com/sun/star/uno/AnyConverter.java
+++ b/jurt/com/sun/star/uno/AnyConverter.java
@@ -9,50 +9,99 @@ import com.sun.star.lang.IllegalArgumentException;
  */
 public class AnyConverter
 {
+    /** checks if the any contains the idl type <code>void</code>.
+        @param object the object to check
+        @return true when the any is void, false otherwise
+     */
     static public boolean isVoid( Object object){
         return containsType( TypeClass.VOID, object);
     }
 
+    /** checks if the any contains a value of the idl type <code>char</code>.
+        @param object the object to check
+        @return true when the any contains a char, false otherwise.
+     */
     static public boolean isChar(Object object){
         return containsType( TypeClass.CHAR, object);
     }
 
+    /** checks if the any contains a value of the idl type <code>boolean</code>.
+        @param object the object to check
+        @return true when the any contains a boolean, false otherwise.
+     */
     static public boolean isBoolean(Object object){
         return containsType( TypeClass.BOOLEAN, object);
     }
 
+    /** checks if the any contains a value of the idl type <code>byte</code>.
+        @param object the object to check
+        @return true when the any contains a byte, false otherwise.
+     */
     static public boolean isByte(Object object){
         return containsType( TypeClass.BYTE, object);
     }
 
+    /** checks if the any contains a value of the idl type <code>short</code>.
+        @param object the object to check
+        @return true when the any contains a short, false otherwise.
+     */
     static public boolean isShort(Object object){
         return containsType( TypeClass.SHORT, object);
     }
 
+    /** checks if the any contains a value of the idl type <code>long</code> (which maps to a java-int).
+        @param object the object to check
+        @return true when the any contains a int, false otherwise.
+     */
     static public boolean isInt(Object object){
         return containsType( TypeClass.LONG, object);
     }
 
+    /** checks if the any contains a value of the idl type <code>hyper</code> (which maps to a java-long).
+        @param object the object to check
+        @return true when the any contains a long, false otherwise.
+     */
     static public boolean isLong(Object object){
         return containsType( TypeClass.HYPER, object);
     }
 
+    /** checks if the any contains a value of the idl type <code>float</code>.
+        @param object the object to check
+        @return true when the any contains a float, false otherwise.
+     */
     static public boolean isFloat(Object object){
         return containsType( TypeClass.FLOAT, object);
     }
 
+    /** checks if the any contains a value of the idl type <code>double</code>.
+        @param object the object to check
+        @return true when the any contains a double, false otherwise.
+     */
     static public boolean isDouble(Object object){
         return containsType( TypeClass.DOUBLE, object);
     }
 
+    /** checks if the any contains a value of the idl type <code>string</code>.
+        @param object the object to check
+        @return true when the any contains a string, false otherwise.
+     */
     static public boolean isString(Object object){
         return containsType( TypeClass.STRING, object);
     }
 
+
+    /** checks if the any contains a value of the idl type <code>type</code>.
+        @param object the object to check
+        @return true when the any contains a type, false otherwise.
+     */
     static public boolean isType(Object object){
         return containsType( TypeClass.TYPE, object);
     }
 
+    /** checks if the any contains a value which implements interfaces.
+        @param object the object to check
+        @return true when the any contains an object which implements interfaces, false otherwise.
+     */
     static public boolean isObject(Object object){
         boolean retVal= false;
         if( object.getClass().getInterfaces().length > 0)
@@ -70,73 +119,139 @@ public class AnyConverter
         return retVal;
     }
 
+    /** checks if the any contains UNO idl sequence value ( meaning a java array
+        containing elements which are values of UNO idl types).
+        @param object the object to check
+        @return true when the any contains an object which implements interfaces, false otherwise.
+     */
     static public boolean isArray( Object object){
         return containsType( TypeClass.SEQUENCE, object);
     }
 
+    /** converts an Char object or an Any object containing a Char object into a simple char.
+        @param object the object to convert
+        @return the char contained within the object
+        @throws com.sun.star.lang.IllegalArgumentException in case no char is contained within object
+        @see #isChar
+    */
     static public char  toChar(Object object) throws  com.sun.star.lang.IllegalArgumentException{
         Character ret=(Character) convertSimple( TypeClass.CHAR, null, object);
         return ret.charValue();
     }
 
+    /** converts an Boolean object or an Any object containing a Boolean object into a simple boolean.
+        @param object the object to convert
+        @return the boolean contained within the object
+        @throws com.sun.star.lang.IllegalArgumentException in case no boolean is contained within object
+        @see #isBoolean
+    */
     static public boolean toBoolean(Object object) throws  com.sun.star.lang.IllegalArgumentException{
         Boolean ret= (Boolean)  convertSimple( TypeClass.BOOLEAN, null, object);
         return ret.booleanValue();
     }
 
+    /** converts an Byte object or an Any object containing a Byte object into a simple byte.
+        @param object the object to convert
+        @return the boolean contained within the object
+        @throws com.sun.star.lang.IllegalArgumentException in case no byte is contained within object
+        @see #isBoolean
+    */
     static public byte toByte(Object object) throws   com.sun.star.lang.IllegalArgumentException{
         Byte ret= (Byte) convertSimple( TypeClass.BYTE, null, object);
         return ret.byteValue();
     }
 
-        /** Allowed argument types are Byte, Short or Any containing these types.
-         */
+    /** converts a number object into a simple short and allows widening conversions.
+        Allowed argument types are Byte, Short or Any containing these types.
+        @param object the object to convert
+        @throws com.sun.star.lang.IllegalArgumentException in case no short or byte is contained within object
+        @return the short contained within the object
+     */
     static public short toShort(Object object) throws   com.sun.star.lang.IllegalArgumentException{
         Short ret= (Short) convertSimple( TypeClass.SHORT, null, object);
         return ret.shortValue();
     }
 
-        /** Allowed argument types are Byte, Short, Integer or Any containing these types.
-         */
+    /** converts a number object into a simple int and allows widening conversions.
+        Allowed argument types are Byte, Short, Integer or Any containing these types.
+        @param object the object to convert
+        @throws com.sun.star.lang.IllegalArgumentException in case no short, byte or int is contained within object.
+        @return the int contained within the object
+     */
     static public int toInt(Object object) throws  com.sun.star.lang.IllegalArgumentException{
         Integer ret= (Integer) convertSimple( TypeClass.LONG, null, object);
         return ret.intValue();
     }
 
-        /** Allowed argument types are Byte, Short, Integer, Long or Any containing these types.
-         */
+    /** converts a number object into a simple long and allows widening conversions.
+        Allowed argument types are Byte, Short, Integer, Long or Any containing these types.
+        @param object the object to convert
+        @throws com.sun.star.lang.IllegalArgumentException in case no short, byte, int or long
+                is contained within object.
+        @return the long contained within the object
+     */
     static public long toLong(Object object) throws   com.sun.star.lang.IllegalArgumentException{
         Long ret= (Long) convertSimple( TypeClass.HYPER, null, object);
         return ret.longValue();
     }
 
-        /** Allowed argument types are Byte, Short, Float or Any containing these types.
-         */
+    /** converts a number object into a simple float and allows widening conversions.
+        Allowed argument types are Byte, Short, Float or Any containing these types.
+        @param object the object to convert
+        @throws com.sun.star.lang.IllegalArgumentException in case no byte, short or float
+                is contained within object.
+        @return the float contained within the object
+     */
     static public float toFloat(Object object) throws com.sun.star.lang.IllegalArgumentException{
         Float ret= (Float) convertSimple( TypeClass.FLOAT,null, object);
         return ret.floatValue();
     }
 
-        /** Allowed argument types are Byte, Short, Integer, Float, Double or Any containing these types.
-         */
+    /** converts a number object into a simple double and allows widening conversions.
+        Allowed argument types are Byte, Short, Int, Float, Double or Any containing these types.
+        @param object the object to convert
+        @throws com.sun.star.lang.IllegalArgumentException in case no byte, short, int, float
+                or double is contained within object.
+        @return the double contained within the object
+     */
     static public double toDouble(Object object) throws com.sun.star.lang.IllegalArgumentException {
         Double ret= (Double) convertSimple( TypeClass.DOUBLE, null, object);
         return ret.doubleValue();
     }
 
+    /** converts a string or an any containing a string into a string.
+        @param object the object to convert
+        @throws com.sun.star.lang.IllegalArgumentException in case no string is contained within object.
+        @return the string contained within the object
+     */
     static public String toString(Object object) throws com.sun.star.lang.IllegalArgumentException {
         return (String) convertSimple( TypeClass.STRING, null, object);
     }
 
+    /** converts a Type or an any containing a Type into a Type.
+        @param object the object to convert
+        @throws com.sun.star.lang.IllegalArgumentException in case no type is contained within object.
+        @return the type contained within the object
+     */
     static public Type toType(Object object) throws com.sun.star.lang.IllegalArgumentException {
         return (Type) convertSimple( TypeClass.TYPE, null, object);
     }
 
+    /** converts a UNO object an any containing a UNO object into a UNO object.
+        @param object the object to convert
+        @throws com.sun.star.lang.IllegalArgumentException in case no UNO object is contained within object.
+        @return the object contained within the object
+     */
     static public Object toObject(Type type, Object object)
         throws com.sun.star.lang.IllegalArgumentException{
         return convertSimple( TypeClass.ANY,  type, object);
     }
 
+    /** converts an array or an any containing an array into an array.
+        @param object the object to convert
+        @throws com.sun.star.lang.IllegalArgumentException in case no array is contained within object.
+        @return the array contained within the object
+     */
     static public Object toArray( Object object) throws com.sun.star.lang.IllegalArgumentException {
         return convertSimple( TypeClass.SEQUENCE, null, object);
     }
diff --git a/jurt/com/sun/star/uno/Ascii.java b/jurt/com/sun/star/uno/Ascii.java
index 7ed1117312c2..8ddb1b59a2f1 100644
--- a/jurt/com/sun/star/uno/Ascii.java
+++ b/jurt/com/sun/star/uno/Ascii.java
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: Ascii.java,v $
  *
- *  $Revision: 1.1.1.1 $
+ *  $Revision: 1.2 $
  *
- *  last change: $Author: hr $ $Date: 2000-09-18 15:27:53 $
+ *  last change: $Author: jbu $ $Date: 2002-01-18 14:06:54 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -64,9 +64,10 @@ package com.sun.star.uno;
 /**
  * The Ascii class represents the IDL build in type <code>ascii</code>.
  * <p>
- * @version     $Revision: 1.1.1.1 $ $ $Date: 2000-09-18 15:27:53 $
+ * @version     $Revision: 1.2 $ $ $Date: 2002-01-18 14:06:54 $
  * @author      Markus Meyer
  * @since       UDK1.0
+ * @deprecated do not use
  */
 public final class Ascii {
     public final char ascii;
@@ -74,6 +75,7 @@ public final class Ascii {
     /**
      * Constructs a new <code>Ascii</code>.
      * <p>
+     * @deprecated do not use
      * @param   c  the char value
      */
     public Ascii(char c) {
diff --git a/jurt/com/sun/star/uno/AsciiString.java b/jurt/com/sun/star/uno/AsciiString.java
index 10f6a1baa896..cedb6fb75caa 100644
--- a/jurt/com/sun/star/uno/AsciiString.java
+++ b/jurt/com/sun/star/uno/AsciiString.java
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: AsciiString.java,v $
  *
- *  $Revision: 1.1.1.1 $
+ *  $Revision: 1.2 $
  *
- *  last change: $Author: hr $ $Date: 2000-09-18 15:27:54 $
+ *  last change: $Author: jbu $ $Date: 2002-01-18 14:06:54 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -64,9 +64,10 @@ package com.sun.star.uno;
 /**
  * The Ascii class represents the IDL build in type <code>asciistring</code>.
  * <p>
- * @version     $Revision: 1.1.1.1 $ $ $Date: 2000-09-18 15:27:54 $
+ * @version     $Revision: 1.2 $ $ $Date: 2002-01-18 14:06:54 $
  * @author      Markus Meyer
  * @since       UDK1.0
+ * @deprecated do not use
  */
 public final class AsciiString {
     public final String asciistring;
@@ -74,6 +75,7 @@ public final class AsciiString {
     /**
      * Constructs a new <code>AsciiString</code>.
      * <p>
+     * @deprecated do not use
      * @param   s  the String value
      */
     public AsciiString(String s) {
diff --git a/jurt/com/sun/star/uno/MappingException.java b/jurt/com/sun/star/uno/MappingException.java
index 1281d3648d6b..cc9d4600364d 100644
--- a/jurt/com/sun/star/uno/MappingException.java
+++ b/jurt/com/sun/star/uno/MappingException.java
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: MappingException.java,v $
  *
- *  $Revision: 1.1.1.1 $
+ *  $Revision: 1.2 $
  *
- *  last change: $Author: hr $ $Date: 2000-09-18 15:27:54 $
+ *  last change: $Author: jbu $ $Date: 2002-01-18 14:06:54 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -65,8 +65,7 @@ package com.sun.star.uno;
 /**
  * The mapping Exception.
  * <p>
- * @version     $Revision: 1.1.1.1 $ $ $Date: 2000-09-18 15:27:54 $
- * @author      Kay Ramme
+ * @version     $Revision: 1.2 $ $ $Date: 2002-01-18 14:06:54 $
  * @see         com.sun.star.uno.UnoRuntime
  * @see         com.sun.star.uno.IQueryInterface
  * @see         com.sun.star.uno.IBridge