[Libreoffice-commits] core.git: 2 commits - javaunohelper/com ridljar/com
Michael Stahl
mstahl at redhat.com
Wed Feb 17 11:00:41 UTC 2016
javaunohelper/com/sun/star/comp/helper/Bootstrap.java | 27 ++-
javaunohelper/com/sun/star/comp/helper/SharedLibraryLoader.java | 3
javaunohelper/com/sun/star/lib/uno/helper/InterfaceContainer.java | 11 +
javaunohelper/com/sun/star/lib/uno/helper/MultiTypeInterfaceContainer.java | 6
javaunohelper/com/sun/star/lib/uno/helper/PropertySet.java | 13 +
javaunohelper/com/sun/star/lib/uno/helper/PropertySetMixin.java | 89 ++++++++++
ridljar/com/sun/star/uno/IBridge.java | 3
ridljar/com/sun/star/uno/ITypeDescription.java | 9 +
ridljar/com/sun/star/uno/UnoRuntime.java | 11 +
9 files changed, 169 insertions(+), 3 deletions(-)
New commits:
commit d562ee461735a6daa6dcdfcc559f851cad160aaf
Author: Michael Stahl <mstahl at redhat.com>
Date: Wed Feb 17 00:04:51 2016 +0100
ridljar: fix javadoc warnings
Change-Id: Ifa85299dd3366fb9a9639e669a02678ea9268260
diff --git a/ridljar/com/sun/star/uno/IBridge.java b/ridljar/com/sun/star/uno/IBridge.java
index 298378f..26fe580 100644
--- a/ridljar/com/sun/star/uno/IBridge.java
+++ b/ridljar/com/sun/star/uno/IBridge.java
@@ -85,6 +85,9 @@ public interface IBridge {
*
* <p>Sends involved threads an <code>InterruptedException</code>. Releases
* mapped objects.</p>
+ *
+ * @throws InterruptedException it's deprecated so who cares.
+ * @throws IOException it's deprecated so who cares.
*/
void dispose() throws InterruptedException, IOException;
}
diff --git a/ridljar/com/sun/star/uno/ITypeDescription.java b/ridljar/com/sun/star/uno/ITypeDescription.java
index b326e9c..1495c54 100644
--- a/ridljar/com/sun/star/uno/ITypeDescription.java
+++ b/ridljar/com/sun/star/uno/ITypeDescription.java
@@ -45,6 +45,9 @@ public interface ITypeDescription {
* Gets the <code>IMethodDescription</code> for the
* method with index methodId, if it exists, otherwise
* returns <code>null</code>.
+ *
+ * @param methodId the index.
+ *
* @return the <code>IMethodDescription</code>.
*/
IMethodDescription getMethodDescription(int methodId);
@@ -53,6 +56,9 @@ public interface ITypeDescription {
* Gets the <code>IMethodDescription</code> for the
* method with the name <code>name</code>, if it exists,
* otherwise returns <code>null</code>.
+ *
+ * @param name the name of the method.
+ *
* @return the <code>IMethodDescription</code>.
*/
IMethodDescription getMethodDescription(String name);
@@ -69,6 +75,9 @@ public interface ITypeDescription {
* Gets the <code>IFieldDescription</code> for the
* field with the name <code>name</code>, if it exists,
* otherwise returns <code>null</code>.
+ *
+ * @param name the name of the field.
+ *
* @return the <code>IFieldDescription</code>.
*/
IFieldDescription getFieldDescription(String name);
diff --git a/ridljar/com/sun/star/uno/UnoRuntime.java b/ridljar/com/sun/star/uno/UnoRuntime.java
index 8c822d3..114753d 100644
--- a/ridljar/com/sun/star/uno/UnoRuntime.java
+++ b/ridljar/com/sun/star/uno/UnoRuntime.java
@@ -160,6 +160,7 @@ public class UnoRuntime {
* Queries the given UNO object for the given Java class (which must
* represent a UNO interface type).
*
+ * @param <T> the requested UNO interface type.
* @param zInterface a Java class representing a UNO interface type
* @param object a reference to any Java object representing (a facet of) a
* UNO object; may be <code>null</code>
@@ -401,6 +402,8 @@ public class UnoRuntime {
*
* @param name the name of the environment
* @param context the context of the environment
+ * @throws Exception if something goes awry.
+ * @return an environment.
* @see com.sun.star.uno.IEnvironment
*
* @deprecated As of UDK 3.2.0, this method is deprecated, without
@@ -440,6 +443,7 @@ public class UnoRuntime {
* @param from the source environment
* @param to the target environment
* @param args the initial arguments for the bridge
+ * @throws Exception if something goes awry.
* @return the requested bridge
* @see #getBridgeByName
* @see com.sun.star.uno.IBridge
@@ -496,6 +500,7 @@ public class UnoRuntime {
* @param to the name of the target environment
* @param toContext the context for the target environment
* @param args the initial arguments for the bridge
+ * @throws Exception if something goes awry.
* @return the requested bridge
* @see #getBridge
* @see #getEnvironment
@@ -546,6 +551,7 @@ public class UnoRuntime {
*
* @param from the source environment
* @param to the target environment
+ * @throws Exception if something goes awry.
* @return the requested mapping
* @see com.sun.star.uno.IEnvironment
* @see com.sun.star.uno.IMapping
@@ -575,6 +581,7 @@ public class UnoRuntime {
*
* @param from the name of the source environment
* @param to the name of the target environment
+ * @throws Exception if something goes awry.
* @return the requested mapping
* @see #getEnvironment
* @see #getMapping
@@ -594,6 +601,10 @@ public class UnoRuntime {
*
* <p>Releases all references to bridges and environments.</p>
*
+ * @return true if another thread didn't re-insert some bridge or
+ * environment before the method returns. Why that information
+ * would be useful is anybody's guess.
+ *
* @deprecated As of UDK 3.2.0, this method is deprecated, without
* offering a replacement.
*/
commit 11e55a0029810083261ea83838241d0524e59f9f
Author: Michael Stahl <mstahl at redhat.com>
Date: Tue Feb 16 17:57:37 2016 +0100
javaunohelper: fix all javadoc warnings
Change-Id: Iaaeab13005fef160def2e5bd49d4bfd40f42fe33
diff --git a/javaunohelper/com/sun/star/comp/helper/Bootstrap.java b/javaunohelper/com/sun/star/comp/helper/Bootstrap.java
index 2f9b0d4..a2d43bc 100644
--- a/javaunohelper/com/sun/star/comp/helper/Bootstrap.java
+++ b/javaunohelper/com/sun/star/comp/helper/Bootstrap.java
@@ -120,7 +120,11 @@ public class Bootstrap {
}
/**
- * backwards compatibility stub.
+ backwards compatibility stub.
+ @param context_entries the hash table contains mappings of entry names (type string) to
+ context entries (type class ComponentContextEntry).
+ @throws Exception if things go awry.
+ @return a new context.
*/
public static XComponentContext createInitialComponentContext( Hashtable<String, Object> context_entries )
throws Exception
@@ -131,6 +135,7 @@ public class Bootstrap {
jurt components inserted.
@param context_entries the hash table contains mappings of entry names (type string) to
context entries (type class ComponentContextEntry).
+ @throws Exception if things go awry.
@return a new context.
*/
public static XComponentContext createInitialComponentContext( Map<String, Object> context_entries )
@@ -169,6 +174,7 @@ public class Bootstrap {
*
* See also UNOIDL <code>com.sun.star.lang.ServiceManager</code>.
*
+ * @throws Exception if things go awry.
* @return a freshly boostrapped service manager
*/
public static XMultiServiceFactory createSimpleServiceManager() throws Exception
@@ -180,6 +186,9 @@ public class Bootstrap {
/** Bootstraps the initial component context from a native UNO installation.
+ @throws Exception if things go awry.
+ @return a freshly bootstrapped component context.
+
See also
<code>cppuhelper/defaultBootstrap_InitialComponentContext()</code>.
*/
@@ -190,6 +199,14 @@ public class Bootstrap {
}
/**
* Backwards compatibility stub.
+ *
+ * @param ini_file
+ * ini_file (may be null: uno.rc besides cppuhelper lib)
+ * @param bootstrap_parameters
+ * bootstrap parameters (maybe null)
+ *
+ * @throws Exception if things go awry.
+ * @return a freshly bootstrapped component context.
*/
public static final XComponentContext defaultBootstrap_InitialComponentContext(
String ini_file, Hashtable<String,String> bootstrap_parameters )
@@ -207,6 +224,9 @@ public class Bootstrap {
ini_file (may be null: uno.rc besides cppuhelper lib)
@param bootstrap_parameters
bootstrap parameters (maybe null)
+
+ @throws Exception if things go awry.
+ @return a freshly bootstrapped component context.
*/
public static final XComponentContext defaultBootstrap_InitialComponentContext(
String ini_file, Map<String,String> bootstrap_parameters )
@@ -269,6 +289,8 @@ public class Bootstrap {
/**
* Bootstraps the component context from a UNO installation.
*
+ * @throws BootstrapException if things go awry.
+ *
* @return a bootstrapped component context.
*
* @since UDK 3.1.0
@@ -287,6 +309,9 @@ public class Bootstrap {
* an array of strings - commandline options to start instance of
* soffice with
* @see #getDefaultOptions()
+ *
+ * @throws BootstrapException if things go awry.
+ *
* @return a bootstrapped component context.
*
* @since LibreOffice 5.1
diff --git a/javaunohelper/com/sun/star/comp/helper/SharedLibraryLoader.java b/javaunohelper/com/sun/star/comp/helper/SharedLibraryLoader.java
index e8a4fad..3c5bff7 100644
--- a/javaunohelper/com/sun/star/comp/helper/SharedLibraryLoader.java
+++ b/javaunohelper/com/sun/star/comp/helper/SharedLibraryLoader.java
@@ -153,6 +153,9 @@ public class SharedLibraryLoader {
* @param libName name of the shared library
* @param smgr the ServiceManager
* @param regKey the root key under that the component should be registered
+ * @throws com.sun.star.registry.InvalidRegistryException
+ * if the registry is not valid.
+ *
* @see com.sun.star.loader.SharedLibrary
*/
public static boolean writeRegistryServiceInfo(
diff --git a/javaunohelper/com/sun/star/lib/uno/helper/InterfaceContainer.java b/javaunohelper/com/sun/star/lib/uno/helper/InterfaceContainer.java
index 6da92d6..dcc58d2 100644
--- a/javaunohelper/com/sun/star/lib/uno/helper/InterfaceContainer.java
+++ b/javaunohelper/com/sun/star/lib/uno/helper/InterfaceContainer.java
@@ -220,6 +220,7 @@ public class InterfaceContainer implements Cloneable
* @param c the elements to be inserted into this list.
* @throws IndexOutOfBoundsException if index out of range <tt>(index
* < 0 || index > size())</tt>.
+ * @return true if an element was inserted.
*/
synchronized public boolean addAll(Collection c)
{
@@ -248,6 +249,7 @@ public class InterfaceContainer implements Cloneable
* @param c elements to be inserted into this list.
* @throws IndexOutOfBoundsException if index out of range <tt>(index
* < 0 || index > size())</tt>.
+ * @return true if an element was inserted.
*/
synchronized public boolean addAll(int index, Collection c)
{
@@ -305,6 +307,7 @@ public class InterfaceContainer implements Cloneable
* Returns <tt>true</tt> if this list contains the specified element.
*
* @param elem element whose presence in this List is to be tested.
+ * @return <tt>true</tt> if this list contains the specified element.
*/
synchronized public boolean contains(Object elem)
{
@@ -470,6 +473,8 @@ public class InterfaceContainer implements Cloneable
/** The iterator keeps a copy of the list. Changes to InterfaceContainer do not
* affect the data of the iterator. Conversely, changes to the iterator are effect
* InterfaceContainer.
+ * @param index the starting offset into the list.
+ * @return a new iterator.
*/
synchronized public ListIterator listIterator(int index)
{
@@ -508,7 +513,11 @@ public class InterfaceContainer implements Cloneable
}
- /** Parameter obj may */
+ /** Parameter obj may... or may not. What did the original author want
+ * to tell us here?
+ * @param obj the object to be removed.
+ * @return true if obj was successfully removed from the list.
+ */
synchronized public boolean remove(Object obj)
{
boolean ret= false;
diff --git a/javaunohelper/com/sun/star/lib/uno/helper/MultiTypeInterfaceContainer.java b/javaunohelper/com/sun/star/lib/uno/helper/MultiTypeInterfaceContainer.java
index 6ba3a48..a255721 100644
--- a/javaunohelper/com/sun/star/lib/uno/helper/MultiTypeInterfaceContainer.java
+++ b/javaunohelper/com/sun/star/lib/uno/helper/MultiTypeInterfaceContainer.java
@@ -31,6 +31,7 @@ public class MultiTypeInterfaceContainer
/** only returns types which have at least one value in InterfaceContainer
* return value can contain an element null, if someone called
* addInterface (null, interf)
+ * @return an array of types in this container.
*/
synchronized public Type[] getContainedTypes()
{
@@ -73,7 +74,10 @@ public class MultiTypeInterfaceContainer
return retVal;
}
- /** param key can be null */
+ /** param key can be null
+ * @param key the object for which the container should be retrieved.
+ * @return the container that contains the object key, if any.
+ */
synchronized public InterfaceContainer getContainer(Object key)
{
InterfaceContainer retVal= null;
diff --git a/javaunohelper/com/sun/star/lib/uno/helper/PropertySet.java b/javaunohelper/com/sun/star/lib/uno/helper/PropertySet.java
index 38f704c..ce33f52 100644
--- a/javaunohelper/com/sun/star/lib/uno/helper/PropertySet.java
+++ b/javaunohelper/com/sun/star/lib/uno/helper/PropertySet.java
@@ -482,6 +482,13 @@ XMultiPropertySet
* new value can be set. It also causes the notification of listeners.
* @param prop The property whose value is to be set.
* @param value The new value for the property.
+ *
+ * @throws UnknownPropertyException
+ * See com.sun.star.beans.XPropertySet
+ * @throws PropertyVetoException
+ * See com.sun.star.beans.XPropertySet
+ * @throws WrappedTargetException
+ * See com.sun.star.beans.XPropertySet
*/
protected void setPropertyValue(Property prop, Object value) throws UnknownPropertyException,
PropertyVetoException, com.sun.star.lang.IllegalArgumentException, WrappedTargetException
@@ -606,6 +613,9 @@ XMultiPropertySet
* dataformat for that property.
* @return true - Conversion was successful. <em>newVal</em> contains a valid value for the property. false -
* conversion failed for some reason.
+ *
+ * @throws UnknownPropertyException
+ * See com.sun.star.beans.XPropertySet
* @throws com.sun.star.lang.IllegalArgumentException The value provided is unfit for the property.
* @throws com.sun.star.lang.WrappedTargetException - An exception occurred during the conversion, that is to be made known
* to the caller.
@@ -863,6 +873,9 @@ XMultiPropertySet
* @param oldValues the old values of the properties.
* @param bVetoable true means fire to VetoableChangeListener, false means fire to
* XPropertyChangedListener and XMultiPropertyChangedListener.
+ *
+ * @throws PropertyVetoException
+ * if a vetoable listener throws it.
*/
protected void fire(
Property[] properties,
diff --git a/javaunohelper/com/sun/star/lib/uno/helper/PropertySetMixin.java b/javaunohelper/com/sun/star/lib/uno/helper/PropertySetMixin.java
index ab2a381..0c050d6 100644
--- a/javaunohelper/com/sun/star/lib/uno/helper/PropertySetMixin.java
+++ b/javaunohelper/com/sun/star/lib/uno/helper/PropertySetMixin.java
@@ -193,6 +193,8 @@ public final class PropertySetMixin {
(which has not been passed to this method before, and on which
{@link BoundListeners#notifyListeners} has not yet been called); may only
be null if the attribute that is going to be set is not bound
+
+ @throws PropertyVetoException if a vetoable listener throws it.
*/
public void prepareSet(
String propertyName, Object oldValue, Object newValue,
@@ -319,6 +321,7 @@ public final class PropertySetMixin {
/**
Implements
<code>com.sun.star.beans.XPropertySet.getPropertySetInfo</code>.
+ @return See com.sun.star.beans.XPropertySet
*/
public XPropertySetInfo getPropertySetInfo() {
return new Info(properties);
@@ -326,6 +329,16 @@ public final class PropertySetMixin {
/**
Implements <code>com.sun.star.beans.XPropertySet.setPropertyValue</code>.
+ @param propertyName
+ See com.sun.star.beans.XPropertySet
+ @param value
+ See com.sun.star.beans.XPropertySet
+ @throws UnknownPropertyException
+ See com.sun.star.beans.XPropertySet
+ @throws PropertyVetoException
+ See com.sun.star.beans.XPropertySet
+ @throws WrappedTargetException
+ See com.sun.star.beans.XPropertySet
*/
public void setPropertyValue(String propertyName, Object value)
throws UnknownPropertyException, PropertyVetoException,
@@ -336,6 +349,14 @@ public final class PropertySetMixin {
/**
Implements <code>com.sun.star.beans.XPropertySet.getPropertyValue</code>.
+ @param propertyName
+ See com.sun.star.beans.XPropertySet
+ @throws UnknownPropertyException
+ See com.sun.star.beans.XPropertySet
+ @throws WrappedTargetException
+ See com.sun.star.beans.XPropertySet
+ @return
+ See com.sun.star.beans.XPropertySet
*/
public Object getPropertyValue(String propertyName)
throws UnknownPropertyException, WrappedTargetException
@@ -349,6 +370,15 @@ public final class PropertySetMixin {
<p>If a listener is added more than once, it will receive all relevant
notifications multiple times.</p>
+
+ @param propertyName
+ See com.sun.star.beans.XPropertySet
+ @param listener
+ See com.sun.star.beans.XPropertySet
+ @throws UnknownPropertyException
+ See com.sun.star.beans.XPropertySet
+ @throws WrappedTargetException
+ See com.sun.star.beans.XPropertySet
*/
public void addPropertyChangeListener(
String propertyName, XPropertyChangeListener listener)
@@ -376,6 +406,15 @@ public final class PropertySetMixin {
/**
Implements <code>
com.sun.star.beans.XPropertySet.removePropertyChangeListener</code>.
+
+ @param propertyName
+ See com.sun.star.beans.XPropertySet
+ @param listener
+ See com.sun.star.beans.XPropertySet
+ @throws UnknownPropertyException
+ See com.sun.star.beans.XPropertySet
+ @throws WrappedTargetException
+ See com.sun.star.beans.XPropertySet
*/
public void removePropertyChangeListener(
String propertyName, XPropertyChangeListener listener)
@@ -399,6 +438,15 @@ public final class PropertySetMixin {
<p>If a listener is added more than once, it will receive all relevant
notifications multiple times.</p>
+
+ @param propertyName
+ See com.sun.star.beans.XPropertySet
+ @param listener
+ See com.sun.star.beans.XPropertySet
+ @throws UnknownPropertyException
+ See com.sun.star.beans.XPropertySet
+ @throws WrappedTargetException
+ See com.sun.star.beans.XPropertySet
*/
public void addVetoableChangeListener(
String propertyName, XVetoableChangeListener listener)
@@ -426,6 +474,15 @@ public final class PropertySetMixin {
/**
Implements <code>
com.sun.star.beans.XPropertySet.removeVetoableChangeListener</code>.
+
+ @param propertyName
+ See com.sun.star.beans.XPropertySet
+ @param listener
+ See com.sun.star.beans.XPropertySet
+ @throws UnknownPropertyException
+ See com.sun.star.beans.XPropertySet
+ @throws WrappedTargetException
+ See com.sun.star.beans.XPropertySet
*/
public void removeVetoableChangeListener(
String propertyName, XVetoableChangeListener listener)
@@ -446,6 +503,17 @@ public final class PropertySetMixin {
/**
Implements
<code>com.sun.star.beans.XFastPropertySet.setFastPropertyValue</code>.
+
+ @param handle
+ See com.sun.star.beans.XFastPropertySet
+ @param value
+ See com.sun.star.beans.XFastPropertySet
+ @throws UnknownPropertyException
+ See com.sun.star.beans.XFastPropertySet
+ @throws PropertyVetoException
+ See com.sun.star.beans.XFastPropertySet
+ @throws WrappedTargetException
+ See com.sun.star.beans.XFastPropertySet
*/
public void setFastPropertyValue(int handle, Object value)
throws UnknownPropertyException, PropertyVetoException,
@@ -457,6 +525,15 @@ public final class PropertySetMixin {
/**
Implements
<code>com.sun.star.beans.XFastPropertySet.getFastPropertyValue</code>.
+
+ @param handle
+ See com.sun.star.beans.XFastPropertySet
+ @throws UnknownPropertyException
+ See com.sun.star.beans.XFastPropertySet
+ @throws WrappedTargetException
+ See com.sun.star.beans.XFastPropertySet
+ @return
+ See com.sun.star.beans.XFastPropertySet
*/
public Object getFastPropertyValue(int handle)
throws UnknownPropertyException, WrappedTargetException
@@ -467,6 +544,9 @@ public final class PropertySetMixin {
/**
Implements
<code>com.sun.star.beans.XPropertyAccess.getPropertyValues</code>.
+
+ @return
+ See com.sun.star.beans.XPropertyAccess
*/
public PropertyValue[] getPropertyValues() {
PropertyValue[] s = new PropertyValue[handleMap.length];
@@ -495,6 +575,15 @@ public final class PropertySetMixin {
/**
Implements
<code>com.sun.star.beans.XPropertyAccess.setPropertyValues</code>.
+
+ @param props
+ See com.sun.star.beans.XPropertyAccess
+ @throws UnknownPropertyException
+ See com.sun.star.beans.XPropertyAccess
+ @throws PropertyVetoException
+ See com.sun.star.beans.XPropertyAccess
+ @throws WrappedTargetException
+ See com.sun.star.beans.XPropertyAccess
*/
public void setPropertyValues(PropertyValue[] props)
throws UnknownPropertyException, PropertyVetoException,
More information about the Libreoffice-commits
mailing list