@sitevision/api 2023.2.1 → 2023.2.2-beta.1

package/server/MathInstance/index.d.ts

@@ -2,30 +2,30 @@ import type { MathInstanceConstants } from "../../types/senselogic/sitevision/ap
 
 /**
  * Instance wrapper for the <code>java.lang.Math</code> class that delegates all method calls to
- * the corresponding <code>Math</code> method.
+ *  the corresponding <code>Math</code> method.
  *
- * <p>
- *    <em>Note! Method documentations in this interface are only excerpts. For full documentation, see official java.lang.Math Javadoc</em>
- * </p>
+ *  <p>
+ *     <em>Note! Method documentations in this interface are only excerpts. For full documentation, see official java.lang.Math Javadoc</em>
+ *  </p>
  *
- * <p>
- * An instance of the Sitevision class implementing this interface can be obtained via {@link InstanceCreatorUtil#getMathInstance()}.
- * See {@link InstanceCreatorUtil} for how to obtain an instance of the <code>InstanceCreatorUtil</code> interface.
- * </p>
+ *  <p>
+ *  An instance of the Sitevision class implementing this interface can be obtained via {@link InstanceCreatorUtil#getMathInstance()}.
+ *  See {@link InstanceCreatorUtil} for how to obtain an instance of the <code>InstanceCreatorUtil</code> interface.
+ *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.1
  */
 export interface MathInstance extends MathInstanceConstants {
   /**
  * The <code>double</code> value that is closer than any other to
- * <i>e</i>, the base of the natural logarithms.
+ *  <i>e</i>, the base of the natural logarithms.
   
     */
   E: 2.718281828459045;
 
   /**
  * The <code>double</code> value that is closer than any other to
- * <i>pi</i>, the ratio of the circumference of a circle to its diameter.
+ *  <i>pi</i>, the ratio of the circumference of a circle to its diameter.
   
     */
   PI: 3.141592653589793;
@@ -82,14 +82,14 @@ export interface MathInstance extends MathInstanceConstants {
   /**
    * Converts an angle measured in radians to an approximately equivalent angle measured in degrees.
    * @param anAngleInRadians an angle, in radians
-   * @return the measurement of the angle <code>anAngleInRadians</code> in degrees.
+   * @return the measurement of the angle <code>anAngleInRadians</code>&#xA; in degrees.
    */
   toDegrees(anAngleInRadians: number): number;
 
   /**
    * Returns Euler's number <i>e</i> raised to the power of a <code>double</code> value.
    * @param anExponent the exponent to raise <i>e</i> to.
-   * @return the value <i>e</i><sup><code>anExponent</code></sup>, where <i>e</i> is the base of the natural logarithms.
+   * @return the value <i>e</i><sup><code>anExponent</code></sup>,&#xA; where <i>e</i> is the base of the natural logarithms.
    */
   exp(anExponent: number): number;
 
@@ -110,7 +110,7 @@ export interface MathInstance extends MathInstanceConstants {
   /**
    * Returns the correctly rounded positive square root of a <code>double</code> value.
    * @param aValue a value.
-   * @return the positive square root of <code>aValue</code>. If the argument is NaN or less than zero, the result is NaN.
+   * @return the positive square root of <code>aValue</code>.&#xA; If the argument is NaN or less than zero, the result is NaN.
    */
   sqrt(aValue: number): number;
 
@@ -131,23 +131,23 @@ export interface MathInstance extends MathInstanceConstants {
 
   /**
    * Returns the smallest (closest to negative infinity) <code>double</code> value that is greater than
-   * or equal to the argument and is equal to a mathematical integer.
+   *  or equal to the argument and is equal to a mathematical integer.
    * @param aValue a value.
-   * @return the smallest (closest to negative infinity) floating-point value that is greater than or equal to the argument and is equal to a mathematical integer.
+   * @return the smallest (closest to negative infinity) floating-point value that is greater than&#xA; or equal to the argument and is equal to a mathematical integer.
    */
   ceil(aValue: number): number;
 
   /**
    * Returns the largest (closest to positive infinity) <code>double</code> value that is less than
-   * or equal to the argument and is equal to a mathematical integer.
+   *  or equal to the argument and is equal to a mathematical integer.
    * @param aValue a value.
-   * @return the largest (closest to positive infinity) floating-point value that less than or equal to the argument and is equal to a mathematical integer.
+   * @return the largest (closest to positive infinity) floating-point value that less than or equal to&#xA; the argument and is equal to a mathematical integer.
    */
   floor(aValue: number): number;
 
   /**
    * Returns the <code>double</code> value that is closest in value to the argument and is equal to
-   * a mathematical integer.
+   *  a mathematical integer.
    * @param aValue a value.
    * @return the closest floating-point value to <code>aValue</code> that is equal to a mathematical integer.
    */
@@ -155,10 +155,10 @@ export interface MathInstance extends MathInstanceConstants {
 
   /**
    * Returns the angle <i>theta</i> from the conversion of rectangular coordinates
-   * (<code>x</code>,&nbsp;<code>y</code>) to polar coordinates (r,&nbsp;<i>theta</i>).
+   *  (<code>x</code>,&nbsp;<code>y</code>) to polar coordinates (r,&nbsp;<i>theta</i>).
    * @param y the ordinate coordinate
    * @param x the abscissa coordinate
-   * @return the <i>theta</i> component of the point (<i>r</i>,&nbsp;<i>theta</i>) in polar coordinates that corresponds to the point (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates.
+   * @return the <i>theta</i> component of the point (<i>r</i>,&nbsp;<i>theta</i>) in polar coordinates&#xA; that corresponds to the point (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates.
    */
   atan2(y: number, x: number): number;
 
@@ -186,8 +186,8 @@ export interface MathInstance extends MathInstanceConstants {
 
   /**
    * Returns a <code>double</code> value with a positive sign, greater
-   * than or equal to <code>0.0</code> and less than <code>1.0</code>.
-   * @return a pseudorandom <code>double</code> greater than or equal to <code>0.0</code> and less than <code>1.0</code>.
+   *  than or equal to <code>0.0</code> and less than <code>1.0</code>.
+   * @return a pseudorandom <code>double</code> greater than or equal&#xA; to <code>0.0</code> and less than <code>1.0</code>.
    */
   random(): number;
 
@@ -336,13 +336,13 @@ export interface MathInstance extends MathInstanceConstants {
    * Returns sqrt(<i>x</i><sup>2</sup>&nbsp;+<i>y</i><sup>2</sup>) without intermediate overflow or underflow.
    * @param x a value
    * @param y a value
-   * @return sqrt(<i>x</i><sup>2</sup>&nbsp;+<i>y</i><sup>2</sup>) without intermediate overflow or underflow
+   * @return sqrt(<i>x</i><sup>2</sup>&nbsp;+<i>y</i><sup>2</sup>)&#xA; without intermediate overflow or underflow
    */
   hypot(x: number, y: number): number;
 
   /**
    * Returns <i>e</i><sup>x</sup>&nbsp;-1.
-   * @param x the exponent to raise <i>e</i> to in the computation of <i>e</i><sup><code>x</code></sup>&nbsp;-1.
+   * @param x the exponent to raise <i>e</i> to in the computation of&#xA; <i>e</i><sup><code>x</code></sup>&nbsp;-1.
    * @return the value <i>e</i><sup><code>x</code></sup>&nbsp;-&nbsp;1.
    */
   expm1(x: number): number;
@@ -416,7 +416,7 @@ export interface MathInstance extends MathInstanceConstants {
 
   /**
    * Return <code>aDouble</code> &times; 2<sup><code>aScaleFactor</code></sup> rounded as if performed
-   * by a single correctly rounded floating-point multiply to a member of the double value set.
+   *  by a single correctly rounded floating-point multiply to a member of the double value set.
    * @param aDouble number to be scaled by a power of two.
    * @param aScaleFactor power of 2 used to scale <code>aDouble</code>
    * @return <code>aDouble</code> &times; 2<sup><code>aScaleFactor</code></sup>
@@ -425,7 +425,7 @@ export interface MathInstance extends MathInstanceConstants {
 
   /**
    * Return <code>aFloat</code> &times; 2<sup><code>aScaleFactor</code></sup> rounded as if performed
-   * by a single correctly rounded floating-point multiply to a member of the float value set.
+   *  by a single correctly rounded floating-point multiply to a member of the float value set.
    * @param aFloat number to be scaled by a power of two.
    * @param aScaleFactor power of 2 used to scale <code>aFloat</code>
    * @return <code>aFloat</code> &times; 2<sup><code>aScaleFactor</code></sup>
@@ -571,7 +571,7 @@ export interface MathInstance extends MathInstanceConstants {
    * Returns the largest (closest to positive infinity) {@code int} value that is less than or equal to the algebraic quotient.
    * @param x the dividend
    * @param y the divisor
-   * @return the largest (closest to positive infinity) {@code int} value that is less than or equal to the algebraic quotient.
+   * @return the largest (closest to positive infinity)&#xA; {@code int} value that is less than or equal to the algebraic quotient.
    * @throws ArithmeticException if the divisor {@code y} is zero
    * @see #floorMod(int, int)
    * @see #floor(double)
@@ -584,7 +584,7 @@ export interface MathInstance extends MathInstanceConstants {
    * Returns the largest (closest to positive infinity) {@code long} value that is less than or equal to the algebraic quotient.
    * @param x the dividend
    * @param y the divisor
-   * @return the largest (closest to positive infinity) {@code long} value that is less than or equal to the algebraic quotient.
+   * @return the largest (closest to positive infinity)&#xA; {@code long} value that is less than or equal to the algebraic quotient.
    * @throws ArithmeticException if the divisor {@code y} is zero
    * @see #floorMod(long, long)
    * @see #floor(double)

package/server/MessageDigesterFactory/index.d.ts

@@ -2,19 +2,19 @@ import type { MessageDigester } from "../../types/senselogic/sitevision/api/secu
 
 /**
  * Factory that provides message digester instances that can perform
- * hash computation using a specific algorithm.
+ *  hash computation using a specific algorithm.
  *
- * <p>
- *    Message digests are secure one-way hash functions that take arbitrary-sized
- *    data and output a fixed-length hash value. This factory provides instances
- *    that supports common message digest algorithms, such as MD5 and SHA-256.
- * </p>
+ *  <p>
+ *     Message digests are secure one-way hash functions that take arbitrary-sized
+ *     data and output a fixed-length hash value. This factory provides instances
+ *     that supports common message digest algorithms, such as MD5 and SHA-256.
+ *  </p>
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getMessageDigesterFactory()}. 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#getMessageDigesterFactory()}. 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 5.0.1
  */

package/server/MetadataDefinitionUtil/index.d.ts

@@ -1,109 +1,111 @@
 import type { Node } from "../../types/javax/jcr/Node";
+import type { String } from "../../types/java/lang/String";
+import type { List } from "../../types/java/util/List";
 
 /**
  * Utility interface for getting metadata definitions.
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getMetadataDefinitionUtil()}.
- *    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#getMetadataDefinitionUtil()}.
+ *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
  *
- * <p>
- *    <strong>Velocity example:</strong> This code gets all properties and nodes for a metadata definition named 'aMetadataName'.
- * </p>
+ *  <p>
+ *     <strong>Velocity example:</strong> This code gets all properties and nodes for a metadata definition named 'aMetadataName'.
+ *  </p>
  *
- * <pre><code>
- *   #set ($page = ...)
+ *  <pre><code>
+ *    #set ($page = ...)
  *
- *   #set ($definitionUtil = $sitevisionUtils.metadataDefinitionUtil)
- *   #set($definition = $definitionUtil.getDefinition($page, 'aMetadataName'))
+ *    #set ($definitionUtil = $sitevisionUtils.metadataDefinitionUtil)
+ *    #set($definition = $definitionUtil.getDefinition($page, 'aMetadataName'))
  *
- *   #set($nodes = $definition.getNodes())
- *   #foreach($node in $nodes)
- *      $node
- *   #end
+ *    #set($nodes = $definition.getNodes())
+ *    #foreach($node in $nodes)
+ *       $node
+ *    #end
  *
- *   #set($properties = $definition.getProperties())
- *   #foreach($property in $properties)
- *      $property
- *   #end
- * </code></pre>
+ *    #set($properties = $definition.getProperties())
+ *    #foreach($property in $properties)
+ *       $property
+ *    #end
+ *  </code></pre>
  * @author Daniel Pyykkö
  * @since Sitevision 2.6.2_04
  */
 export interface MetadataDefinitionUtil {
   /**
    * Gets a metadata definition as a {@code Node} from a {@code Node}.
-   * @param aNode the {@code Node} that has a metadata definition
-   * @param aDefinitionName the name of the metadata definition
+   * @param aNode&#xA; the {@code Node} that has a metadata definition
+   * @param aDefinitionName&#xA; the name of the metadata definition
    * @return the value for {@code aDefinitionName} as a {@code Node}. If no definition exists or it is not a {@code Node}, {@code null} is returned.
    */
-  getDefinition(aNode: Node, aDefinitionName: string): Node;
+  getDefinition(aNode: Node, aDefinitionName: String | string): Node;
 
   /**
    * Gets a metadata definition as a {@code Node} from a {@code Node} with a fallback value if the definition does not exist.
-   * @param aNode the {@code Node} that has a metadata definition
-   * @param aDefinitionName the name of the metadata definition
-   * @param aDefaultValue fallback value if no definition exists
-   * @return the value for {@code aDefinitionName} as a {@code Node}. If no definition exists or it is not a {@code Node}, {@code aDefaultValue} is returned.
+   * @param aNode&#xA; the {@code Node} that has a metadata definition
+   * @param aDefinitionName&#xA; the name of the metadata definition
+   * @param aDefaultValue&#xA; fallback value if no definition exists
+   * @return the value for {@code aDefinitionName} as a {@code Node}. If no definition exists or it is not a {@code Node},&#xA; {@code aDefaultValue} is returned.
    */
   getDefinition(
     aNode: Node,
-    aDefinitionName: string,
+    aDefinitionName: String | string,
     aDefaultValue: Node
   ): Node;
 
   /**
    * Gets all metadata definitions available for the current user on a {@code Node}
-   * @param aNode the {@code Node} that has a metadata definition
+   * @param aNode&#xA; the {@code Node} that has a metadata definition
    * @return a list of definitions on {@code aNode}, or empty list
    * @since Sitevision 4.2.3
    */
-  getDefinitions(aNode: Node): unknown;
+  getDefinitions(aNode: Node): List;
 
   /**
    * Add an alternative to a definition
-   * @param aNode the {@code Node} where the metadata definition is located
-   * @param aDefinitionName the name of the metadata definition. May not be <code>null</code> or whitespace only
-   * @param aAlternativeName the name of the alternative (case in-sensitive). May not be <code>null</code> or whitespace only
-   * @throws RepositoryException if {@code aNode} is invalid, if {@code aNode} does not have a metadata definition named {@code aDefinitionName}, if it already contains an alternative named {@code aAlternativeName}, or if something else goes wrong
+   * @param aNode&#xA; the {@code Node} where the metadata definition is located
+   * @param aDefinitionName&#xA; the name of the metadata definition. May not be <code>null</code> or whitespace only
+   * @param aAlternativeName&#xA; the name of the alternative (case in-sensitive). May not be <code>null</code> or whitespace only
+   * @throws RepositoryException if {@code aNode} is invalid,&#xA; if {@code aNode} does not have a metadata definition named {@code aDefinitionName},&#xA; if it already contains an alternative named {@code aAlternativeName},&#xA; or if something else goes wrong
    * @since Sitevision 4.2.3
    */
   addAlternative(
     aNode: Node,
-    aDefinitionName: string,
-    aAlternativeName: string
+    aDefinitionName: String | string,
+    aAlternativeName: String | string
   ): void;
 
   /**
    * Rename an alternative for a definition
-   * @param aNode the {@code Node} where the metadata definition is located
-   * @param aDefinitionName the name of the metadata definition. May not be <code>null</code> or whitespace only
-   * @param aAlternativeName the name of the alternative (case in-sensitive). May not be <code>null</code> or whitespace only
-   * @param aNewAlternativeName the new name of the alternative. May not be <code>null</code> or whitespace only
-   * @throws RepositoryException if {@code aNode} is invalid, if {@code aNode} does not have a metadata definition named {@code aDefinitionName}, if it does not contain an alternative named {@code aAlternativeName}, if it already contains an alternative named {@code aNewAlternativeName}, or if something else goes wrong
+   * @param aNode&#xA; the {@code Node} where the metadata definition is located
+   * @param aDefinitionName&#xA; the name of the metadata definition. May not be <code>null</code> or whitespace only
+   * @param aAlternativeName&#xA; the name of the alternative (case in-sensitive). May not be <code>null</code> or whitespace only
+   * @param aNewAlternativeName&#xA; the new name of the alternative. May not be <code>null</code> or whitespace only
+   * @throws RepositoryException if {@code aNode} is invalid,&#xA; if {@code aNode} does not have a metadata definition named {@code aDefinitionName},&#xA; if it does not contain an alternative named {@code aAlternativeName},&#xA; if it already contains an alternative named {@code aNewAlternativeName},&#xA; or if something else goes wrong
    * @since Sitevision 8.1
    */
   renameAlternative(
     aNode: Node,
-    aDefinitionName: string,
-    aAlternativeName: string,
-    aNewAlternativeName: string
+    aDefinitionName: String | string,
+    aAlternativeName: String | string,
+    aNewAlternativeName: String | string
   ): void;
 
   /**
    * Remove an alternative from a definition
-   * @param aNode the {@code Node} where the metadata definition is located
-   * @param aDefinitionName the name of the metadata definition. May not be <code>null</code> or whitespace only
-   * @param aAlternativeName the name of the alternative (case in-sensitive). May not be <code>null</code> or whitespace only
-   * @throws RepositoryException if {@code aNode} is invalid, if {@code aNode} does not have a metadata definition named {@code aDefinitionName}, if it does not contain an alternative named {@code aAlternativeName}, or if something else goes wrong
+   * @param aNode&#xA; the {@code Node} where the metadata definition is located
+   * @param aDefinitionName&#xA; the name of the metadata definition. May not be <code>null</code> or whitespace only
+   * @param aAlternativeName&#xA; the name of the alternative (case in-sensitive). May not be <code>null</code> or whitespace only
+   * @throws RepositoryException if {@code aNode} is invalid,&#xA; if {@code aNode} does not have a metadata definition named {@code aDefinitionName},&#xA; if it does not contain an alternative named {@code aAlternativeName},&#xA; or if something else goes wrong
    * @since Sitevision 8.1
    */
   removeAlternative(
     aNode: Node,
-    aDefinitionName: string,
-    aAlternativeName: string
+    aDefinitionName: String | string,
+    aAlternativeName: String | string
   ): void;
 }