Sporniket-core
[WARNING] Please read carefully this note before using this project. It contains important facts.
Content
- What is Sporniket-core, and when to use it ?
- What should you know before using Sporniket-core ?
- How to use Sporniket-core ?
- Known issues
- Miscellanous
1. What is Sporniket-core, and when to use it ?
Sporniket-core is a collection of libraries containing code that I deemed essential for my projects at one point.
What's new in v19.04.00
- #24 : Make StringTransformation a Function<String,String>
- #26 : Cleanstep - remove package com.sporniket.libre.lang.regexp from core-lang
- #27 : Cleanstep - remove package com.sporniket.libre.lang.string from core-lang
- update test dependency on jackson-databind following security alert
- update plugin dependency on checkstyle following security alert
What's new in v19.02.00
- Rewritten most of the string utilities : transformative utilities have been rewritten as implementation of
StringTransformation
, test utilities have been rewritten asPredicate<String>
; the existing ones in sporniket-core-lang have been marked has deprecated and will be deleted on the next iteration. The new utilities, theQuickDiff
utility and theFormattedInputSimpleParserFactory
have been moved into a new library : sporniket-core-strings. - String comparators that handle null values : natural or reverse order, ignoring case or not.
What's new in v16.09.00
- A utility that allow to specify the listeners to use when reading a properties file. See
FileTools.readPropertiesToListeners(...)
in sporniket-core-io.
What's new in v16.08.02
- A utility that load properties files like ResourceBundle. See
FileTools.loadResourceBundle(...)
in sporniket-core-io. - An url provider that encapsulate regular URL instanciation from full urls, that recognize the "classpath" protocol and use the classloader to get a real url. See
ClasspathProtocolAwareUrlProvider
class in sporniket-core-lang.
What's new in v16.08.01
- fixed : left-trimed multi-line processing and untrimed multi-line processing is swaped.
- A utility to load a properties file supporting heredoc convention. See
FileTools.loadProperties(...)
in sporniket-core-io.
What's new in v16.08.00
- a regexp utility that create a pattern that match a formatted input using a limited description format. See
FormattedInputSimpleParserFactory
class in sporniket-core-lang.
What's new in v15.09.00
- An utility to get a SSLContext to use an https url. See
SslContextFactory
class in sporniket-core-lang. - An utility to parse a properties file supporting heredoc convention for multiple-lines values. See
LineByLinePropertyParser
class in sporniket-core-io.
What's new in v15.03.01
- general availability through central sonatype maven repository.
Licence
Sporniket-core 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.
Sporniket-core 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 Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with Sporniket-core. If not, see http://www.gnu.org/licenses/ .
2. What should you know before using Sporniket-core ?
Sporniket-core relies only on standard jdk 8 and consists of :
- sporniket-core-string : String manipulation code.
- sporniket-core-lang : general purpose code.
- sporniket-core-io : code related with IO, mostly files.
- sporniket-core-ml : code related with xml, sgml, html,... processing.
- sporniket-core-ui : code related with swing.
Do not use Sporniket-core if this project is not suitable for your project
3. How to use Sporniket-core ?
From source
To get the latest available code, one must clone the git repository, build and install to the maven local repository.
git clone https://github.com/sporniket/core.git
cd core
mvn install
Maven
Add any of the following dependencies that are appropriate to your project.
<dependency>
<groupId>com.sporniket.core</groupId>
<artifactId>sporniket-core-lang</artifactId>
<version>19.02.00</version>
</dependency>
<dependency>
<groupId>com.sporniket.core</groupId>
<artifactId>sporniket-core-io</artifactId>
<version>19.02.00</version>
</dependency>
<dependency>
<groupId>com.sporniket.core</groupId>
<artifactId>sporniket-core-ml</artifactId>
<version>19.02.00</version>
</dependency>
<dependency>
<groupId>com.sporniket.core</groupId>
<artifactId>sporniket-core-ui</artifactId>
<version>19.02.00</version>
</dependency>
Directions and sample code
Read the javadoc and look at the test code.
4. Known issues
See the project issues page.
5. Miscellanous
Report issues
Use the project issues page.