afc

Arakhnê Foundation Classes

APACHE-2.0 License

Stars
14
View Code on GitHub Visit Website
Ecosystems: Java

= Arakhnê Foundation Classes :toc: right :toc-placement!: :hide-uri-scheme:

The Arakhnê Foundation Classes (AFC) is a collection of Java libraries that may be used to build applications. The Arakhnê Foundation Classes provide tools that are not directly available in the standard Java API.

image:https://img.shields.io/badge/requires-Java%2011-red.svg?style=flat-square[link=https://www.java.com] image:https://img.shields.io/maven-central/v/org.arakhne.afc/afc.svg?label=Maven%20Central[link=http://search.maven.org/#search%7Cga%7C1%7Corg.arakhne.afc] image:https://travis-ci.com/gallandarakhneorg/afc.svg?branch=master[link=https://travis-ci.com/gallandarakhneorg/afc] image:https://ci.appveyor.com/api/projects/status/github/gallandarakhneorg/afc?branch=master&svg=true[link=https://ci.appveyor.com/project/gallandarakhneorg/afc]

image:https://img.shields.io/badge/compliant-Maven-yellowgreen.svg?style=flat-square[link=http://maven.apache.org] image:https://img.shields.io/badge/compliant-Java-yellowgreen.svg?style=flat-square[link=https://www.java.com] image:https://img.shields.io/badge/compliant-SARL-yellowgreen.svg?style=flat-square[link=http://sarl.io] image:https://img.shields.io/badge/compliant-Scala-yellowgreen.svg?style=flat-square[link=http://scala-lang.org] image:https://img.shields.io/badge/compliant-Xtext-yellowgreen.svg?style=flat-square[link=https://eclipse.org/Xtext] image:https://img.shields.io/badge/compliant-Xtend-yellowgreen.svg?style=flat-square[link=https://eclipse.org/Xtext] image:https://img.shields.io/badge/compliant-OSGI-yellowgreen.svg?style=flat-square[link=https://www.osgi.org]

image:https://img.shields.io/github/license/gallandarakhneorg/afc.svg?style=flat-square[link=https://opensource.org/licenses/Apache-2.0] image:https://cla-assistant.io/readme/badge/gallandarakhneorg/afc[link=https://cla-assistant.io/gallandarakhneorg/afc]

toc::[]

== 1. Content of the AFC

=== 1.1. Maintained Modules

AFC library contains the several maintained modules: geometry utilities, geographical information framework, etc. See link:http://arakhne.org/afc/[Arakhne.org] for details.

=== 1.2. Deprecated and Dead Modules

AFC library contains the deprecated modules (deprecated modules are subject to removal in future version). See link:http://arakhne.org/afc/[Arakhne.org] for details.

=== 1.3 Compatibility with other Languages than Java

AFC is a Java library that provides extensions for being used with other programming languages.

For example, link:http://arakhne.org/afc/apidocs/index.html?org/arakhne/afc/math/geometry/d2/Vector2D.html[Vector2D] provides overloading function for operator +. In this way, this operator may be used by typing v1 + 1 instead of v1.add(1).

==== 1.3.1 SARL agent-oriented programming language

AFC library is compatible with the link:http://www.sarl.io[SARL] agent-oriented programming language, which is a Xtext-based language (see below). Indeed, the AFC classes use the specific annotations: @Pure for making link:https://en.wikipedia.org/wiki/Pure_function[pure functions], and @Inline for link:https://en.wikipedia.org/wiki/Inline_function[inline functions]. AFC also provides the overridings of the operators (operator_plus, operator_minus, etc.) for vectors, matrices, etc.

==== 1.3.2 Scala object-oriented programming language

AFC library is compatible with the link:http://scala-lang.org[Scala] object-oriented programming language. Indeed, the AFC classes provide the overridings of the operators ($plus, $minus, etc.) for vectors, matrices, etc.

==== 1.3.3 Xtend object-oriented programming language

AFC library is compatible with the link:https://www.eclipse.org/xtend/[Xtend] object-oriented programming language, which is a Xtext-based language (see below). Indeed, the AFC classes use the specific annotations: @Pure for making link:https://en.wikipedia.org/wiki/Pure_function[pure functions], and @Inline for inline functions). AFC also provides the overridings of the operators (operator_plus, operator_minus, etc.) for vectors, matrices, etc.

==== 1.3.4 Other Xtext-base languages

AFC library is compatible with all the languages that are defined upon the link:https://www.eclipse.org/Xtext/[Xtext] framework for development of programming languages and domain-specific languages. Indeed, the AFC classes use the specific annotations: @Pure for making link:https://en.wikipedia.org/wiki/Pure_function[pure functions], and @Inline for link:https://en.wikipedia.org/wiki/Inline_function[inline functions]. AFC also provides the overridings of the operators (operator_plus, operator_minus, etc.) for vectors, matrices, etc.

== 2. Requirements

For AFC version 17.0 or higher:

  • Java Development Toolkit (JDK) 11 or higher.

For AFC prior to version 17.0:

  • Java Development Toolkit (JDK) 8.

== 3. Using AFC

=== 3.1. Recommendations

For making your experience with AFC the best, we recommend you:

  • to enable the assertions at development time (with the -ea command line option).

=== 3.2. Use the stable version with Maven

The lastest stable version of AFC is available on link:http://search.maven.org/[Maven Central]. Consequently, you could directly include the AFC module that you want to use into the Maven dependencies of your project. For example, if you want to use the "vmutils" module:

	...
	<dependency>
	  <groupId>org.arakhne.core</groupId>
	  <artifactId>vmutils</artifactId>
	  <version>13.0</version>
	</dependency>
	...

Please, replace Version 12.0 in the previous snipset by the number of the version you want to use (12.0 is the first version that is available on Maven Central).

=== 3.3. Use of the development version with Maven

New features, enhancements and bug fixes are available in the SNAPSHOT (development) version of AFC. For using this version, you must add the Maven Repository Server of AFC in your pom file:

	...
	<dependencies>
	  <dependency>
	    <groupId>org.arakhne.core</groupId>
	    <artifactId>vmutils</artifactId>
	    <version>14.0-SNAPSHOT</version>
	  </dependency>
	<dependencies>
	...
	<repositories>
	  <repository>
	    <id>org.arakhne-maven</id>
	    <name>Arakhnê.org Snapshots</name>
	    <url>http://download.tuxfamily.org/arakhne/maven/</url>
	  </repository>
	</repositories>
	<pluginRepositories>
    	  <pluginRepository>
	    <id>org.arakhne-maven</id>
	    <name>Arakhnê.org Snapshots</name>
	    <url>http://download.tuxfamily.org/arakhne/maven/</url>
	    <snapshots>
	      <enabled>true</enabled>
	    </snapshots>
	  </pluginRepository>
	</pluginRepositories>
	...

== 4. P2 Repository

A P2 repository is set up and accesible at the address: http://download.tuxfamily.org/arakhne/p2.

The bundles that are available on this P2 repository are:

[cols="3,1,1", options="header"] |=== | Name | Id | Version

| Mockito and related dependencies | org.mockito-core | 20.0.64.beta |===

== 5. Issues

Issues related to the AFC are tracked on link:https://github.com/gallandarakhneorg/afc/issues[GitHub] You must use this issue tracker to report and follow your issues.

== 6. Contributions

Any contribution to the AFC library is welcome. See CONTRIBUTING file for details.

== 7. Authors

== 8. License of AFC

The Arakhnê Foundation Classes are distributed under the link:./LICENSE[Apache v2 license], and is copyrigthed to the original authors and the other authors, as expressed in the link:./NOTICE[NOTICE].

== 9. Success Stories

The following projects have sucessfully used a module of the AFC:

Package Rankings
Top 23.47% on Repo1.maven.org