Update from upstream repo aspose-words/Aspose.Words-for-Java

Examples/ApiExamples/Java/pom.xml

@@ -0,0 +1,109 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+
+    <groupId>com.aspose.apiexamples</groupId>
+    <artifactId>ApiExamples-Tests</artifactId>
+    <version>1.0-SNAPSHOT</version>
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.8.0</version>
+                <configuration>
+                    <source>1.8</source>
+                    <target>1.8</target>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>3.0.0-M4</version>
+                <configuration>
+                    <testSourceDirectory>${basedir}/src/main/java/</testSourceDirectory>
+                    <testClassesDirectory>${project.build.directory}/classes/</testClassesDirectory>
+                    <includes>
+                        <include>**/Ex*.java</include>
+                    </includes>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+    <repositories>
+        <repository>
+            <id>AsposeJavaAPI</id>
+            <name>Aspose Java API</name>
+            <url>https://releases.aspose.com/java/repo/</url>
+        </repository>
+        <repository>
+            <id>com.springsource.repository.bundles.external</id>
+            <name>SpringSource Enterprise Bundle Repository - External Bundle Releases</name>
+            <url>https://repository.springsource.com/maven/bundles/external</url>
+        </repository>
+    </repositories>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.aspose</groupId>
+            <artifactId>aspose-words</artifactId>
+            <version>25.9</version>
+            <classifier>jdk17</classifier>
+        </dependency>
+        <dependency>
+            <groupId>com.aspose</groupId>
+            <artifactId>aspose-words</artifactId>
+            <version>25.9</version>
+            <classifier>shaping-harfbuzz-plugin</classifier>
+        </dependency>
+        <dependency>
+            <groupId>com.aspose</groupId>
+            <artifactId>aspose-barcode</artifactId>
+            <version>25.8</version>
+            <classifier>jdk18</classifier>
+        </dependency>
+        <dependency>
+            <groupId>com.aspose</groupId>
+            <artifactId>aspose-pdf</artifactId>
+            <version>25.8</version>
+            <classifier>jdk17</classifier>
+        </dependency>
+        <dependency>
+            <groupId>org.testng</groupId>
+            <artifactId>testng</artifactId>
+            <version>7.5.1</version>
+        </dependency>
+        <dependency>
+            <groupId>javax.media.jai</groupId>
+            <artifactId>com.springsource.javax.media.jai.core</artifactId>
+            <version>1.1.3</version>
+        </dependency>
+        <dependency>
+            <groupId>net.sf.ucanaccess</groupId>
+            <artifactId>ucanaccess</artifactId>
+            <version>3.0.6</version>
+        </dependency>
+        <dependency>
+            <groupId>commons-io</groupId>
+            <artifactId>commons-io</artifactId>
+            <version>2.16.1</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-collections4</artifactId>
+            <version>4.4</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.poi</groupId>
+            <artifactId>poi</artifactId>
+            <version>5.0.0</version>
+        </dependency>
+    </dependencies>
+</project>

Examples/ApiExamples/Java/src/main/java/Examples/ApiExampleBase.java

@@ -0,0 +1,197 @@
+package Examples;
+
+//////////////////////////////////////////////////////////////////////////
+// Copyright (c) 2001-2025 Aspose Pty Ltd. All Rights Reserved.
+//
+// This file is part of Aspose.Words. The source code in this file
+// is only intended as a supplement to the documentation, and is provided
+// "as is", without warranty of any kind, either expressed or implied.
+//////////////////////////////////////////////////////////////////////////
+
+import com.aspose.words.CurrentThreadSettings;
+import com.aspose.words.License;
+import org.testng.annotations.AfterClass;
+import org.testng.annotations.BeforeClass;
+
+import java.io.File;
+import java.net.URI;
+import java.util.Locale;
+
+/**
+ * Provides common infrastructure for all API examples that are implemented as unit tests.
+ */
+public class ApiExampleBase {
+
+    /**
+     * Test artifacts directory.
+     */
+    private final File artifactsDirPath = new File(getArtifactsDir());
+
+    /**
+     * Delete all dirs and files from directory.
+     *
+     * @param dir directory to be deleted
+     */
+    private static void deleteDir(final File dir) {
+        String[] entries = dir.list();
+        for (String s : entries) {
+            File currentFile = new File(dir.getPath(), s);
+            if (currentFile.isDirectory()) {
+                deleteDir(currentFile);
+            } else {
+                currentFile.delete();
+            }
+        }
+        dir.delete();
+    }
+
+    /**
+     * Delete and create new empty directory for test artifacts.
+     *
+     * @throws Exception exception for setUnlimitedLicense()
+     */
+    @BeforeClass(alwaysRun = true)
+    public void setUp() throws Exception {
+        CurrentThreadSettings.setLocale(Locale.US);
+        setUnlimitedLicense();
+
+        if (!artifactsDirPath.exists()) {
+            artifactsDirPath.mkdir();
+        } else {
+            deleteDir(artifactsDirPath);
+            artifactsDirPath.mkdir();
+        }
+    }
+
+    /**
+     * Delete all dirs and files from directory for test artifacts.
+     */
+    @AfterClass(alwaysRun = true)
+    public void tearDown() {
+        deleteDir(artifactsDirPath);
+    }
+
+    /**
+     * Set java licence for using library without any restrictions.
+     *
+     * @throws Exception exception for setting licence
+     */
+    private static void setUnlimitedLicense() throws Exception {
+        // This is where the test license is on my development machine.
+        String testLicenseFileName = getLicenseDir() + "Aspose.Total.Java.lic";
+        if (new File(testLicenseFileName).exists()) {
+            // This shows how to use an Aspose.Words license when you have purchased one.
+            // You don't have to specify full path as shown here. You can specify just the
+            // file name if you copy the license file into the same folder as your application
+            // binaries or you add the license to your project as an embedded resource.
+            License wordsLicense = new License();
+            wordsLicense.setLicense(testLicenseFileName);
+
+            com.aspose.pdf.License pdfLicense = new com.aspose.pdf.License();
+            pdfLicense.setLicense(testLicenseFileName);
+
+            com.aspose.barcode.License barcodeLicense = new com.aspose.barcode.License();
+            barcodeLicense.setLicense(testLicenseFileName);
+        }
+    }
+
+    /**
+     * Gets the path to the license used by the code examples.
+     *
+     * @return licence directory
+     */
+    static String getLicenseDir() {
+        return G_LICENSE_DIR;
+    }
+
+    /**
+     * Gets the path to the documents used by the code examples. Ends with a back slash.
+     *
+     * @return directory for test artifacts
+     */
+    static String getArtifactsDir() {
+        return G_ARTIFACTS_DIR;
+    }
+
+    /**
+     * Gets the path to the documents used by the code examples. Ends with a back slash.
+     *
+     * @return directory with expected documents
+     */
+    static String getGoldsDir() {
+        return G_GOLDS_DIR;
+    }
+
+    /**
+     * Gets the path to the documents used by the code examples. Ends with a back slash.
+     *
+     * @return directory with documents for testing
+     */
+    static String getMyDir() {
+        return G_MY_DIR;
+    }
+
+    /**
+     * Gets the path to the images used by the code examples. Ends with a back slash.
+     *
+     * @return directory with images for testing
+     */
+    protected static String getImageDir() {
+        return G_IMAGE_DIR;
+    }
+
+    /**
+     * Gets the path to the codebase directory.
+     *
+     * @return directory with data files for testing
+     */
+    static String getDatabaseDir() {
+        return G_DATABASE_DIR;
+    }
+
+    /**
+     * Gets the path of the free fonts. Ends with a back slash.
+     *
+     * @return directory with public fonts for testing
+     */
+    static String getFontsDir() {
+        return G_FONTS_DIR;
+    }
+
+    /**
+     * Gets the path to the codebase directory.
+     *
+     * @return url with aspose logo image
+     */
+    static URI getAsposelogoUri() {
+        return G_ASPOSELOGO_URI;
+    }
+
+    private static final String G_ASSEMBLY_DIR;
+    private static final String G_CODE_BASE_DIR;
+    private static final String G_LICENSE_DIR;
+    private static final String G_ARTIFACTS_DIR;
+    private static final String G_GOLDS_DIR;
+    private static final String G_MY_DIR;
+    private static final String G_IMAGE_DIR;
+    private static final String G_DATABASE_DIR;
+    private static final String G_FONTS_DIR;
+    private static final URI G_ASPOSELOGO_URI;
+
+    static {
+        try {
+            G_ASSEMBLY_DIR = System.getProperty("user.dir");
+            G_CODE_BASE_DIR = new File(G_ASSEMBLY_DIR).getParentFile().getParentFile() + File.separator;
+            G_LICENSE_DIR = G_CODE_BASE_DIR + "Data" + File.separator + "License" + File.separator;
+            G_ARTIFACTS_DIR = G_CODE_BASE_DIR + "Data" + File.separator + "Artifacts" + File.separator;
+            G_GOLDS_DIR = G_CODE_BASE_DIR + "Data" + File.separator + "Golds" + File.separator;
+            G_MY_DIR = G_CODE_BASE_DIR + "Data" + File.separator;
+            G_IMAGE_DIR = G_CODE_BASE_DIR + "Data" + File.separator + "Images" + File.separator;
+            G_DATABASE_DIR = G_CODE_BASE_DIR + "Data" + File.separator + "Database" + File.separator;
+            G_FONTS_DIR = G_CODE_BASE_DIR + "Data" + File.separator + "MyFonts" + File.separator;
+            G_ASPOSELOGO_URI = new URI("https://www.google.com/images/branding/googlelogo/1x/googlelogo_color_272x92dp.png");
+        } catch (Exception e) {
+            throw new RuntimeException(e);
+        }
+    }
+}