mir/libreoffice
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

#96764# documentation review

Browse Source
This commit is contained in:
Joachim Lingner
2002-01-22 10:05:16 +00:00
parent deab49d8a9
commit d5945af760
4 changed files with 111 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
jut/com/sun/star/tools/uno/DumpType.java
View File

@@ -2,9 +2,9 @@
*
* $RCSfile: DumpType.java,v $
*
* $Revision: 1.3 $
* $Revision: 1.4 $
*
* last change: $Author: kr $ $Date: 2001-05-08 09:54:01 $
* last change: $Author: jl $ $Date: 2002-01-22 11:05:16 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -68,7 +68,8 @@ import com.sun.star.uno.UnoRuntime;
import com.sun.star.registry.XImplementationRegistration;
import com.sun.star.uno.Type;
/** A command-line tool. Prints information about com.sun.star.uno.Type to error stream.
*/
public class DumpType {
static private final String[] __typeClassToTypeName = new String[]{
"void",
@@ -101,6 +102,11 @@ public class DumpType {
"unknown"
};
/** Prints information about argument type to the standard error stream.
The information consists of type name, type description, class name,
as well as the type class.
@param type the Type object whoose information are printed.
*/
static public void dumpType(Type type) throws Exception {
System.err.println("uno type name:" + type.getTypeName());
System.err.println("description:" + type.getTypeDescription());
@@ -109,6 +115,17 @@ public class DumpType {
System.err.println("type class:" + __typeClassToTypeName[type.getTypeClass().getValue()]);
}
/** Executes this tool.
The command line arguments consist of an identifier followed by a type name.
Identifiers can either be uno or java. Based on the type name, a com.sun.star.uno.Type
object is constructed whose information are then printed out to the error stream.
<br>
usage: [uno &lt;type name&gt;]|[java &lt;class name&gt]* <br>
Examples: <br>
java com.sun.star.uno.tools.DumpType uno com.sun.star.lang.XMultiServiceFactory
java com.sun.star.uno.tools.DumpType java java.lang.Byte java java.lang.String
@param args command line arguments
*/
static public void main(String args[]) throws Exception {
if(args.length == 0)
System.err.println("usage: [uno <type name>]|[java <class name>]*");

61
jut/com/sun/star/tools/uno/DumpTypeDescription.java
View File

@@ -2,9 +2,9 @@
*
* $RCSfile: DumpTypeDescription.java,v $
*
* $Revision: 1.1 $
* $Revision: 1.2 $
*
* last change: $Author: kr $ $Date: 2001-05-08 09:54:01 $
* last change: $Author: jl $ $Date: 2002-01-22 11:05:16 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -75,8 +75,51 @@ import com.sun.star.uno.IMethodDescription;
import com.sun.star.uno.ITypeDescription;
import com.sun.star.uno.Type;
/** A command-line tool. Prints information of com.sun.star.lib.uno.typedesc.TypeDescription objects to the
error stream.
*/
public class DumpTypeDescription {
/** Prints information about a TypeDescription object that has been constructed based
on the argument <i>typeName</i>. The output is written to the error stream.
The information consists of general as well as method and member information.
These are:<br>
<ul>
<li>type name</li>
<li>array type name</li>
<li>type of the super class</li>
<li>type class</li>
<li>component type</li>
<li>java.lang.Class object</li>
</ul>
Method information:
<ul>
<li>name</li>
<li>index</li>
<li>is one way</li>
<li>is unsigned</li>
<li>is Any</li>
<li>is interface</li>
<li>in signature</li>
<li>out signature</li>
<li>return signature</li>
<li>java.lang.reflect.Method object</li>
</ul>
Field information:
<ul>
<li>name</li>
<li>index</li>
<li>is one way</li>
<li>is unsigned</li>
<li>is Any</li>
<li>is interface</li>
<li>com.sun.star.lib.uno.typedesc.TypeDescription object</li>
</ul>
@param typeName name of a type for which an TypeDescription object
is constructed whoose information are printed.
*/
static public void dumpTypeDescription(String typeName) throws Exception {
ITypeDescription iTypeDescription = TypeDescription.getTypeDescription(typeName);
@@ -129,7 +172,19 @@ public class DumpTypeDescription {
}
}
/** Executes this tool.
The command line arguments consist of an identifier followed by a type name.
Identifiers can either be uno or java. Based on the type name, a
com.sun.star.lib.uno.typedesc.TypeDescription
object is constructed whose information are then printed out to the error stream.
<br>
usage: [uno &lt;type name&gt;]|[java &lt;class name&gt]* <br>
Examples: <br>
java com.sun.star.uno.tools.DumpTypeDescription uno com.sun.star.lang.XMultiServiceFactory
java com.sun.star.uno.tools.DumpTypeDescription java java.lang.Byte java java.lang.String
@param args command line arguments
*/
static public void main(String args[]) throws Exception {
if(args.length == 0)
System.err.println("usage: [uno <type name>]|[java <class name>]*");

23
jut/com/sun/star/tools/uno/RegComp.java
View File

@@ -2,9 +2,9 @@
*
* $RCSfile: RegComp.java,v $
*
* $Revision: 1.1 $
* $Revision: 1.2 $
*
* last change: $Author: kr $ $Date: 2001-02-02 10:37:45 $
* last change: $Author: jl $ $Date: 2002-01-22 11:03:23 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -67,7 +67,26 @@ import com.sun.star.lang.XMultiServiceFactory;
import com.sun.star.uno.UnoRuntime;
import com.sun.star.registry.XImplementationRegistration;
/** A command-line tool. It registers an UNO component with a registry database.
During registration the component will be instantiated and be asked
to write the necessary information to the database.
Command line arguments:<br>
database register|unregister locationURL loader
<br>
For example:
<pre>
java com.sun.star.tools.RegComp applicat.rdb register
file:///e:/demos/InstanceInspector.jar com.sun.star.loader.Java2
</pre>
In order to examine the results of the registration use the regview.exe
tool. For example:
<pre>
regview nameOfDatatbase /SERVICES/serviceName
regview nameOfDataBase /IMPLEMENTATIONS/implementationName
</pre>
@see <a href="http://udk.openoffice.org/java/man/register_java_components.html">Registering Java Components</a>
*/
public class RegComp {
static public void main(String args[]) throws Exception {

18
jut/com/sun/star/tools/uno/UnoApp.java
View File

@@ -2,9 +2,9 @@
*
* $RCSfile: UnoApp.java,v $
*
* $Revision: 1.12 $
* $Revision: 1.13 $
*
* last change: $Author: jbu $ $Date: 2001-10-19 13:27:47 $
* last change: $Author: jl $ $Date: 2002-01-22 11:05:16 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -157,9 +157,13 @@ class ConnectionListener implements XStreamListener
}
/**
* <code>UnoApp</code> is the generic UNO application for java.
* It removes the need for writing UNO applications in Java.
* <p>
* A command line tool. <code>UnoApp</code> is the generic UNO application for java.
* It removes the need for writing UNO applications in Java. That is, it instantiates a service and runs it if it implements
* <code>com.sun.star.lang.XMain</code>. <br>
* In a remote scenario it is used to intantiate services and makes them accessible
* via a network.
* @see <a href="http://udk.openoffice.org/java/man/UnoApp.html">The Java Uno Application</a>
*
*/
public class UnoApp extends Applet {
static public final boolean DEBUG = false;
@@ -890,7 +894,9 @@ public class UnoApp extends Applet {
}
/* overwrite the applet methods */
/** Calls the main method. The parameter of the applet are passed as arguments
to the main method.
*/
public void init() {
System.err.println("##### " + getClass().getName() + ".init");