usage.md

Usage

1. Use Jitpack to add the project as a dependency:

   Gradle:

   repositories {
       maven { url 'https://jitpack.io' }
   }
   dependencies {
       implementation 'com.github.Aivean:record-array:1.0.1-SNAPSHOT'
       annotationProcessor 'com.github.Aivean:record-array:1.0.1-SNAPSHOT'
   }

2. Ensure that annotation processing is enabled for the project.

   Note: currently for simplicity the annotation processor and runtime are bundled in the same module.

3. Create POJO interface, with following conventions:

   • getters are named getXxx (or isXxx for boolean properties), and takes no arguments.
   • setters are named setXxx, return void and accept the same type as the getter as a single argument
   • optionally, add the method copy(), that takes no arguments and returns the interface itself
   • any default methods are allowed (they are ignored by generator)

4. Annotate the interface with @com.aivean.recarr.Record annotation.

For example:

@Record
public interface Person {
    String getName();
    void setName(String name);
    int getAge();
    void setAge(int age);
    Person copy();
    default String prettyPrint() {
        return "Person{name=" + getName() + ", age=" + getAge() + "}";
    }
}

Create an instance of the RecordArray<Person>:

RecordArray<Person> people = RecordArray.create(Person.class, 10);
Person person = people.get(0);
people.set(1, person);

Record Array supports up to three dimensions:

RecordArray<Person> people = RecordArray.create(Person.class, 10, 20, 30);
Person person = people.get(5, 12, 23);
people.set(9, 19, 29, person);

Note: the API is designed in such way that it doesn't require additional support from IDE. Even when annotation processing is disabled, the code that create and uses the RecordArray is valid and compiles. However, if annotation processing is not enabled, the runtime exception will be thrown when the code is executed.

See RecordArray javadocs for API details, see also internals and quirks.

Usage from Kotlin

At this moment, only Java annotation processing is supported.

Which means that you have to write interfaces, annotated with @Record in Java, but then you can use Kotlin to create the instances of the RecordArray:

Java:

@Record
public interface MyRec {
    String getName();
    int getAge();

    void setName(String name);
    void setAge(int age);
}

Kotlin:

val arr = RecordArray.create(MyRec::class.java, 10)
arr[0].age = 10
println(arr[0].age)

It's possible that native Kotlin support will be added in the future.