Merge pull request #4 from xdev-software/develop

v1.0.0

Author: JohannesRabauer

CHANGELOG.md

@@ -0,0 +1,4 @@
+## 1.0.0
+
+* Published this library as open source
+* Ensured build compatibility with Java 8, 11 and 17

CONTRIBUTING.md

@@ -1,10 +1,12 @@
 ## Contributing
 
-We would absolutely love to get the community involved, and we welcome any form of contributions – comments and questions on different communication channels, issues and pull request in the repositories, and anything that you build and share using our components.
+We would absolutely love to get the community involved, and we welcome any form of contributions – comments and
+questions on different communication channels, issues and pull request in the repositories, and anything that you build
+and share using our components.
 
 ### Get in touch with the team
 
-Twitter: https://twitter.com/xdevsoftware 
+Twitter: https://twitter.com/xdevsoftware
 <br/>
 Mail: opensource@xdev-software.de
 
@@ -13,33 +15,44 @@ Mail: opensource@xdev-software.de
 - **Report bugs**: File issues on GitHub.
 - **Send pull requests**: If you want to contribute code, check out the development instructions below.
 
-We encourage you to read the [contribution instructions by GitHub](https://guides.github.com/activities/contributing-to-open-source/#contributing) also.
+We encourage you to read
+the [contribution instructions by GitHub](https://guides.github.com/activities/contributing-to-open-source/#contributing)
+also.
 
 ## Developing
 
 ### Software Requirements
+
 You should have the following things installed:
+
 * Git
-* Java 8, 11 or 17 - should be as unmodified as possible (Recommended: [Eclipse Adoptium](https://adoptium.net/temurin/releases/))
+* Java 8, 11 or 17 - should be as unmodified as possible (
+  Recommended: [Eclipse Adoptium](https://adoptium.net/temurin/releases/))
 * Maven
 
 ### Recommended setup
+
 * Install ``IntelliJ`` (Community Edition is sufficient)
-  * Install the following plugins:
-    * [Save Actions](https://plugins.jetbrains.com/plugin/7642-save-actions) - Provides save actions, like running the formatter or adding ``final`` to fields
-    * [SonarLint](https://plugins.jetbrains.com/plugin/7973-sonarlint) - CodeStyle/CodeAnalysis
-    * [Checkstyle-IDEA](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea) - CodeStyle/CodeAnalysis
-  * Import the project
-  * Ensure that everything is encoded in ``UTF-8``
-  * Ensure that the JDK/Java-Version is correct
+    * Install the following plugins:
+        * [Save Actions](https://plugins.jetbrains.com/plugin/7642-save-actions) - Provides save actions, like running
+          the formatter or adding ``final`` to fields
+        * [SonarLint](https://plugins.jetbrains.com/plugin/7973-sonarlint) - CodeStyle/CodeAnalysis
+        * [Checkstyle-IDEA](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea) - CodeStyle/CodeAnalysis
+    * Import the project
+    * Ensure that everything is encoded in ``UTF-8``
+    * Ensure that the JDK/Java-Version is correct
 
 ## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/xdev-swing-framework-template/release.yml?branch=master)](https://github.com/xdev-software/xdev-swing-framework-template/actions/workflows/release.yml)
 
 Before releasing:
-* Consider doing a [test-deployment](https://github.com/xdev-software/xdev-swing-framework-template/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
+
+* Consider doing
+  a [test-deployment](https://github.com/xdev-software/xdev-swing-framework-template/actions/workflows/test-deploy.yml?query=branch%3Adevelop)
+  before actually releasing.
 * Check the [changelog](CHANGELOG.md)
 
 If the ``develop`` is ready for release, create a pull request to the ``master``-Branch and merge the changes.
 
 When the release is finished do the following:
-* Merge the auto-generated PR (with the incremented version number) back into the ``develop``
+
+* Merge the auto-generated PR (with the incremented version number) back into the ``develop``

README.md

@@ -1,20 +1,35 @@
-[![Latest version](https://img.shields.io/maven-central/v/com.xdev-software/xdev-swing-framework-template)](https://mvnrepository.com/artifact/com.xdev-software/xdev-swing-framework-template)
-[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/xdev-swing-framework-template/checkBuild.yml?branch=develop)](https://github.com/xdev-software/xdev-swing-framework-template/actions/workflows/checkBuild.yml?query=branch%3Adevelop)
-[![javadoc](https://javadoc.io/badge2/com.xdev-software/xdev-swing-framework-template/javadoc.svg)](https://javadoc.io/doc/com.xdev-software/xdev-swing-framework-template) 
-# xdev-swing-framework-template
+[![Latest version](https://img.shields.io/maven-central/v/com.xdev-software/xapi-db-firebird)](https://mvnrepository.com/artifact/com.xdev-software/xapi-db-firebird)
+[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/xapi-db-firebird/checkBuild.yml?branch=develop)](https://github.com/xdev-software/xapi-db-firebird/actions/workflows/checkBuild.yml?query=branch%3Adevelop)
+[![javadoc](https://javadoc.io/badge2/com.xdev-software/xapi-db-firebird/javadoc.svg)](https://javadoc.io/doc/com.xdev-software/xapi-db-firebird)
 
-A XDEV Swing Framework Template
+# SqlEngine Database Adapter Firebird
+
+The XDEV Application Framework provides an abstraction over database dialects as part of its SqlEngine. This module is
+the Database Adapter for Firebird which includes the Firebird-specific implementation for database access.
 
 ## XDEV-IDE
-The [XDEV(-IDE)](https://xdev.software/en/products/swing-builder) is a visual Java development environment for fast and easy application development (RAD - Rapid Application Development). XDEV differs from other Java IDEs such as Eclipse or NetBeans, focusing on programming through a far-reaching RAD concept. The IDE's main components are a Swing GUI builder, the XDEV Application Framework and numerous drag-and-drop tools and wizards with which the functions of the framework can be integrated.
 
-The XDEV-IDE was license-free up to version 4 inclusive and is available for Windows, Linux and macOS. From version 5, the previously proprietary licensed additional modules are included in the IDE and the license of the entire product has been converted to a paid subscription model. The XDEV Application Framework, which represents the core of the RAD concept of XDEV and is part of every XDEV application, was released as open-source in 2008.
+The [XDEV(-IDE)](https://xdev.software/en/products/swing-builder) is a visual Java development environment for fast and
+easy application development (RAD - Rapid Application Development). XDEV differs from other Java IDEs such as Eclipse or
+NetBeans, focusing on programming through a far-reaching RAD concept. The IDE's main components are a Swing GUI builder,
+the XDEV Application Framework and numerous drag-and-drop tools and wizards with which the functions of the framework
+can be integrated.
+
+The XDEV-IDE was license-free up to version 4 inclusive and is available for Windows, Linux and macOS. From version 5,
+the previously proprietary licensed additional modules are included in the IDE and the license of the entire product has
+been converted to a paid subscription model. The XDEV Application Framework, which represents the core of the RAD
+concept of XDEV and is part of every XDEV application, was released as open-source in 2008.
 
 ## Support
-If you need support as soon as possible and you can't wait for any pull request, feel free to use [our support](https://xdev.software/en/services/support).
+
+If you need support as soon as possible and you can't wait for any pull request, feel free to
+use [our support](https://xdev.software/en/services/support).
 
 ## Contributing
+
 See the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.
 
 ## Dependencies and Licenses
-View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/xdev-swing-framework-template/dependencies/)
+
+View the [license of the current project](LICENSE) or
+the [summary including all dependencies](https://xdev-software.github.io/xapi-db-firebird/dependencies/)

SECURITY.md

@@ -2,4 +2,6 @@
 
 ## Reporting a Vulnerability
 
-Please report a security vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/xapi-db-firebird/security/advisories/new).
+Please report a security
+vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/xapi-db-firebird/security/advisories/new)
+.

pom.xml

@@ -1,22 +1,22 @@
 <?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"
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xmlns="http://maven.apache.org/POM/4.0.0"
          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>
 
     <groupId>com.xdev-software</groupId>
     <artifactId>xapi-db-firebird</artifactId>
-    <version>1.0.0</version>
+    <version>1.0.0-SNAPSHOT</version>
     <packaging>jar</packaging>
 
     <name>SqlEngine Database Adapter Firebird</name>
-	<description>XAPI SqlEngine Database Adapter for Firebird</description>
-	<url>https://github.com/xdev-software/xapi-db-firebird</url>
+    <description>XAPI SqlEngine Database Adapter for Firebird</description>
+    <url>https://github.com/xdev-software/xapi-db-firebird</url>
 
     <scm>
-		<url>https://github.com/xdev-software/xapi-db-firebird</url>
-		<connection>https://github.com/xdev-software/xapi-db-firebird.git</connection>
-	</scm>
+        <url>https://github.com/xdev-software/xapi-db-firebird</url>
+        <connection>https://github.com/xdev-software/xapi-db-firebird.git</connection>
+    </scm>
 
     <inceptionYear>2003</inceptionYear>
 
@@ -50,7 +50,7 @@
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
 
         <xdev.xapi.version>6.0.1</xdev.xapi.version>
-        <firebird.version>2.2.5</firebird.version>
+        <firebird.version>3.0.12</firebird.version>
     </properties>
 
     <repositories>

src/main/java/firebird.png

@@ -17,29 +17,8 @@
  */
 package xdev.db.firebird.jdbc;
 
-/*-
- * #%L
- * Firebird
- * %%
- * Copyright (C) 2003 - 2023 XDEV Software
- * %%
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Lesser Public License for more details.
- * 
- * You should have received a copy of the GNU General Lesser Public
- * License along with this program.  If not, see
- * <http://www.gnu.org/licenses/lgpl-3.0.html>.
- * #L%
- */
-
 import com.xdev.jadoth.sqlengine.dbms.DbmsConnectionInformation;
+
 import xdev.db.ConnectionInformation;
 
 
@@ -50,68 +29,62 @@ public class FirebirdConnectionInformation extends ConnectionInformation<Firebir
 	// ///////////////////
 
 	/**
-	 * @param user
-	 *            the user
-	 * @param password
-	 *            the password
-	 * @param database
-	 *            the database
-	 * @param urlExtension
-	 *            the extended url properties
-	 * @param dbmsAdaptor
-	 *            the dbms adaptor
+	 * @param user         the user
+	 * @param password     the password
+	 * @param database     the database
+	 * @param urlExtension the extended url properties
+	 * @param dbmsAdaptor  the dbms adaptor
 	 */
-	public FirebirdConnectionInformation(final String host, final int port, final String user,
-			final String password, final String database, final String urlExtension,
-			final FirebirdDbms dbmsAdaptor)
+	public FirebirdConnectionInformation(
+		final String host, final int port, final String user,
+		final String password, final String database, final String urlExtension,
+		final FirebirdDbms dbmsAdaptor)
 	{
-		super(host,port,user,password,database,urlExtension,dbmsAdaptor);
+		super(host, port, user, password, database, urlExtension, dbmsAdaptor);
 	}
 
-	
 	// /////////////////////////////////////////////////////////////////////////
 	// getters //
 	// ///////////////////
+	
 	/**
 	 * Gets the database.
-	 * 
+	 *
 	 * @return the database
 	 */
 	public String getDatabase()
 	{
 		return this.getCatalog();
 	}
 
-	
 	// /////////////////////////////////////////////////////////////////////////
 	// setters //
 	// ///////////////////
+	
 	/**
 	 * Sets the database.
-	 * 
-	 * @param database
-	 *            the database to set
+	 *
+	 * @param database the database to set
 	 */
 	public void setDatabase(final String database)
 	{
 		this.setCatalog(database);
 	}
 
-	
 	// /////////////////////////////////////////////////////////////////////////
 	// override methods //
 	// ///////////////////
+	
 	/**
 	 * @see DbmsConnectionInformation#createJdbcConnectionUrl()
 	 */
 	@Override
 	public String createJdbcConnectionUrl()
 	{
-		String url = "jdbc:firebirdsql:" + getHost() + "/" + getPort() + ":" + getCatalog();
-		return appendUrlExtension(url);
+		final String url = "jdbc:firebirdsql:" + this.getHost() + "/" + this.getPort() + ":" + this.getCatalog();
+		return this.appendUrlExtension(url);
 	}
 
-	
 	/**
 	 * @see com.xdev.jadoth.sqlengine.dbms.DbmsConnectionInformation#getJdbcDriverClassName()
 	 */
@@ -120,5 +93,4 @@ public String getJdbcDriverClassName()
 	{
 		return "org.firebirdsql.jdbc.FBDriver";
 	}
-	
 }

src/main/java/xdev/db/firebird/jdbc/FirebirdConnectionInformation.java

@@ -17,28 +17,6 @@
  */
 package xdev.db.firebird.jdbc;
 
-/*-
- * #%L
- * Firebird
- * %%
- * Copyright (C) 2003 - 2023 XDEV Software
- * %%
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Lesser Public License for more details.
- * 
- * You should have received a copy of the GNU General Lesser Public
- * License along with this program.  If not, see
- * <http://www.gnu.org/licenses/lgpl-3.0.html>.
- * #L%
- */
-
 import com.xdev.jadoth.sqlengine.dbms.standard.StandardDDLMapper;
 
 

src/main/java/xdev/db/firebird/jdbc/FirebirdDDLMapper.java

@@ -21,39 +21,17 @@
 import com.xdev.jadoth.sqlengine.dbms.standard.StandardDMLAssembler;
 
 
-/*-
- * #%L
- * Firebird
- * %%
- * Copyright (C) 2003 - 2023 XDEV Software
- * %%
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Lesser Public License for more details.
- * 
- * You should have received a copy of the GNU General Lesser Public
- * License along with this program.  If not, see
- * <http://www.gnu.org/licenses/lgpl-3.0.html>.
- * #L%
- */
 public class FirebirdDMLAssembler extends StandardDMLAssembler<FirebirdDbms>
 {
 	public FirebirdDMLAssembler(final FirebirdDbms dbms)
 	{
 		super(dbms);
 	}
 
-	
 	@Override
 	protected StringBuilder assembleSelectRowLimit(
 		SELECT query, StringBuilder sb, int flags,
-			String clauseSeperator, String newLine, int indentLevel)
+		String clauseSeperator, String newLine, int indentLevel)
 	{
 		Integer skip = query.getOffsetSkipCount();
 		Integer range = query.getFetchFirstRowCount();
@@ -63,7 +41,7 @@ protected StringBuilder assembleSelectRowLimit(
 			if(skip != null)
 			{
 				sb.append(newLine).append(clauseSeperator).append("ROWS ").append(skip)
-						.append(" TO ").append(skip + range - 1);
+					.append(" TO ").append(skip + range - 1);
 			}
 			else
 			{
@@ -73,7 +51,7 @@ protected StringBuilder assembleSelectRowLimit(
 		else if(skip != null)
 		{
 			sb.append(newLine).append(clauseSeperator).append("ROWS ").append(skip).append(" TO ")
-					.append(Integer.MAX_VALUE);
+				.append(Integer.MAX_VALUE);
 		}
 
 		return sb;