RealmConfiguration + new constructors

changelog.txt

@@ -1,4 +1,10 @@
 0.81
+ * Introduced RealmModules for working with custom schemas in libraries and apps.
+ * Introduced Realm.getDefaultInstance(), Realm.setDefaultInstance(RealmConfiguration) and Realm.getInstance(RealmConfiguration).
+ * Deprecated most constructors. They have been been replaced by Realm.getInstance(RealmConfiguration) and Realm.getDefaultInstance().
+ * Deprecated Realm.migrateRealmAtPath(). It has been replaced by Realm.migrateRealm(RealmConfiguration).
+ * Deprecated Realm.deleteFile(). It has been replaced by Realm.deleteRealm(RealmConfiguration).
+ * Deprecated Realm.compactFile(). It has been replaced by Realm.compactRealm(RealmConfiguration).
  * RealmList.add(), RealmList.addAt() and RealmList.set() now copy standalone objects transparently into Realm.
  * Realm now works with Kotlin (M12+). (thanks @cypressious)
  * Fix a performance regression introduced in 0.80.3 occurring during the validation of the Realm schema.

realm-annotations-processor/src/main/java/io/realm/processor/DefaultModuleGenerator.java

@@ -21,16 +21,14 @@
 import java.io.BufferedWriter;
 import java.io.IOException;
 import java.util.Collections;
-import java.util.EnumSet;
 import java.util.HashMap;
 import java.util.Map;
-import java.util.Set;
 
 import javax.annotation.processing.ProcessingEnvironment;
 import javax.lang.model.element.Modifier;
 import javax.tools.JavaFileObject;
 
-import io.realm.annotations.internal.RealmModule;
+import io.realm.annotations.RealmModule;
 
 /**
  * This class is responsible for creating the DefaultRealmModule that contains all known

realm-annotations-processor/src/main/java/io/realm/processor/ModuleMetaData.java

@@ -16,19 +16,12 @@
 
 package io.realm.processor;
 
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.Map;
-import java.util.Set;
+import io.realm.annotations.RealmModule;
 
 import javax.annotation.processing.ProcessingEnvironment;
 import javax.annotation.processing.RoundEnvironment;
-import javax.lang.model.element.Element;
-import javax.lang.model.element.ElementKind;
-import javax.lang.model.element.Name;
-import javax.lang.model.element.TypeElement;
-
-import io.realm.annotations.internal.RealmModule;
+import javax.lang.model.element.*;
+import java.util.*;
 
 /**
  * Utility class for holding metadata for the Realm modules.
@@ -39,7 +32,7 @@ public class ModuleMetaData {
     private final RoundEnvironment env;
     private Map<String, Set<ClassMetaData>> modules = new HashMap<String, Set<ClassMetaData>>();
     private Map<String, Set<ClassMetaData>> libraryModules = new HashMap<String, Set<ClassMetaData>>();
-    private Map<String, ClassMetaData> classMetaData = new HashMap<String, ClassMetaData>();
+    private Map<String, ClassMetaData> classMetaData = new HashMap<String, ClassMetaData>(); // <FullyQualifiedClassName, ClassMetaData>
     private boolean shouldCreateDefaultModule;
 
     public ModuleMetaData(RoundEnvironment env, Set<ClassMetaData> availableClasses) {
@@ -69,8 +62,8 @@ public boolean generate(ProcessingEnvironment processingEnv) {
 
             // Check that allClasses and classes are not set at the same time
             RealmModule module = classElement.getAnnotation(RealmModule.class);
-            Utils.note("Processing " + classSimpleName);
-            if (module.allClasses() && module.classes().length > 0) {
+            Utils.note("Processing module " + classSimpleName);
+            if (module.allClasses() && hasCustomClassList(classElement)) {
                 Utils.error("Setting @RealmModule(allClasses=true) will override @RealmModule(classes={...}) in " + classSimpleName);
                 return false;
             }
@@ -82,16 +75,12 @@ public boolean generate(ProcessingEnvironment processingEnv) {
                 classes = availableClasses;
             } else {
                 classes = new HashSet<ClassMetaData>();
-                for (Class<?> clazz : module.classes()) {
-                    if (!clazz.getSuperclass().toString().endsWith("RealmObject")) {
-                        Utils.error(clazz.getSimpleName() + " is not extending RealmObject. Only RealmObjects can be " +
-                                "part of a module.");
-                        return false;
-                    }
-                    ClassMetaData metadata = classMetaData.get(clazz.getName());
+                Set<String> classNames = getClassMetaDataFromModule(classElement);
+                for (String fullyQualifiedClassName : classNames) {
+                    ClassMetaData metadata = classMetaData.get(fullyQualifiedClassName);
                     if (metadata == null) {
-                        Utils.error(Utils.stripPackage(qualifiedName) + " could not be added to the module. It is not " +
-                                "possible to add classes which are part of another library.");
+                        Utils.error(Utils.stripPackage(fullyQualifiedClassName) + " could not be added to the module. " +
+                                "Only classes extending RealmObject, which are part of this project, can be added.");
                         return false;
                     }
                     classes.add(metadata);
@@ -122,6 +111,58 @@ public boolean generate(ProcessingEnvironment processingEnv) {
         return true;
     }
 
+    // Detour needed to access the class elements in the array
+    // See http://blog.retep.org/2009/02/13/getting-class-values-from-annotations-in-an-annotationprocessor/
+    private Set<String> getClassMetaDataFromModule(Element classElement) {
+        AnnotationMirror annotationMirror = getAnnotationMirror(classElement);
+        AnnotationValue annotationValue = getAnnotationValue(annotationMirror);
+        Set<String> classes = new HashSet<String>();
+        List<? extends AnnotationValue> moduleClasses = (List<? extends AnnotationValue>) annotationValue.getValue();
+        for (AnnotationValue classMirror : moduleClasses) {
+            String fullyQualifiedClassName = classMirror.getValue().toString();
+            classes.add(fullyQualifiedClassName);
+        }
+        return classes;
+    }
+
+    // Work around for asking for a Class primitive array which would otherwise throw a TypeMirrorException
+    // https://community.oracle.com/thread/1184190
+    private boolean hasCustomClassList(Element classElement) {
+        AnnotationMirror annotationMirror = getAnnotationMirror(classElement);
+        AnnotationValue annotationValue = getAnnotationValue(annotationMirror);
+        if (annotationValue == null) {
+            return false;
+        } else {
+            List<? extends AnnotationValue> moduleClasses = (List<? extends AnnotationValue>) annotationValue.getValue();
+            return moduleClasses.size() > 0;
+        }
+    }
+
+    private AnnotationMirror getAnnotationMirror(Element classElement) {
+        AnnotationMirror annotationMirror = null;
+        for (AnnotationMirror am : classElement.getAnnotationMirrors()) {
+            if (am.getAnnotationType().toString().equals(RealmModule.class.getCanonicalName())) {
+                annotationMirror = am;
+                break;
+            }
+        }
+        return annotationMirror;
+    }
+
+    private AnnotationValue getAnnotationValue(AnnotationMirror annotationMirror) {
+        if (annotationMirror == null) {
+            return null;
+        }
+        AnnotationValue annotationValue = null;
+        for (Map.Entry<? extends ExecutableElement, ? extends AnnotationValue> entry : annotationMirror.getElementValues().entrySet()) {
+            if (entry.getKey().getSimpleName().toString().equals("classes")) {
+                annotationValue = entry.getValue();
+                break;
+            }
+        }
+        return annotationValue;
+    }
+
     /**
      * Returns all module classes and the RealmObjects they know of.
      */

realm-annotations-processor/src/main/java/io/realm/processor/RealmProxyMediatorGenerator.java

@@ -31,7 +31,7 @@
 import javax.lang.model.element.Modifier;
 import javax.tools.JavaFileObject;
 
-import io.realm.annotations.internal.RealmModule;
+import io.realm.annotations.RealmModule;
 
 public class RealmProxyMediatorGenerator {
     private final String className;

realm-annotations-processor/src/test/java/io/realm/processor/RealmProcessorTest.java

@@ -21,15 +21,17 @@
 
 import javax.tools.JavaFileObject;
 
+import java.util.Arrays;
+
 import static com.google.testing.compile.JavaSourceSubjectFactory.javaSource;
+import static com.google.testing.compile.JavaSourcesSubjectFactory.javaSources;
 import static org.truth0.Truth.ASSERT;
 
 public class RealmProcessorTest {
 
     private JavaFileObject simpleModel = JavaFileObjects.forResource("some/test/Simple.java");
     private JavaFileObject simpleProxy = JavaFileObjects.forResource("io/realm/SimpleRealmProxy.java");
     private JavaFileObject allTypesModel = JavaFileObjects.forResource("some/test/AllTypes.java");
-    private JavaFileObject allTypesProxy = JavaFileObjects.forResource("io/realm/AllTypesRealmProxy.java");
     private JavaFileObject allTypesDefaultModule = JavaFileObjects.forResource("io/realm/RealmDefaultModule.java");
     private JavaFileObject allTypesDefaultMediator = JavaFileObjects.forResource("io/realm/RealmDefaultModuleMediator.java");
     private JavaFileObject booleansModel = JavaFileObjects.forResource("some/test/Booleans.java");
@@ -111,6 +113,70 @@ public void compareProcessedAllTypesFile() throws Exception {
                 .generatesSources(allTypesDefaultMediator, allTypesDefaultModule, allTypesDefaultMediator);
     }
 
+    @Test
+    public void compileAppModuleCustomClasses() throws Exception {
+        ASSERT.about(javaSources())
+                .that(Arrays.asList(allTypesModel, JavaFileObjects.forResource("some/test/AppModuleCustomClasses.java")))
+                .processedWith(new RealmProcessor())
+                .compilesWithoutError();
+    }
+
+    @Test
+    public void compileAppModuleAllClasses() throws Exception {
+        ASSERT.about(javaSources())
+                .that(Arrays.asList(allTypesModel, JavaFileObjects.forResource("some/test/AppModuleAllClasses.java")))
+                .processedWith(new RealmProcessor())
+                .compilesWithoutError();
+    }
+
+    @Test
+    public void compileLibraryModulesAllClasses() throws Exception {
+        ASSERT.about(javaSources())
+                .that(Arrays.asList(allTypesModel, JavaFileObjects.forResource("some/test/LibraryModuleAllClasses.java")))
+                .processedWith(new RealmProcessor())
+                .compilesWithoutError();
+    }
+
+    @Test
+    public void compileLibraryModulesCustomClasses() throws Exception {
+        ASSERT.about(javaSources())
+                .that(Arrays.asList(allTypesModel, JavaFileObjects.forResource("some/test/LibraryModuleCustomClasses.java")))
+                .processedWith(new RealmProcessor())
+                .compilesWithoutError();
+    }
+
+    @Test
+    public void compileAppModuleMixedParametersFail() throws Exception {
+        ASSERT.about(javaSources())
+                .that(Arrays.asList(allTypesModel, JavaFileObjects.forResource("some/test/InvalidAppModuleMixedParameters.java")))
+                .processedWith(new RealmProcessor())
+                .failsToCompile();
+    }
+
+    @Test
+    public void compileAppModuleWrongTypeFail() throws Exception {
+        ASSERT.about(javaSources())
+                .that(Arrays.asList(allTypesModel, JavaFileObjects.forResource("some/test/InvalidAppModuleWrongType.java")))
+                .processedWith(new RealmProcessor())
+                .failsToCompile();
+    }
+
+    @Test
+    public void compileLibraryModuleMixedParametersFail() throws Exception {
+        ASSERT.about(javaSources())
+                .that(Arrays.asList(allTypesModel, JavaFileObjects.forResource("some/test/InvalidLibraryModuleMixedParameters.java")))
+                .processedWith(new RealmProcessor())
+                .failsToCompile();
+    }
+
+    @Test
+    public void compileLibraryModuleWrongTypeFail() throws Exception {
+        ASSERT.about(javaSources())
+                .that(Arrays.asList(allTypesModel, JavaFileObjects.forResource("some/test/InvalidLibraryModuleWrongType.java")))
+                .processedWith(new RealmProcessor())
+                .failsToCompile();
+    }
+
     @Test
     public void compileBooleanFile() {
         ASSERT.about(javaSource())

realm-annotations-processor/src/test/resources/io/realm/RealmDefaultModule.java

@@ -1,7 +1,7 @@
 package io.realm;
 
 
-@io.realm.annotations.internal.RealmModule(allClasses = true)
+@io.realm.annotations.RealmModule(allClasses = true)
 class DefaultRealmModule {
 
 }

realm-annotations-processor/src/test/resources/io/realm/RealmDefaultModuleMediator.java

@@ -16,7 +16,7 @@
 import org.json.JSONObject;
 import some.test.AllTypes;
 
-@io.realm.annotations.internal.RealmModule
+@io.realm.annotations.RealmModule
 class DefaultRealmModuleMediator extends RealmProxyMediator {
 
     private static final List<Class<? extends RealmObject>> MODEL_CLASSES;

realm-annotations-processor/src/test/resources/some/test/AppModuleAllClasses.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2015 Realm Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package some.test;
+
+import java.util.Date;
+
+import io.realm.RealmList;
+import io.realm.RealmObject;
+import io.realm.annotations.PrimaryKey;
+import io.realm.annotations.RealmModule;
+
+@RealmModule(allClasses = true)
+public class AppModuleAllClasses {
+
+}

realm-annotations-processor/src/test/resources/some/test/AppModuleCustomClasses.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2015 Realm Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package some.test;
+
+import java.util.Date;
+
+import io.realm.RealmList;
+import io.realm.RealmObject;
+import io.realm.annotations.PrimaryKey;
+import io.realm.annotations.RealmModule;
+
+@RealmModule(classes = { AllTypes.class })
+public class AppModuleCustomClasses {
+
+}

realm-annotations-processor/src/test/resources/some/test/InvalidAppModuleMixedParameters.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2015 Realm Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package some.test;
+
+import java.util.Date;
+
+import io.realm.RealmList;
+import io.realm.RealmObject;
+import io.realm.annotations.PrimaryKey;
+import io.realm.annotations.RealmModule;
+
+// Setting both allClasses and classes is not allowed at the same time
+@RealmModule(allClasses = true, classes = { AllTypes.class })
+public class InvalidAllTypesModuleMixedParameters {
+
+}

realm-annotations-processor/src/test/resources/some/test/InvalidAppModuleWrongType.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2015 Realm Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package some.test;
+
+import java.util.Date;
+
+import io.realm.RealmList;
+import io.realm.RealmObject;
+import io.realm.annotations.PrimaryKey;
+import io.realm.annotations.RealmModule;
+
+// Object is not a RealmObject which the Annotation Processor should be able to detect.
+@RealmModule(classes = { Object.class, AllTypes.class })
+public class InvalidAllTypesModuleWrongType {
+
+}