strepsirrhini/office-gobmx
9
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

javaunohelper: fix all javadoc warnings

Browse source 
Change-Id: Iaaeab13005fef160def2e5bd49d4bfd40f42fe33
This commit is contained in:
Michael Stahl 2016-02-16 17:57:37 +01:00
parent 53f0eb12f0
commit 11e55a0029
6 changed files with 146 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
javaunohelper/com/sun/star/comp/helper/Bootstrap.java
View file

@ -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

3
javaunohelper/com/sun/star/comp/helper/SharedLibraryLoader.java
View file

@ -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(

11
javaunohelper/com/sun/star/lib/uno/helper/InterfaceContainer.java
View file

@ -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
* &lt; 0 || index &gt; 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
* &lt; 0 || index &gt; 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;

6
javaunohelper/com/sun/star/lib/uno/helper/MultiTypeInterfaceContainer.java
View file

@ -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;

13
javaunohelper/com/sun/star/lib/uno/helper/PropertySet.java
View file

@ -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,

89
javaunohelper/com/sun/star/lib/uno/helper/PropertySetMixin.java
View file

@ -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,