Elephant

This is an annotation processor to apply Memoization technique to Utils-like classes.

What is it good for?

Memoization is a simple technique that speeds up functions by caching the results. To take advantage of this technique, the result MUST ONLY depend on the input parameters and the time taken to process the result should be longer than just retrieving it.

Usage

Annotate your Utils class with the @Elephant annotation and then every public and static function you want to memoize with the @Memoize annotation

@Elephant
public class SimpleUtils{

    @Memoize
    public static Integer search(String fullText, String textToSearch){
        Pattern pattern = Pattern.compile(textToSearch);
        Matcher matcher = pattern.matcher(fullText.toLowerCase());
        int counter = 0;

        while (matcher.find())
            counter++;

        return counter;
    }
    
    public static Integer someProcess(String text){
        return text.length();
    }
}

After building your project, the annotation processor will generate a class with the name Elephant+[Name of the class] (i.e. ElephantSimpleUtils). You can freely use it anywhere in your project now and it will automatically memorize the results for every call. For the methods not marked with the @Memoize annotation, it will keep calling the same method on the original Utils class. I recommend to build your project every time you make a modification to your original class.

Limitations (for now)

Supports Java 8 and up
Doesn't support nested classes
Support only for wrapper classes (Integer, Float, Double, etc)

Android

In case you want to use it in your Android project, you have to enable the jackOptions and make sure you're working with Java 8 (Building time could take a while to generate the Elephant class)

android {
    ...
    defaultConfig {
      ...
      jackOptions{
          enabled true
      }
    }
    buildTypes {
      ...
    }
    compileOptions{
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

Download

dependencies{
  compile 'co.herovitamin.elephant:elephant:0.5'
  annotationProcessor 'co.herovitamin.elephant:elephant-processor:0.5.1'
}

This is project is currently in development and you are welcome to contribute to make it better.

License

Copyright 2017 KERRY PEREZ HUANCA

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

jhoon / Elephant