@sitevision/api 2023.2.1 → 2023.2.2-beta.1

package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingCollection/index.d.ts

@@ -1,92 +1,95 @@
+import type { Iterator } from "../../../../../../java/util/Iterator";
+import type { Collection } from "../../../../../../java/util/Collection";
+
 /**
  * Decorates the iterator of a collection with a {@link ExceptionSuppressingIterator} to ensure exceptions are suppressed for all
- * iterator invocations.
+ *  iterator invocations.
  *
- * <p>
- *    The sole purpose of the <code>ExceptionSuppressingCollection</code> is to provide easy access to a decorated iterator
- *    (i.e. an {@link ExceptionSuppressingIterator}). You should <em>not</em> create a collection of exception suppressing proxys
- *    (i.e. <code>Collection&lt;ExceptionSuppressingProxy&gt;</code>) yourself. You should use <code>ExceptionSuppressingCollection</code>
- *    with your "regular" collection since the actual proxying is done by the iterator itself.
- * </p>
- * <p>
- *    Note that the <code>next</code> method of the interator returns an instance of a <em>Dynamic proxy</em> so not all methods can be invoked
- *    directly on the returned object. To invoke a method that is not proxied (i.e. a method not declared in an interface the object implements),
- *    you must extract the "real" object from the proxy and use that reference when invoking the method. See {@link ExceptionSuppressingIterator}
- *    for more information about the iterator and {@link ExceptionSuppressingProxy} for more information about dynamic proxies and how to extract
- *    "real" object.
- * </p>
+ *  <p>
+ *     The sole purpose of the <code>ExceptionSuppressingCollection</code> is to provide easy access to a decorated iterator
+ *     (i.e. an {@link ExceptionSuppressingIterator}). You should <em>not</em> create a collection of exception suppressing proxys
+ *     (i.e. <code>Collection&lt;ExceptionSuppressingProxy&gt;</code>) yourself. You should use <code>ExceptionSuppressingCollection</code>
+ *     with your "regular" collection since the actual proxying is done by the iterator itself.
+ *  </p>
+ *  <p>
+ *     Note that the <code>next</code> method of the interator returns an instance of a <em>Dynamic proxy</em> so not all methods can be invoked
+ *     directly on the returned object. To invoke a method that is not proxied (i.e. a method not declared in an interface the object implements),
+ *     you must extract the "real" object from the proxy and use that reference when invoking the method. See {@link ExceptionSuppressingIterator}
+ *     for more information about the iterator and {@link ExceptionSuppressingProxy} for more information about dynamic proxies and how to extract
+ *     "real" object.
+ *  </p>
  *
- * <p>
- *    <strong>Important note! </strong>This interface is intended to be used <em>only</em> in contexts where exceptions when iterating a
- *    collection will cause <em>serious</em> trouble if they arise and the context doesn't provide proper exception handling
- *    (e.g. when rendering a Velocity template). Suppressing exceptions is generally a bad idea and using this decorator will affect performance.
- *    Hence, this interface should only be used where the upsides with suppressing exceptions outweighs the downsides.
- *    This interface should be used only as a temporary patch/solution until the "real" problem causing the exception has been solved.
- * </p>
+ *  <p>
+ *     <strong>Important note! </strong>This interface is intended to be used <em>only</em> in contexts where exceptions when iterating a
+ *     collection will cause <em>serious</em> trouble if they arise and the context doesn't provide proper exception handling
+ *     (e.g. when rendering a Velocity template). Suppressing exceptions is generally a bad idea and using this decorator will affect performance.
+ *     Hence, this interface should only be used where the upsides with suppressing exceptions outweighs the downsides.
+ *     This interface should be used only as a temporary patch/solution until the "real" problem causing the exception has been solved.
+ *  </p>
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getExceptionSuppressingCollection(java.util.Collection)}.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.Utils#getExceptionSuppressingCollection(java.util.Collection)}.
+ *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
  *
- * <p>
- * ----------------------------------------------------------------------------------------------------
- * </p>
+ *  <p>
+ *  ----------------------------------------------------------------------------------------------------
+ *  </p>
  *
- * <p>
- * <strong>Example of how <code>ExceptionSuppressingCollection</code> could be used in Velocity:</strong>
- * </p>
+ *  <p>
+ *  <strong>Example of how <code>ExceptionSuppressingCollection</code> could be used in Velocity:</strong>
+ *  </p>
  *
- * <p>Case description:</p>
- * <p>
- *    <em>You have a Velocity template where you iterate a collection. Sometimes a certain method throws an exception.
- *    The rendered output of the template gets corrupt whenever an exception is thrown and you have not yet tracked down the root
- *    cause of the exception. Until the root cause is found and the problem is fixed, you need a temporary solution that ignores
- *    exceptions to keep template output acceptable. Since the method is declared in an interface and implemented in the instance
- *    you're invoking, you're in sheer luck. You can decorate your collection with a <code>ExceptionSuppressingCollection</code>
- *    to get a decorated iterator. When interating, all returned elements are proxied by an <code>ExceptionSuppressingProxy</code>.
- *    Invoking the method through the proxy will suppress exceptions and you can diminish the output problems.
- *    Note that you should invoke the real object for all non-problematic methods and methods that can't be proxied
- *    (i.e. methods not declared in an interface). To get a reference to the real object,
- *    use {@link ExceptionSuppressingProxy#getProxiedObject()}.</em>
- * </p>
- * <p>
- *    This is what the code looks like before your temporary fix:
- * </p>
- * <pre><code>
- *    #foreach ($item in $myCollection)
- *       &lt;p&gt;
- *          $item.thisNeverThrowsExceptions()
- *          $item.thisMethodSometimesThrowsExceptions()
- *       &lt;/p&gt;
- *    #end
- * </code></pre>
- * <p>
- *    This is how you could use an <code>ExceptionSuppressingCollection</code> to apply a temporary fix:
- * </p>
- * <pre><code>
- *    <em>## Decorate collection</em>
- *    #set ($decoratedCollection = $sitevisionUtils.getExceptionSuppressingCollection($myCollection))
+ *  <p>Case description:</p>
+ *  <p>
+ *     <em>You have a Velocity template where you iterate a collection. Sometimes a certain method throws an exception.
+ *     The rendered output of the template gets corrupt whenever an exception is thrown and you have not yet tracked down the root
+ *     cause of the exception. Until the root cause is found and the problem is fixed, you need a temporary solution that ignores
+ *     exceptions to keep template output acceptable. Since the method is declared in an interface and implemented in the instance
+ *     you're invoking, you're in sheer luck. You can decorate your collection with a <code>ExceptionSuppressingCollection</code>
+ *     to get a decorated iterator. When interating, all returned elements are proxied by an <code>ExceptionSuppressingProxy</code>.
+ *     Invoking the method through the proxy will suppress exceptions and you can diminish the output problems.
+ *     Note that you should invoke the real object for all non-problematic methods and methods that can't be proxied
+ *     (i.e. methods not declared in an interface). To get a reference to the real object,
+ *     use {@link ExceptionSuppressingProxy#getProxiedObject()}.</em>
+ *  </p>
+ *  <p>
+ *     This is what the code looks like before your temporary fix:
+ *  </p>
+ *  <pre><code>
+ *     #foreach ($item in $myCollection)
+ *        &lt;p&gt;
+ *           $item.thisNeverThrowsExceptions()
+ *           $item.thisMethodSometimesThrowsExceptions()
+ *        &lt;/p&gt;
+ *     #end
+ *  </code></pre>
+ *  <p>
+ *     This is how you could use an <code>ExceptionSuppressingCollection</code> to apply a temporary fix:
+ *  </p>
+ *  <pre><code>
+ *     <em>## Decorate collection</em>
+ *     #set ($decoratedCollection = $sitevisionUtils.getExceptionSuppressingCollection($myCollection))
  *
- *    #foreach ($item in $decoratedCollection)
- *       &lt;p&gt;
- *          <em>## Get the real object and invoke non-problematic method as usual</em>
- *          #set ($realObject = $item.getProxiedObject())
+ *     #foreach ($item in $decoratedCollection)
+ *        &lt;p&gt;
+ *           <em>## Get the real object and invoke non-problematic method as usual</em>
+ *           #set ($realObject = $item.getProxiedObject())
  *
- *          $realObject.thisNeverThrowsExceptions()
- *          $!item.thisMethodSometimesThrowsExceptions() <em>## Executed through a proxy, might return null</em>
- *      &lt;/p&gt;
- *   #end
- *   &lt;/p&gt;
- * </code></pre>
+ *           $realObject.thisNeverThrowsExceptions()
+ *           $!item.thisMethodSometimesThrowsExceptions() <em>## Executed through a proxy, might return null</em>
+ *       &lt;/p&gt;
+ *    #end
+ *    &lt;/p&gt;
+ *  </code></pre>
  * @author Magnus Lövgren
  * @since Sitevision 2.6.1_09
  */
-export type ExceptionSuppressingCollection = {
+export type ExceptionSuppressingCollection = Collection & {
   /**
    * Returns an exception suppressing iterator that ensures no exceptions will be thrown during iteration.
    * @return a {@link ExceptionSuppressingIterator} that suppresses exceptions and returns proxied items
    */
-  iterator(): unknown;
+  iterator(): Iterator;
 };

package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingIterator/index.d.ts

@@ -1,81 +1,83 @@
 import type { ExceptionSuppressingProxy } from "../ExceptionSuppressingProxy";
 
+import type { Iterator } from "../../../../../../java/util/Iterator";
+
 /**
  * Decorates an iterator with exception suppressing behaviour and returns {@link ExceptionSuppressingProxy}s in order to ensure that no
- * invocation will throw an exception.
+ *  invocation will throw an exception.
  *
- * <p>
- *    This iterator is of type <code>ExceptionSuppressingProxy</code> that is an implementation of a <em>Dynamic proxy</em> so not all
- *    methods can be directly invoked on objects retrieved by the <code>next</code> method. See {@link ExceptionSuppressingCollection}
- *    for an example of how this iterator can be used easily from Velocity and how to invoke methods not declared in an interface.
- *    See {@link ExceptionSuppressingProxy} for more information about dynamic proxies.
- * </p>
- * <p>
- * <strong>Important note! </strong>This interface is intended to be used <em>only</em> in contexts where exceptions thrown during iteration will
- * cause <em>serious</em> trouble if they arise and the context doesn't provide proper exception handling (e.g. when executing a Velocity template).
- * Suppressing exceptions is generally a bad idea and using this iterator will affect performance.
- * Hence, this interface should only be used where the upsides with suppressing exceptions far outweighs the downsides.
- * This interface should be used only as a temporary patch/solution until the "real" problem causing the exception has been solved.
- * </p>
+ *  <p>
+ *     This iterator is of type <code>ExceptionSuppressingProxy</code> that is an implementation of a <em>Dynamic proxy</em> so not all
+ *     methods can be directly invoked on objects retrieved by the <code>next</code> method. See {@link ExceptionSuppressingCollection}
+ *     for an example of how this iterator can be used easily from Velocity and how to invoke methods not declared in an interface.
+ *     See {@link ExceptionSuppressingProxy} for more information about dynamic proxies.
+ *  </p>
+ *  <p>
+ *  <strong>Important note! </strong>This interface is intended to be used <em>only</em> in contexts where exceptions thrown during iteration will
+ *  cause <em>serious</em> trouble if they arise and the context doesn't provide proper exception handling (e.g. when executing a Velocity template).
+ *  Suppressing exceptions is generally a bad idea and using this iterator will affect performance.
+ *  Hence, this interface should only be used where the upsides with suppressing exceptions far outweighs the downsides.
+ *  This interface should be used only as a temporary patch/solution until the "real" problem causing the exception has been solved.
+ *  </p>
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained directly via
- *    {@link senselogic.sitevision.api.Utils#getExceptionSuppressingIterator(java.util.Iterator)}
- *    or indirectly via {@link senselogic.sitevision.api.Utils#getExceptionSuppressingCollection(java.util.Collection)}.
- *    You would typically use the latter if you should iterate a collection with the Velocity #foreach loop.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained directly via
+ *     {@link senselogic.sitevision.api.Utils#getExceptionSuppressingIterator(java.util.Iterator)}
+ *     or indirectly via {@link senselogic.sitevision.api.Utils#getExceptionSuppressingCollection(java.util.Collection)}.
+ *     You would typically use the latter if you should iterate a collection with the Velocity #foreach loop.
+ *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 2.6.1_09
  */
-export type ExceptionSuppressingIterator = {
+export type ExceptionSuppressingIterator = Iterator & {
   /**
    * Returns <code>true</code> if decorated iterator has more elements. (In other words, returns <code>true</code>
-   * if <code>next</code> would return an element rather than throwing an exception.)
+   *  if <code>next</code> would return an element rather than throwing an exception.)
    *
-   * <p>
-   * This method will never throw an exception
-   * </p>
-   * @return <code>true</code> if the decorated iterator has more elements, <code>false</code> if not or if an exception is thrown by the decorated iterator
+   *  <p>
+   *  This method will never throw an exception
+   *  </p>
+   * @return <code>true</code> if the decorated iterator has more elements, <code>false</code> if not or if an exception is thrown&#xA; by the decorated iterator
    */
   hasNext(): boolean;
 
   /**
    * Returns a proxy for the next element of the decorated iterator. Calling this method repeatedly until the {@link #hasNext()} method
-   * returns <code>false</code> will return each element in the underlying collection exactly once.
+   *  returns <code>false</code> will return each element in the underlying collection exactly once.
    *
-   * <p>
-   *    <strong>Note!</strong> The returned element will be embedded in an <code>ExceptionSuppressingProxy</code> that will be reused for
-   *    <em>all</em> next() invocations on this iterator. In other words, the proxied item of the returned element will change,
-   *    but never the returned element itself. This implies that you shouldn't keep references to an item retrieved from a next()
-   *    invocation during iteration. If you do, don't be surprised if the element contains something else than it did when you set the reference...
-   * </p>
+   *  <p>
+   *     <strong>Note!</strong> The returned element will be embedded in an <code>ExceptionSuppressingProxy</code> that will be reused for
+   *     <em>all</em> next() invocations on this iterator. In other words, the proxied item of the returned element will change,
+   *     but never the returned element itself. This implies that you shouldn't keep references to an item retrieved from a next()
+   *     invocation during iteration. If you do, don't be surprised if the element contains something else than it did when you set the reference...
+   *  </p>
    *
-   * <p>
-   * This method will never throw an exception.
-   * </p>
-   * <p>
-   *    <strong>Note! </strong>Be aware of <code>null</code> items since they're never proxied. If the underlying collection contains a
-   *    <code>null</code> item, this iterator will just return <code>null</code>, not a proxy. In other words: even though this method
-   *    won't throw any exceptions, invoking a method on the returned object might throw a <code>NullPointerException</code>.
-   * </p>
+   *  <p>
+   *  This method will never throw an exception.
+   *  </p>
+   *  <p>
+   *     <strong>Note! </strong>Be aware of <code>null</code> items since they're never proxied. If the underlying collection contains a
+   *     <code>null</code> item, this iterator will just return <code>null</code>, not a proxy. In other words: even though this method
+   *     won't throw any exceptions, invoking a method on the returned object might throw a <code>NullPointerException</code>.
+   *  </p>
    * @return the next element, or <code>null</code> if an exception is thrown.
    */
   next(): ExceptionSuppressingProxy;
 
   /**
  * Tries to remove from the underlying collection the last element returned by decorated iterator (optional operation).
- * This method can be called only once per call to <code>next</code>. The behavior of an iterator is unspecified if
- * the underlying collection is modified while the iteration is in progress in any way other than by calling this method.
- *
- * <p>
- * This method will never throw an exception.
- * </p>
- * <p>
- * <strong>Note!</strong> Since exceptions are suppressed, you can never tell if the remove operation actually succeeded
- * or if the underlying collection doesn't support removal (i.e. <code>UnsupportedOperationException</code> thrown by the
- * decorated iterator is catched by this iterator).
- * </p>
+ *  This method can be called only once per call to <code>next</code>. The behavior of an iterator is unspecified if
+ *  the underlying collection is modified while the iteration is in progress in any way other than by calling this method.
+ * 
+ *  <p>
+ *  This method will never throw an exception.
+ *  </p>
+ *  <p>
+ *  <strong>Note!</strong> Since exceptions are suppressed, you can never tell if the remove operation actually succeeded
+ *  or if the underlying collection doesn't support removal (i.e. <code>UnsupportedOperationException</code> thrown by the
+ *  decorated iterator is catched by this iterator).
+ *  </p>
   
     */
   remove(): void;

package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingProxy/index.d.ts

@@ -1,71 +1,73 @@
+import type { Exception } from "../../../../../../java/lang/Exception";
+import type { Object } from "../../../../../../java/lang/Object";
 import type { ExceptionSuppressingProxyConstants } from "../../../render/velocity/VelocityAccess.ExceptionSuppressingProxyConstants";
 
 /**
  * Proxies an object and delegates all interface method invocations to the proxied object in order to ensure that no invocation
- * will throw an exception.
+ *  will throw an exception.
  *
- * <p>
- *    This interface is an exception suppressing implementation of a so called
- *    <em><a href="http://docs.oracle.com/javase/8/docs/technotes/guides/reflection/proxy.html">Dynamic proxy</a></em>.
- *    This means it will proxy all methods of an object that are declared in an interface implemented by the object.
- *    If a method invocation through this proxy throws an <code>Exception</code>, it will be catched and the default value will be returned
- *    (e.g. <code>null</code>, <code>0</code>, <code>false</code> etc).
- * </p>
+ *  <p>
+ *     This interface is an exception suppressing implementation of a so called
+ *     <em><a href="http://docs.oracle.com/javase/8/docs/technotes/guides/reflection/proxy.html">Dynamic proxy</a></em>.
+ *     This means it will proxy all methods of an object that are declared in an interface implemented by the object.
+ *     If a method invocation through this proxy throws an <code>Exception</code>, it will be catched and the default value will be returned
+ *     (e.g. <code>null</code>, <code>0</code>, <code>false</code> etc).
+ *  </p>
  *
- * <p>
- *    <strong>Important note! </strong>This interface is intended to be used <em>only</em> in contexts where exceptions will cause <em>serious</em>
- *    trouble if they arise and the context doesn't provide proper exception handling (e.g. when executing a Velocity template).
- *    Suppressing exceptions is generally a <em>really</em> bad idea and using this proxy will affect performance.
- *    Hence, this interface should only be used where the upsides with suppressing exceptions far outweighs the downsides.
- *    This interface should be used only as a temporary patch/solution until the "real" problem causing the exception has been solved.
- * </p>
+ *  <p>
+ *     <strong>Important note! </strong>This interface is intended to be used <em>only</em> in contexts where exceptions will cause <em>serious</em>
+ *     trouble if they arise and the context doesn't provide proper exception handling (e.g. when executing a Velocity template).
+ *     Suppressing exceptions is generally a <em>really</em> bad idea and using this proxy will affect performance.
+ *     Hence, this interface should only be used where the upsides with suppressing exceptions far outweighs the downsides.
+ *     This interface should be used only as a temporary patch/solution until the "real" problem causing the exception has been solved.
+ *  </p>
  *
- * <p>
- *    The state of an ExceptionSuppressingProxy is available at all times and updated for each method invocation
- *    (except for invocations of methods declared in this interface).
- *    If last method invocation resulted in a thrown exception the proxy status will be {@link #EXCEPTION_THROWN_STATUS}
- *    and the exception will be available via {@link #getCurrentException()}.
- * </p>
+ *  <p>
+ *     The state of an ExceptionSuppressingProxy is available at all times and updated for each method invocation
+ *     (except for invocations of methods declared in this interface).
+ *     If last method invocation resulted in a thrown exception the proxy status will be {@link #EXCEPTION_THROWN_STATUS}
+ *     and the exception will be available via {@link #getCurrentException()}.
+ *  </p>
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getExceptionSuppressingProxy(Object)}.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.Utils#getExceptionSuppressingProxy(Object)}.
+ *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
  *
- * <p>
- * ----------------------------------------------------------------------------------------------------
- * </p>
+ *  <p>
+ *  ----------------------------------------------------------------------------------------------------
+ *  </p>
  *
- * <p>
- * <strong>Example of how <code>ExceptionSuppressingProxy</code> could be used in Velocity:</strong>
- * </p>
+ *  <p>
+ *  <strong>Example of how <code>ExceptionSuppressingProxy</code> could be used in Velocity:</strong>
+ *  </p>
  *
- * <p>Case description:</p>
- * <p>
- *    <em>You have a Velocity template where a certain method invocation sometimes throws an exception.
- *    The rendered output of the template gets corrupt whenever an exception is thrown and you have not yet tracked down the root cause
- *    of the exception. Until the root cause is found and the problem is fixed, you need a temporary solution that ignores exceptions
- *    to keep template output acceptable. Since the method is declared in an interface and implemented in the instance you're invoking,
- *    you're in sheer luck. You can use an <code>ExceptionSuppressingProxy</code> to suppress exceptions in order to diminish output
- *    problems.</em><p>This is what the code looks like before your temporary fix:
- * </p>
- * <pre><code>
- *    &lt;p&gt;
- *       $myObject.thisNeverThrowsExceptions()
- *       $myObject.thisMethodSometimesThrowsExceptions() <em>## This method is declared in an interface, hence can be proxied</em>
- *    &lt;/p&gt;
- * </code></pre>
- * This is how you could use an <code>ExceptionSuppressingProxy</code> to apply a temporary fix:<pre><code>
- *    &lt;p&gt;
- *       $myObject.thisNeverThrowsExceptions()
+ *  <p>Case description:</p>
+ *  <p>
+ *     <em>You have a Velocity template where a certain method invocation sometimes throws an exception.
+ *     The rendered output of the template gets corrupt whenever an exception is thrown and you have not yet tracked down the root cause
+ *     of the exception. Until the root cause is found and the problem is fixed, you need a temporary solution that ignores exceptions
+ *     to keep template output acceptable. Since the method is declared in an interface and implemented in the instance you're invoking,
+ *     you're in sheer luck. You can use an <code>ExceptionSuppressingProxy</code> to suppress exceptions in order to diminish output
+ *     problems.</em><p>This is what the code looks like before your temporary fix:
+ *  </p>
+ *  <pre><code>
+ *     &lt;p&gt;
+ *        $myObject.thisNeverThrowsExceptions()
+ *        $myObject.thisMethodSometimesThrowsExceptions() <em>## This method is declared in an interface, hence can be proxied</em>
+ *     &lt;/p&gt;
+ *  </code></pre>
+ *  This is how you could use an <code>ExceptionSuppressingProxy</code> to apply a temporary fix:<pre><code>
+ *     &lt;p&gt;
+ *        $myObject.thisNeverThrowsExceptions()
  *
- *       <em>## Get an ExceptionSuppressingProxy instance for myObject</em>
- *       #set ($proxy = $sitevisionUtils.getExceptionSuppressingProxy($myObject))
+ *        <em>## Get an ExceptionSuppressingProxy instance for myObject</em>
+ *        #set ($proxy = $sitevisionUtils.getExceptionSuppressingProxy($myObject))
  *
- *       $!proxy.thisMethodSometimesThrowsExceptions() <em>## Method invoked through a proxy, might return null</em>
- *    &lt;/p&gt;
- * </code></pre>
+ *        $!proxy.thisMethodSometimesThrowsExceptions() <em>## Method invoked through a proxy, might return null</em>
+ *     &lt;/p&gt;
+ *  </code></pre>
  * @author Magnus Lövgren
  * @since Sitevision 2.6.1_09
  */
@@ -80,7 +82,7 @@ export type ExceptionSuppressingProxy = ExceptionSuppressingProxyConstants & {
    * Returns the exception that was thrown during last method invocation of the proxied object.
    * @return the exception thrown during last method invocation, or <code>null</code> if no exeption was thrown
    */
-  getCurrentException(): unknown;
+  getCurrentException(): Exception;
 
   /**
    * Returns the proxied object

package/types/senselogic/sitevision/api/search/SearchFieldUtil/index.d.ts

@@ -1,11 +1,19 @@
+import type { String } from "../../../../../java/lang/String";
+import type { Date } from "../../../../../java/util/Date";
+import type { Calendar } from "../../../../../java/util/Calendar";
+import type { Locale } from "../../../../../java/util/Locale";
+import type { Integer } from "../../../../../java/lang/Integer";
+import type { Long } from "../../../../../java/lang/Long";
+import type { Double } from "../../../../../java/lang/Double";
+
 /**
  * Utility class for converting String values extracted from search fields.
  *
- * <p>
- *    <strong>Note!</strong> {@link senselogic.sitevision.api.search.SearchHit} has - as of Sitevision 3.0 - several typed <code>getField</code>
- *    methods that you would typically instead of this interface when you want to get "non-String" values!
- *    <a href="../../../../senselogic/sitevision/api/search/SearchHit.html#knowyourfields">More information about field values/types</a>
- * </p>
+ *  <p>
+ *     <strong>Note!</strong> {@link senselogic.sitevision.api.search.SearchHit} has - as of Sitevision 3.0 - several typed <code>getField</code>
+ *     methods that you would typically instead of this interface when you want to get "non-String" values!
+ *     <a href="../../../../senselogic/sitevision/api/search/SearchHit.html#knowyourfields">More information about field values/types</a>
+ *  </p>
  * @author Magnus Lövgren
  * @see senselogic.sitevision.api.search.SearchHit#getBooleanField(String)
  * @see senselogic.sitevision.api.search.SearchHit#getDateField(String)
@@ -20,34 +28,34 @@ export type SearchFieldUtil = {
    * @param aDateFieldValue the <code>String</code> that should be converted to a <code>Date</code>
    * @return <code>aDateFieldValue</code> as <code>Date</code>, or <code>null</code> if indeterminable.
    */
-  dateFieldToDate(aDateFieldValue: string): unknown;
+  dateFieldToDate(aDateFieldValue: String | string): Date;
 
   /**
    * Returns the Calendar for a string field that contains a date value generated via Lucene's DateTools class.
    * @param aDateFieldValue the <code>String</code> that should be converted to a <code>Calendar</code>
    * @return <code>aDateFieldValue</code> as <code>Calendar</code>, or <code>null</code> if indeterminable.
    */
-  dateFieldToCalendar(aDateFieldValue: string): unknown;
+  dateFieldToCalendar(aDateFieldValue: String | string): Calendar;
 
   /**
    * Returns the Locale for a string field that contains a locale-based value that contains language ("en") or language and country ("en_US").
    *
-   * <p>
-   * A <code>toString()</code> on a english american locale returns the String <code>"en_US"</code>, but to create a locale
-   * from that string you can NOT just create it by doing: <code>new Locale("en_US")</code>. You must split language (en)
-   * and country (US) since the proper way of creating the Locale is: <code>new Locale("en", "US")</code>. Language must
-   * be lowercased and country must be uppercased. This method will handle that (i.e. <code>aLocaleFieldValue == "EN_us"</code>
-   * -&gt; <code>new Locale("en", "US")</code>).
-   * </p>
+   *  <p>
+   *  A <code>toString()</code> on a english american locale returns the String <code>"en_US"</code>, but to create a locale
+   *  from that string you can NOT just create it by doing: <code>new Locale("en_US")</code>. You must split language (en)
+   *  and country (US) since the proper way of creating the Locale is: <code>new Locale("en", "US")</code>. Language must
+   *  be lowercased and country must be uppercased. This method will handle that (i.e. <code>aLocaleFieldValue == "EN_us"</code>
+   *  -&gt; <code>new Locale("en", "US")</code>).
+   *  </p>
    *
-   * <p>
-   * <strong>Note!</strong> This method does <em>NOT</em> handle variants!
-   * </p>
+   *  <p>
+   *  <strong>Note!</strong> This method does <em>NOT</em> handle variants!
+   *  </p>
    * @param aLocaleFieldValue a String containing a language - or a language and country, separated with underscrore.
-   * @return a Locale matching <code>aLocaleFieldValue</code>, returns <code>null</code> if indeterminable (e.g <code>aLocaleFieldValue</code> is <code>null</code>)
+   * @return a Locale matching <code>aLocaleFieldValue</code>, returns <code>null</code> if indeterminable&#xA; (e.g <code>aLocaleFieldValue</code> is <code>null</code>)
    * @deprecated use {@link senselogic.sitevision.api.i18n.LocaleUtil#getLocaleByString(String)} instead
    */
-  localeFieldToLocale(aLocaleFieldValue: string): unknown;
+  localeFieldToLocale(aLocaleFieldValue: String | string): Locale;
 
   /**
    * Returns the Integer for a string field that contains a integer value generated via Lucene's NumberTools (i.e. long) class.
@@ -55,7 +63,7 @@ export type SearchFieldUtil = {
    * @return <code>anIntFieldValue</code> as <code>Integer</code>, or <code>null</code> if indeterminable.
    * @since Sitevision 2.6.2, 2.7.2
    */
-  intFieldToInt(anIntFieldValue: string): number;
+  intFieldToInt(anIntFieldValue: String | string): number;
 
   /**
    * Returns the Long for a string field that contains a long value generated via Lucene's NumberTools class.
@@ -63,7 +71,7 @@ export type SearchFieldUtil = {
    * @return <code>aLongFieldValue</code> as <code>Long</code>, or <code>null</code> if indeterminable.
    * @since Sitevision 2.6.2, 2.7.2
    */
-  longFieldToLong(aLongFieldValue: string): number;
+  longFieldToLong(aLongFieldValue: String | string): number;
 
   /**
    * Returns the Double for a string field that contains a double value generated to be a sortable search value.
@@ -71,5 +79,5 @@ export type SearchFieldUtil = {
    * @return <code>aDoubleFieldValue</code> as <code>Double</code>, or <code>null</code> if indeterminable.
    * @since Sitevision 2.6.2, 2.7.2
    */
-  doubleFieldToDouble(aDoubleFieldValue: string): number;
+  doubleFieldToDouble(aDoubleFieldValue: String | string): number;
 };

package/types/senselogic/sitevision/api/search/SearchHighlighter/index.d.ts

@@ -1,43 +1,44 @@
+import type { String } from "../../../../../java/lang/String";
 import type { SearchHit } from "../SearchHit";
 
 /**
  * <p>
- * This interface is deprecated and non-functional as of Sitevision 3.0. The Sitevision search engine has been replaced
- * (from Lucene to Solr) and highlighting of arbitrary fields in a search result via <code>SearchHighlighter</code> is no longer possible.
- * In Solr you should specify the field(-s) that should be highlighted when you execute the query.
- * </p>
+ *  This interface is deprecated and non-functional as of Sitevision 3.0. The Sitevision search engine has been replaced
+ *  (from Lucene to Solr) and highlighting of arbitrary fields in a search result via <code>SearchHighlighter</code> is no longer possible.
+ *  In Solr you should specify the field(-s) that should be highlighted when you execute the query.
+ *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 2.7_06
- * @deprecated This interface will do absolutely nothing as of Sitevision 3.0 (search engine has been replaced). Interface methods will not do anything (i.e. always return <code>null</code>) and this interface will be completely removed in future releases of Sitevision.
+ * @deprecated This interface will do absolutely nothing as of Sitevision 3.0 (search engine has been replaced).&#xA; Interface methods will not do anything (i.e. always return <code>null</code>) and this interface will be completely removed in&#xA; future releases of Sitevision.
  */
 export type SearchHighlighter = {
   /**
    * Returns a highlighted fragment for the default highlighting field.
-   * @param aHighlightPreElement the opening element to the left of a highlighted word(-s), e.g <code>"&lt;strong style=\"background-color:yellow\"&gt;"</code>
+   * @param aHighlightPreElement the opening element to the left of a highlighted word(-s),&#xA; e.g <code>"&lt;strong style=\"background-color:yellow\"&gt;"</code>
    * @param aHighlightPostElement the closing element to the right of a highlighted word(-s), e.g <code>"&lt;/strong&gt;"</code>
    * @param aSearchHit the search hit that should be highlighted
-   * @return a highlighted text fragment with all matches surrounded with <code>aHighlightPreElement</code> and <code>aHighlightPostElement</code>, <code>null</code> if nothing could be highlighted
-   * @deprecated As of Sitevision 3.0 this method will always return <code>null</code>. Do <strong>not</strong> use this interface at all, it will be completely removed in future releases of Sitevision.
+   * @return a highlighted text fragment with all matches surrounded with <code>aHighlightPreElement</code> and <code>aHighlightPostElement</code>,&#xA; <code>null</code> if nothing could be highlighted
+   * @deprecated As of Sitevision 3.0 this method will always return <code>null</code>. Do <strong>not</strong> use this interface at all,&#xA; it will be completely removed in future releases of Sitevision.
    */
   getHighlightedFragment(
-    aHighlightPreElement: string,
-    aHighlightPostElement: string,
+    aHighlightPreElement: String | string,
+    aHighlightPostElement: String | string,
     aSearchHit: SearchHit
   ): string;
 
   /**
    * Returns a highlighted fragment for a specified field.
-   * @param aHighlightPreElement the opening element to the left of a highlighted word(-s), e.g <code>"&lt;strong style=\"background-color:yellow\"&gt;"</code>
+   * @param aHighlightPreElement the opening element to the left of a highlighted word(-s),&#xA; e.g <code>"&lt;strong style=\"background-color:yellow\"&gt;"</code>
    * @param aHighlightPostElement the closing element to the right of a highlighted word(-s), e.g <code>"&lt;/strong&gt;"</code>
    * @param aSearchHit the search hit that should be highlighted
-   * @param aHighlightingFieldName the field that should be highlighted. A default field will be used if <code>aHighlightingFieldName</code> is <code>null</code>. The field that with most characters will be used if multiple fields match. Binary fields are ignored.
-   * @return a highlighted text fragment with all matches surrounded with <code>aHighlightPreElement</code> and <code>aHighlightPostElement</code>, <code>null</code> if nothing could be highlighted
-   * @deprecated As of Sitevision 3.0 this method will always return <code>null</code>. Do <strong>not</strong> use this interface at all, it will be completely removed in future releases of Sitevision.
+   * @param aHighlightingFieldName the field that should be highlighted. A default field will be used if&#xA; <code>aHighlightingFieldName</code> is <code>null</code>.&#xA; The field that with most characters will be used if multiple fields match. Binary fields are ignored.
+   * @return a highlighted text fragment with all matches surrounded with <code>aHighlightPreElement</code> and <code>aHighlightPostElement</code>,&#xA; <code>null</code> if nothing could be highlighted
+   * @deprecated As of Sitevision 3.0 this method will always return <code>null</code>. Do <strong>not</strong> use this interface at all,&#xA; it will be completely removed in future releases of Sitevision.
    */
   getHighlightedFragment(
-    aHighlightPreElement: string,
-    aHighlightPostElement: string,
+    aHighlightPreElement: String | string,
+    aHighlightPostElement: String | string,
     aSearchHit: SearchHit,
-    aHighlightingFieldName: string
+    aHighlightingFieldName: String | string
   ): string;
 };