@sitevision/api 2023.2.1 → 2023.2.2-beta.2

package/server/LogUtil/index.d.ts

@@ -1,22 +1,26 @@
+import type { String } from "../../types/java/lang/String";
+
+import type { Throwable } from "../../types/java/lang/Throwable";
+
 /**
  * Logging utility class for simple logging to the Sitevision server log.
- * <p>
- *    If you implement a custom portlet you would typically use a logging framework, not this class.
- * </p>
+ *  <p>
+ *     If you implement a custom portlet you would typically use a logging framework, not this class.
+ *  </p>
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getLogUtil()}.
- *    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#getLogUtil()}.
+ *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
  * @author Magnus Lövgren
  */
 export interface LogUtil {
   /**
    * Checks if trace logging is enabled.
    *
-   * <p>
-   *    Appropriate to check first if you are about to do extensive/expensive trace logging.
-   * </p>
+   *  <p>
+   *     Appropriate to check first if you are about to do extensive/expensive trace logging.
+   *  </p>
    * @return <code>true</code> if trace logging is enabled, <code>false</code> otherwise
    * @since Sitevision 4.1
    */
@@ -27,7 +31,7 @@ export interface LogUtil {
    * @param aMessage a message.
    * @since Sitevision 4.1
    */
-  trace(aMessage: string): void;
+  trace(aMessage: String | string): void;
 
   /**
    * Logs a trace message to the Sitevision server log.
@@ -35,14 +39,14 @@ export interface LogUtil {
    * @param aThrowable a throwable.
    * @since Sitevision 4.1
    */
-  trace(aMessage: string, aThrowable: unknown): void;
+  trace(aMessage: String | string, aThrowable: Throwable): void;
 
   /**
    * Checks if debug logging is enabled.
    *
-   * <p>
-   *    Appropriate to check first if you are about to do extensive/expensive debug logging.
-   * </p>
+   *  <p>
+   *     Appropriate to check first if you are about to do extensive/expensive debug logging.
+   *  </p>
    * @return <code>true</code> if debug logging is enabled, <code>false</code> otherwise
    * @since Sitevision 3.0
    */
@@ -52,21 +56,21 @@ export interface LogUtil {
    * Logs a debug message to the Sitevision server log.
    * @param aMessage a message.
    */
-  debug(aMessage: string): void;
+  debug(aMessage: String | string): void;
 
   /**
    * Logs a debug message to the Sitevision server log.
    * @param aMessage a message.
    * @param aThrowable a throwable.
    */
-  debug(aMessage: string, aThrowable: unknown): void;
+  debug(aMessage: String | string, aThrowable: Throwable): void;
 
   /**
    * Checks if info logging is enabled.
    *
-   * <p>
-   *    Appropriate to check first if you are about to do extensive/expensive info logging.
-   * </p>
+   *  <p>
+   *     Appropriate to check first if you are about to do extensive/expensive info logging.
+   *  </p>
    * @return <code>true</code> if info logging is enabled, <code>false</code> otherwise
    * @since Sitevision 4.1
    */
@@ -76,14 +80,14 @@ export interface LogUtil {
    * Logs an info message to the Sitevision server log.
    * @param aMessage a message.
    */
-  info(aMessage: string): void;
+  info(aMessage: String | string): void;
 
   /**
    * Logs an info message to the Sitevision server log.
    * @param aMessage a message.
    * @param aThrowable a throwable.
    */
-  info(aMessage: string, aThrowable: unknown): void;
+  info(aMessage: String | string, aThrowable: Throwable): void;
 
   /**
    * Checks if warn logging is enabled.
@@ -96,14 +100,14 @@ export interface LogUtil {
    * Logs a warn message to the Sitevision server log.
    * @param aMessage a message.
    */
-  warn(aMessage: string): void;
+  warn(aMessage: String | string): void;
 
   /**
    * Logs a warn message to the Sitevision server log.
    * @param aMessage a message.
    * @param aThrowable a throwable.
    */
-  warn(aMessage: string, aThrowable: unknown): void;
+  warn(aMessage: String | string, aThrowable: Throwable): void;
 
   /**
    * Checks if error logging is enabled.
@@ -116,14 +120,14 @@ export interface LogUtil {
    * Logs an error message to the Sitevision server log.
    * @param aMessage a message.
    */
-  error(aMessage: string): void;
+  error(aMessage: String | string): void;
 
   /**
    * Logs an error message to the Sitevision server log.
    * @param aMessage a message.
    * @param aThrowable a throwable.
    */
-  error(aMessage: string, aThrowable: unknown): void;
+  error(aMessage: String | string, aThrowable: Throwable): void;
 }
 
 declare namespace LogUtil {}

package/server/MailBuilder/index.d.ts

@@ -1,115 +1,116 @@
+import type { String } from "../../types/java/lang/String";
 import type { Mail } from "../../types/senselogic/sitevision/api/mail/Mail";
 import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";
 
 /**
  * Builder to create a Mail instances that can be sent.
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.mail.MailUtil#getMailBuilder()}.
- *    See {@link senselogic.sitevision.api.mail.MailUtil} for how to obtain an instance of the <code>MailUtil</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.mail.MailUtil#getMailBuilder()}.
+ *     See {@link senselogic.sitevision.api.mail.MailUtil} for how to obtain an instance of the <code>MailUtil</code> interface.
+ *  </p>
  *
- * <p>
- *    MailBuilder has some <strong>mandatory attributes</strong>:
- * </p>
- * <ul>
- *    <li>
- *       <em>subject</em> - The mail subject. Must be non-null.
- *    </li>
- *    <li>
- *       <em>message</em> - The mail message. Can be a text message (text/plain), a html message (text/html), or both. Must be non-null.
- *    </li>
- *    <li>
- *       <em>recipients</em> - The mail recipient (TO). At least one recipient must be added.
- *    </li>
- * </ul>
- * <p>
- *    MailBuilder also has some <strong>optional attributes</strong>:
- * </p>
- * <ul>
- *    <li>
- *       <em>copyRecipients</em> - The carbon copy recipients (CC). Default is <code>null</code>.
- *    </li>
- *    <li>
- *       <em>blindCopyRecipients</em> - The blind carbon copy recipients (BCC). Default is <code>null</code>.
- *    </li>
- *    <li>
- *       <em>fromAddress</em> - The from address. Default is the address of the site responsible and the
- *       address of the server responsible as fallback.
- *    </li>
- *    <li>
- *       <em>replyTos</em> - The reply-to addresses. Default is <code>null</code>.
- *    </li>
- * </ul>
+ *  <p>
+ *     MailBuilder has some <strong>mandatory attributes</strong>:
+ *  </p>
+ *  <ul>
+ *     <li>
+ *        <em>subject</em> - The mail subject. Must be non-null.
+ *     </li>
+ *     <li>
+ *        <em>message</em> - The mail message. Can be a text message (text/plain), a html message (text/html), or both. Must be non-null.
+ *     </li>
+ *     <li>
+ *        <em>recipients</em> - The mail recipient (TO). At least one recipient must be added.
+ *     </li>
+ *  </ul>
+ *  <p>
+ *     MailBuilder also has some <strong>optional attributes</strong>:
+ *  </p>
+ *  <ul>
+ *     <li>
+ *        <em>copyRecipients</em> - The carbon copy recipients (CC). Default is <code>null</code>.
+ *     </li>
+ *     <li>
+ *        <em>blindCopyRecipients</em> - The blind carbon copy recipients (BCC). Default is <code>null</code>.
+ *     </li>
+ *     <li>
+ *        <em>fromAddress</em> - The from address. Default is the address of the site responsible and the
+ *        address of the server responsible as fallback.
+ *     </li>
+ *     <li>
+ *        <em>replyTos</em> - The reply-to addresses. Default is <code>null</code>.
+ *     </li>
+ *  </ul>
  *
- * <p>
- *    <em>Note that there are three types of recipients (TO, CC, BCC). This builder will not detect or automatically handle duplicates
- *    cross types. It is up to the mail builder user to ensure addresses aren't added as different types of recipients.</em>
- * </p>
+ *  <p>
+ *     <em>Note that there are three types of recipients (TO, CC, BCC). This builder will not detect or automatically handle duplicates
+ *     cross types. It is up to the mail builder user to ensure addresses aren't added as different types of recipients.</em>
+ *  </p>
  *
- * <p>
- *    Using the MailBuilder is pretty straightforward, if you remember that it is <strong>stateful</strong>. Conceptually you
- *    would typically use it like this:
- * </p>
- * <ol>
- *   <li>Get the MailBuilder</li>
- *   <li>Set the subject</li>
- *   <li>Set the text message</li>
- *   <li>Add a recipient</li>
- *   <li>Possibly add another recipient</li>
- *   <li>Possibly set the from address</li>
- *   <li>Possibly add a reply-to address</li>
- *   <li>Possibly add another reply-to address</li>
- *   <li>Do build (+ send)</li>
- * </ol>
- * <p>
- *    When you have built a <code>Mail</code> instance, you can re-use the MailBuilder to build more instances. Something like:
- * </p>
- * <ol>
- *   <li>Set a new subject</li>
- *   <li>Set a new text message</li>
- *   <li>Clear recipients</li>
- *   <li>Add a new recipient</li>
- *   <li>Do build (+ send)</li>
- * </ol>
+ *  <p>
+ *     Using the MailBuilder is pretty straightforward, if you remember that it is <strong>stateful</strong>. Conceptually you
+ *     would typically use it like this:
+ *  </p>
+ *  <ol>
+ *    <li>Get the MailBuilder</li>
+ *    <li>Set the subject</li>
+ *    <li>Set the text message</li>
+ *    <li>Add a recipient</li>
+ *    <li>Possibly add another recipient</li>
+ *    <li>Possibly set the from address</li>
+ *    <li>Possibly add a reply-to address</li>
+ *    <li>Possibly add another reply-to address</li>
+ *    <li>Do build (+ send)</li>
+ *  </ol>
+ *  <p>
+ *     When you have built a <code>Mail</code> instance, you can re-use the MailBuilder to build more instances. Something like:
+ *  </p>
+ *  <ol>
+ *    <li>Set a new subject</li>
+ *    <li>Set a new text message</li>
+ *    <li>Clear recipients</li>
+ *    <li>Add a new recipient</li>
+ *    <li>Do build (+ send)</li>
+ *  </ol>
  *
- * <p>
- *    <strong>Example of how this strategy could be implemented in Velocity:</strong><br>
- *    (send one "personalized" mail to Magnus and one to Mikael)
- * </p>
- * <pre><code>
- *   <em>## Get the mail util and the mail builder</em>
- *   #set ($mailUtil = $sitevisionUtils.mailUtil)
- *   #set ($mailBuilder = $mailUtil.mailBuilder)
+ *  <p>
+ *     <strong>Example of how this strategy could be implemented in Velocity:</strong><br>
+ *     (send one "personalized" mail to Magnus and one to Mikael)
+ *  </p>
+ *  <pre><code>
+ *    <em>## Get the mail util and the mail builder</em>
+ *    #set ($mailUtil = $sitevisionUtils.mailUtil)
+ *    #set ($mailBuilder = $mailUtil.mailBuilder)
  *
- *   <em>## Create a mail</em>
- *   #set ($mail = $mailBuilder.setSubject('Hello buddy'
- *                            ).setTextMessage('How are you Magnus?'
- *                            ).addRecipient('magnus.lovgren@sitevision.se'
- *                            ).build())
- *   <em>## Send mail</em>
- *   #if ($mail.send())
- *      &lt;p&gt;Mail to Magnus successfully sent!&lt;/p&gt;
- *   #else
- *      &lt;p&gt;Mail to Magnus could &lt;strong&gt;not&lt;/strong&gt; be sent!&lt;/p&gt;
- *   #end
+ *    <em>## Create a mail</em>
+ *    #set ($mail = $mailBuilder.setSubject('Hello buddy'
+ *                             ).setTextMessage('How are you Magnus?'
+ *                             ).addRecipient('magnus.lovgren@sitevision.se'
+ *                             ).build())
+ *    <em>## Send mail</em>
+ *    #if ($mail.send())
+ *       &lt;p&gt;Mail to Magnus successfully sent!&lt;/p&gt;
+ *    #else
+ *       &lt;p&gt;Mail to Magnus could &lt;strong&gt;not&lt;/strong&gt; be sent!&lt;/p&gt;
+ *    #end
  *
- *   <em>## Create another mail</em>
- *   #set ($mail = $mailBuilder.setTextMessage('How are you Mikael?'
- *                            ).clearRecipients().addRecipient('mikael.wikblom@sitevision.se'
- *                            ).build())
- *   <em>## Send mail</em>
- *   #if ($mail.send())
- *      &lt;p&gt;Mail to Mikael successfully sent!&lt;/p&gt;
- *   #else
- *      &lt;p&gt;Mail to Mikael could &lt;strong&gt;not&lt;/strong&gt; be sent!&lt;/p&gt;
- *   #end
- * </code></pre>
- * <p>
- *    <strong>Tip!</strong> The {@link senselogic.sitevision.api.base.Builder Builder interface documentation} contains
- *    more information about Builders and how to work with them!
- * </p>
+ *    <em>## Create another mail</em>
+ *    #set ($mail = $mailBuilder.setTextMessage('How are you Mikael?'
+ *                             ).clearRecipients().addRecipient('mikael.wikblom@sitevision.se'
+ *                             ).build())
+ *    <em>## Send mail</em>
+ *    #if ($mail.send())
+ *       &lt;p&gt;Mail to Mikael successfully sent!&lt;/p&gt;
+ *    #else
+ *       &lt;p&gt;Mail to Mikael could &lt;strong&gt;not&lt;/strong&gt; be sent!&lt;/p&gt;
+ *    #end
+ *  </code></pre>
+ *  <p>
+ *     <strong>Tip!</strong> The {@link senselogic.sitevision.api.base.Builder Builder interface documentation} contains
+ *     more information about Builders and how to work with them!
+ *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
@@ -119,14 +120,14 @@ export interface MailBuilder extends Builder {
    * @param aFromAddress the from address. A whitespace-only address will be ignored, default (null) will be set instead.
    * @return this builder
    */
-  setFrom(aFromAddress: string): MailBuilder;
+  setFrom(aFromAddress: String | string): MailBuilder;
 
   /**
    * Adds a reply-to address.
    * @param aReplyToAddress a reply-to address. A null or whitespace-only address will be ignored.
    * @return this builder
    */
-  addReplyTo(aReplyToAddress: string): MailBuilder;
+  addReplyTo(aReplyToAddress: String | string): MailBuilder;
 
   /**
    * Removes all previously added reply-to addresses.
@@ -139,14 +140,14 @@ export interface MailBuilder extends Builder {
    * @param aSubject a subject
    * @return this builder
    */
-  setSubject(aSubject: string): MailBuilder;
+  setSubject(aSubject: String | string): MailBuilder;
 
   /**
    * Sets the text message.
    * @param aTextMessage a text message
    * @return this builder
    */
-  setTextMessage(aTextMessage: string): MailBuilder;
+  setTextMessage(aTextMessage: String | string): MailBuilder;
 
   /**
    * Sets the html message.
@@ -154,14 +155,14 @@ export interface MailBuilder extends Builder {
    * @return this builder
    * @since Sitevision 4.3
    */
-  setHtmlMessage(aHtmlMessage: string): MailBuilder;
+  setHtmlMessage(aHtmlMessage: String | string): MailBuilder;
 
   /**
    * Adds a recipient address (TO).
    * @param aRecipientAddress a recipient address. A null or whitespace-only address will be ignored.
    * @return this builder
    */
-  addRecipient(aRecipientAddress: string): MailBuilder;
+  addRecipient(aRecipientAddress: String | string): MailBuilder;
 
   /**
    * Removes all previously added recipient addresses (TO).
@@ -185,7 +186,7 @@ export interface MailBuilder extends Builder {
    * @return this builder
    * @since Sitevision 3.6.3
    */
-  addCopyRecipient(aCopyRecipientAddress: string): MailBuilder;
+  addCopyRecipient(aCopyRecipientAddress: String | string): MailBuilder;
 
   /**
    * Removes all previously added carbon copy recipient addresses (CC).
@@ -200,7 +201,9 @@ export interface MailBuilder extends Builder {
    * @return this builder
    * @since Sitevision 3.6.3
    */
-  addBlindCopyRecipient(aBlindCopyRecipientAddress: string): MailBuilder;
+  addBlindCopyRecipient(
+    aBlindCopyRecipientAddress: String | string
+  ): MailBuilder;
 
   /**
    * Removes all previously added blind carbon copy recipient addresses (BCC).
@@ -212,7 +215,7 @@ export interface MailBuilder extends Builder {
   /**
    * Creates a Mail instance using current state of this builder.
    * @return a mail that can be sent
-   * @throws IllegalStateException will be thrown if subject is null, if there are no recipients or if a recipient address is invalid, if the from address, a copy address, blind copy address or reply-to address is invalid.
+   * @throws IllegalStateException will be thrown if subject is null, if there are no recipients or&#xA; if a recipient address is invalid, if the from address, a copy address, blind copy address or reply-to address is invalid.
    */
   build(): Mail;
 }

package/server/MailUtil/index.d.ts

@@ -1,17 +1,18 @@
 import type { MailBuilder } from "../MailBuilder";
+import type { String } from "../../types/java/lang/String";
 
 /**
  * Mail utility interface.
  *
- * <p>
- * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getMailUtil()}.
- * 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#getMailUtil()}.
+ *  See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
  *
- * <p>
- *    <em>Note!</em> To send one or more mails, you must use a {@link MailBuilder}.
- *    Use the {@link #getMailBuilder()} method to get a builder instance.
- * </p>
+ *  <p>
+ *     <em>Note!</em> To send one or more mails, you must use a {@link MailBuilder}.
+ *     Use the {@link #getMailBuilder()} method to get a builder instance.
+ *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
@@ -25,16 +26,16 @@ export interface MailUtil {
   /**
    * Checks if a mail address has a valid format.
    * @param aMailAddress the address to check
-   * @return <code>true</code> if <code>aMailAddress</code> has a valid format and can be used to create a <code>javax.mail.internet.InternetAddress</code>, <code>false</code> otherwise.
+   * @return <code>true</code> if <code>aMailAddress</code> has a valid format and can be used to create a&#xA; <code>javax.mail.internet.InternetAddress</code>, <code>false</code> otherwise.
    */
-  isValidAddress(aMailAddress: string): boolean;
+  isValidAddress(aMailAddress: String | string): boolean;
 
   /**
    * Gets the mail address of the site responsible.
    *
-   * <p>
-   *    <strong>Note!</strong> The returned address is <em>not</em> validated, i.e. it might be an invalid mail address.
-   * </p>
+   *  <p>
+   *     <strong>Note!</strong> The returned address is <em>not</em> validated, i.e. it might be an invalid mail address.
+   *  </p>
    * @return the mail address of the site responsible, or <code>null</code> if there are no address or if it's whitespace only
    */
   getSiteResponsibleAddress(): string;
@@ -42,9 +43,9 @@ export interface MailUtil {
   /**
    * Gets the from mail address of current site.
    *
-   * <p>
-   *    <strong>Note!</strong> The returned address is <em>not</em> validated, i.e. it might be an invalid mail address.
-   * </p>
+   *  <p>
+   *     <strong>Note!</strong> The returned address is <em>not</em> validated, i.e. it might be an invalid mail address.
+   *  </p>
    * @return the from mail address of current site, or <code>null</code> if there are no address or if it's whitespace only
    */
   getSiteFromAddress(): string;
@@ -52,9 +53,9 @@ export interface MailUtil {
   /**
    * Gets the mail address of the server responsible.
    *
-   * <p>
-   *    <strong>Note!</strong> The returned address is <em>not</em> validated, i.e. it might be an invalid mail address.
-   * </p>
+   *  <p>
+   *     <strong>Note!</strong> The returned address is <em>not</em> validated, i.e. it might be an invalid mail address.
+   *  </p>
    * @return the mail address of the server responsible, or <code>null</code> if there are no address or if it's whitespace only
    */
   getServerResponsibleAddress(): string;
@@ -62,9 +63,9 @@ export interface MailUtil {
   /**
    * Gets the server from mail address.
    *
-   * <p>
-   *    <strong>Note!</strong> The returned address is <em>not</em> validated, i.e. it might be an invalid mail address.
-   * </p>
+   *  <p>
+   *     <strong>Note!</strong> The returned address is <em>not</em> validated, i.e. it might be an invalid mail address.
+   *  </p>
    * @return the server from mail address, or <code>null</code> if there are no address or if it's whitespace only
    */
   getServerFromAddress(): string;