jrkrauss/ftextlib repository overview

⁠FTextLib :capital_abcd: :arrow_right: :symbols:

⁠1. What is it?

FTextLib is a simple JAVA library that implements some of the most common text filters available out there.

⁠2. How to use?

Download the jar file⁠ into your project's folder and import it into your project's path. Once you've done that, that's how you use in your code:

import org.krauss.ftextlib.def.EFilter;
import org.krauss.ftextlib.factory.FilterFactory;

Then using the FilterFactory class, you can create a filter and apply it straight away like this:

//FilterFactory.getFilter(EFilter filter)
Filter filter = FilterFactory.getFilter(EFilter.REVERSE);

//filter.applyFilter(String text);
filter.applyFilter("Hell of world!");

//Output:

"lleH fo !dlrow" 

The static method getFilter() takes one argument filter, which is an EFilter Enum and returns an object Filter that has the method applyFilter().

The method applyFilter() takes one argument text and returns a String which is the text already processed.

⁠Filters available:

⁠3. Docker Usage :whale:

If you just want to see how this library works, download our image available on Docker Hub following the instructions below:

⁠Download the image :cd:

Once you have Docker CE⁠ installed an running, from your Linux terminal or Windows cmd, type:

$ docker pull jrkrauss/ftextlib:latest

⁠Create the container and run/ship it :ship:

$ docker run -it jrkrauss/ftextlib:latest