<commit_before># Arakhnê Foundation Classes

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.

[![travis build](https://img.shields.io/travis/gallandarakhneorg/afc.svg?style=flat-square)](https://travis-ci.org/gallandarakhneorg/afc)
[![Apache 2.0 License](https://img.shields.io/github/license/gallandarakhneorg/afc.svg?style=flat-square)](https://opensource.org/licenses/Apache-2.0)

# 1. Content of the AFC

## 1.1. Alive Modules

AFC library contains the following alive modules:


Name | Group Id | Artifact Id | Explanation
-----|----------|-------------|------------
VM Utilities | org.arakhne.afc.core | vmutils | Utilities related to the virtual machine, file systems, etc.
Weak Reference Utilities | org.arakhne.afc.core | references | Set of classes for creating advanced weak references.
Text Utilities | org.arakhne.afc.core | text | Utilities for string of characters
Input-Output Utilities | org.arakhne.afc.core | inputoutput | General utilities related to IO
General Utilities | org.arakhne.afc.core | util | General utility classes that do not fit in the other AFC modules
Math Tools | org.arakhne.afc.core | math | Mathematic and Geometry tools and primitives
JavaFX Math Tools | org.arakhne.afc.advanced | mathfx | JavaFX implementation of the mathematic and geometry tools
Generic Attribute API | org.arakhne.afc.advanced | attributes | Library for creating generic attributes, aka. Variant attributes.


## 1.2. Deprecated and Dead Modules

AFC library contains the following deprecated modules (deprecated modules are subject to removal in next version):


Name | Group Id | Artifact Id | Explanation
-----|----------|-------------|------------
Base UI Tools | org.arakhne.afc.ui | base | Base tools for user interfaces.
AWT Tools | org.arakhne.afc.ui | awt | Extra AWT widgets.
Swing Widgets | org.arakhne.afc.ui | swing |  Extra Swing widgets.
Android Tools | org.arakhne.afc.ui | android | Extra Android widgets and activities.
Vector Window Toolkit | org.arakhne.afc.ui | vector | Vectorial primitives for building vectorial graphical editors.
AWT implementation of vector | org.arakhne.afc.ui | awt-vector | AWT implementation of the vectorial primitives.
Android implementation of vector | org.arakhne.afc.ui | android-vector | Android implementation of the vectorial primitives.
Atomic deployment of files | org.arakhne.afc.maven | atomicdeploy | Maven plugin for deploying aa single file.


# 2. Requirements

* Java Development Toolkit (JDK) 1.8 or higher.

# 3. Using AFC in a Maven project

## 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<commit_msg>[README] Add URL to the Javadoc.<commit_after># Arakhnê Foundation Classes

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.

[![travis build](https://img.shields.io/travis/gallandarakhneorg/afc.svg?style=flat-square)](https://travis-ci.org/gallandarakhneorg/afc)
[![Apache 2.0 License](https://img.shields.io/github/license/gallandarakhneorg/afc.svg?style=flat-square)](https://opensource.org/licenses/Apache-2.0)

# 1. Content of the AFC

## 1.1. Alive Modules

AFC library contains the following alive modules:


Name | Group Id | Artifact Id | Explanation
-----|----------|-------------|------------
[VM Utilities](http://arakhne.org/afc/apidocs/index.html?org/arakhne/afc/vmutil/package-summary.html) | org.arakhne.afc.core | vmutils | Utilities related to the virtual machine, file systems, etc.
[Weak Reference Utilities](http://arakhne.org/afc/apidocs/index.html?org/arakhne/afc/references/package-summary.html) | org.arakhne.afc.core | references | Set of classes for creating advanced weak references.
[Text Utilities](http://arakhne.org/afc/apidocs/index.html?org/arakhne/afc/text/package-summary.html) | org.arakhne.afc.core | text | Utilities for string of characters
[Input-Output Utilities](http://arakhne.org/afc/apidocs/index.html?org/arakhne/afc/io/filefilter/package-summary.html) | org.arakhne.afc.core | inputoutput | General utilities related to IO
[General Utilities](http://arakhne.org/afc/apidocs/index.html?org/arakhne/afc/util/package-summary.html) | org.arakhne.afc.core | util | General utility classes that do not fit in the other AFC modules
[Math Tools](http://arakhne.org/afc/apidocs/index.html?org/arakhne/afc/math/package-summary.html) | org.arakhne.afc.core | math | Mathematic and Geometry tools and primitives
[JavaFX Math Tools](http://arakhne.org/afc/apidocs/index.html?org/arakhne/afc/math/geometry/d2/dfx/package-summary.html) | org.arakhne.afc.advanced | mathfx | JavaFX implementation of the mathematic and geometry tools
[Generic Attribute API](http://arakhne.org/afc/apidocs/index.html?org/arakhne/afc/attrs/collection/package-summary.html) | org.arakhne.afc.advanced | attributes | Library for creating generic attributes, aka. Variant attributes.


## 1.2. Deprecated and Dead Modules

AFC library contains the following deprecated modules (deprecated modules are subject to removal in next version).
The table presents the modules, the version from which they are deprecated, and the version at which they will be totaly removed from.


Name | Group Id | Artifact Id | Explanation | Deprecation Start | Total Removal
-----|----------|-------------|-------------|-------------------|--------------
Base UI Tools | org.arakhne.afc.ui | base | Base tools for user interfaces. | 13.0 | 15.0
AWT Tools | org.arakhne.afc.ui | awt | Extra AWT widgets. | 13.0 | 15.0
Swing Widgets | org.arakhne.afc.ui | swing |  Extra Swing widgets. | 13.0 | 15.0
Android Tools | org.arakhne.afc.ui | android | Extra Android widgets and activities. | 13.0 | 15.0
Vector Window Toolkit | org.arakhne.afc.ui | vector | Vectorial primitives for building vectorial graphical editors. | 13.0 | 15.0
AWT implementation of vector | org.arakhne.afc.ui | awt-vector | AWT implementation of the vectorial primitives. | 13.0 | 15.0
Android implementation of vector | org.arakhne.afc.ui | android-vector | Android implementation of the vectorial  primitives.| 13.0 | 15.0
Atomic deployment of files | org.arakhne.afc.maven | atomicdeploy | Maven plugin for deploying aa single file. | 13.0 | 15.0


# 2. Requirements

* Java Development Toolkit (JDK) 1.8 or higher.

# 3. Using AFC in a Maven project

## 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
{'fraction_non_alphanumeric': 0.12567038701261052, 'fraction_numerical': 0.012030729091172634, 'mean_word_length': 3.8763250883392226, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6212325', 'n_tokens_mistral': 2232, 'n_tokens_neox': 2075, 'n_words': 679}