Unify import order, javadoc and code formatting.

Author: greenrobot-team

objectbox-java/src/main/java/io/objectbox/Box.java

@@ -302,6 +302,7 @@ public boolean isEmpty() {
 
  /**
  * Returns all stored Objects in this Box.
+ *
  * @return since 2.4 the returned list is always mutable (before an empty result list was immutable)
  */
  public List<T> getAll() {
@@ -320,8 +321,9 @@ public List<T> getAll() {
  /**
  * Check if an object with the given ID exists in the database.
  * This is more efficient than a {@link #get(long)} and comparing against null.
+ *
+ * @return true if an object with the given ID was found, false otherwise.
  * @since 2.7
- * @return true if a object with the given ID was found, false otherwise
  */
  public boolean contains(long id) {
  Cursor<T> reader = getReader();
@@ -425,6 +427,7 @@ public void putBatched(@Nullable Collection<T> entities, int batchSize) {
 
  /**
  * Removes (deletes) the Object by its ID.
+ *
  * @return true if an entity was actually removed (false if no entity exists with the given ID)
  */
  public boolean remove(long id) {
@@ -486,6 +489,7 @@ public void removeByIds(@Nullable Collection<Long> ids) {
 
  /**
  * Removes (deletes) the given Object.
+ *
  * @return true if an entity was actually removed (false if no entity exists with the given ID)
  */
  public boolean remove(T object) {

objectbox-java/src/main/java/io/objectbox/BoxStore.java

@@ -16,9 +16,6 @@
 
 package io.objectbox;
 
-import io.objectbox.internal.Feature;
-import org.greenrobot.essentials.collections.LongHashMap;
-
 import java.io.Closeable;
 import java.io.File;
 import java.io.IOException;
@@ -49,12 +46,14 @@
 import io.objectbox.exception.DbException;
 import io.objectbox.exception.DbExceptionListener;
 import io.objectbox.exception.DbSchemaException;
+import io.objectbox.internal.Feature;
 import io.objectbox.internal.NativeLibraryLoader;
 import io.objectbox.internal.ObjectBoxThreadPool;
 import io.objectbox.reactive.DataObserver;
 import io.objectbox.reactive.DataPublisher;
 import io.objectbox.reactive.SubscriptionBuilder;
 import io.objectbox.sync.SyncClient;
+import org.greenrobot.essentials.collections.LongHashMap;
 
 /**
  * An ObjectBox database that provides {@link Box Boxes} to put and get objects of specific entity classes
@@ -267,7 +266,7 @@ public static boolean isSyncServerAvailable() {
 
  try {
  handle = nativeCreateWithFlatOptions(builder.buildFlatStoreOptions(canonicalPath), builder.model);
- if(handle == 0) throw new DbException("Could not create native store");
+ if (handle == 0) throw new DbException("Could not create native store");
 
  int debugFlags = builder.debugFlags;
  if (debugFlags != 0) {
@@ -539,7 +538,7 @@ public Transaction beginTx() {
  System.out.println("Begin TX with commit count " + initialCommitCount);
  }
  long nativeTx = nativeBeginTx(handle);
- if(nativeTx == 0) throw new DbException("Could not create native transaction");
+ if (nativeTx == 0) throw new DbException("Could not create native transaction");
 
  Transaction tx = new Transaction(this, nativeTx, initialCommitCount);
  synchronized (transactions) {
@@ -565,7 +564,7 @@ public Transaction beginReadTx() {
  System.out.println("Begin read TX with commit count " + initialCommitCount);
  }
  long nativeTx = nativeBeginReadTx(handle);
- if(nativeTx == 0) throw new DbException("Could not create native read transaction");
+ if (nativeTx == 0) throw new DbException("Could not create native read transaction");
 
  Transaction tx = new Transaction(this, nativeTx, initialCommitCount);
  synchronized (transactions) {
@@ -601,7 +600,7 @@ public void close() {
  synchronized (this) {
  oldClosedState = closed;
  if (!closed) {
- if(objectBrowserPort != 0) { // not linked natively (yet), so clean up here
+ if (objectBrowserPort != 0) { // not linked natively (yet), so clean up here
  try {
  stopObjectBrowser();
  } catch (Throwable e) {
@@ -679,7 +678,7 @@ public boolean deleteAllFiles() {
  * BoxStoreBuilder#DEFAULT_NAME})".
  *
  * @param objectStoreDirectory directory to be deleted; this is the value you previously provided to {@link
- *  BoxStoreBuilder#directory(File)}
+ * BoxStoreBuilder#directory(File)}
  * @return true if the directory 1) was deleted successfully OR 2) did not exist in the first place.
  * Note: If false is returned, any number of files may have been deleted before the failure happened.
  * @throws IllegalStateException if the given directory is still used by a open {@link BoxStore}.
@@ -715,9 +714,9 @@ public static boolean deleteAllFiles(File objectStoreDirectory) {
  * If you did not use a custom name with BoxStoreBuilder, you can pass "new File({@link
  * BoxStoreBuilder#DEFAULT_NAME})".
  *
- * @param androidContext  provide an Android Context like Application or Service
+ * @param androidContext provide an Android Context like Application or Service
  * @param customDbNameOrNull use null for default name, or the name you previously provided to {@link
- *  BoxStoreBuilder#name(String)}.
+ * BoxStoreBuilder#name(String)}.
  * @return true if the directory 1) was deleted successfully OR 2) did not exist in the first place.
  * Note: If false is returned, any number of files may have been deleted before the failure happened.
  * @throws IllegalStateException if the given name is still used by a open {@link BoxStore}.
@@ -736,9 +735,9 @@ public static boolean deleteAllFiles(Object androidContext, @Nullable String cus
  * BoxStoreBuilder#DEFAULT_NAME})".
  *
  * @param baseDirectoryOrNull use null for no base dir, or the value you previously provided to {@link
- *  BoxStoreBuilder#baseDirectory(File)}
- * @param customDbNameOrNull  use null for default name, or the name you previously provided to {@link
- *  BoxStoreBuilder#name(String)}.
+ * BoxStoreBuilder#baseDirectory(File)}
+ * @param customDbNameOrNull use null for default name, or the name you previously provided to {@link
+ * BoxStoreBuilder#name(String)}.
  * @return true if the directory 1) was deleted successfully OR 2) did not exist in the first place.
  * Note: If false is returned, any number of files may have been deleted before the failure happened.
  * @throws IllegalStateException if the given directory (+name) is still used by a open {@link BoxStore}.
@@ -1055,8 +1054,9 @@ public String diagnose() {
  /**
  * Validate database pages, a lower level storage unit (integrity check).
  * Do not call this inside a transaction (currently unsupported).
+ *
  * @param pageLimit the maximum of pages to validate (e.g. to limit time spent on validation).
- *  Pass zero set no limit and thus validate all pages.
+ * Pass zero set no limit and thus validate all pages.
  * @param checkLeafLevel Flag to validate leaf pages. These do not point to other pages but contain data.
  * @return Number of pages validated, which may be twice the given pageLimit as internally there are "two DBs".
  * @throws DbException if validation failed to run (does not tell anything about DB file consistency).
@@ -1172,7 +1172,7 @@ public String startObjectBrowser(String urlToBindTo) {
 
  @Experimental
  public synchronized boolean stopObjectBrowser() {
- if(objectBrowserPort == 0) {
+ if (objectBrowserPort == 0) {
  throw new IllegalStateException("ObjectBrowser has not been started before");
  }
  objectBrowserPort = 0;

objectbox-java/src/main/java/io/objectbox/BoxStoreBuilder.java

@@ -16,10 +16,6 @@
 
 package io.objectbox;
 
-import io.objectbox.flatbuffers.FlatBufferBuilder;
-
-import org.greenrobot.essentials.io.IoUtils;
-
 import java.io.BufferedInputStream;
 import java.io.BufferedOutputStream;
 import java.io.File;
@@ -38,9 +34,11 @@
 import io.objectbox.annotation.apihint.Experimental;
 import io.objectbox.annotation.apihint.Internal;
 import io.objectbox.exception.DbException;
+import io.objectbox.flatbuffers.FlatBufferBuilder;
 import io.objectbox.ideasonly.ModelUpdate;
 import io.objectbox.model.FlatStoreOptions;
 import io.objectbox.model.ValidateOnOpenMode;
+import org.greenrobot.essentials.io.IoUtils;
 
 /**
  * Configures and builds a {@link BoxStore} with reasonable defaults. To get an instance use {@code MyObjectBox.builder()}.
@@ -299,7 +297,7 @@ public BoxStoreBuilder fileMode(int mode) {
  * amount of threads you are using.
  * For highly concurrent setups (e.g. you are using ObjectBox on the server side) it may make sense to increase the
  * number.
- *
+ * <p>
  * Note: Each thread that performed a read transaction and is still alive holds on to a reader slot.
  * These slots only get vacated when the thread ends. Thus, be mindful with the number of active threads.
  * Alternatively, you can opt to try the experimental noReaderThreadLocals option flag.
@@ -312,9 +310,9 @@ public BoxStoreBuilder maxReaders(int maxReaders) {
  /**
  * Disables the usage of thread locals for "readers" related to read transactions.
  * This can make sense if you are using a lot of threads that are kept alive.
- *
+ * <p>
  * Note: This is still experimental, as it comes with subtle behavior changes at a low level and may affect
- *  corner cases with e.g. transactions, which may not be fully tested at the moment.
+ * corner cases with e.g. transactions, which may not be fully tested at the moment.
  */
  public BoxStoreBuilder noReaderThreadLocals() {
  this.noReaderThreadLocals = true;
@@ -527,7 +525,7 @@ byte[] buildFlatStoreOptions(String canonicalPath) {
  int offset = FlatStoreOptions.endFlatStoreOptions(fbb);
  fbb.finish(offset);
  return fbb.sizedByteArray();
- } 
+ }
 
  /**
  * Builds a {@link BoxStore} using any given configuration.

objectbox-java/src/main/java/io/objectbox/ModelBuilder.java

@@ -16,14 +16,13 @@
 
 package io.objectbox;
 
-import io.objectbox.flatbuffers.FlatBufferBuilder;
-
 import java.util.ArrayList;
 import java.util.List;
 
 import javax.annotation.Nullable;
 
 import io.objectbox.annotation.apihint.Internal;
+import io.objectbox.flatbuffers.FlatBufferBuilder;
 import io.objectbox.model.IdUid;
 import io.objectbox.model.Model;
 import io.objectbox.model.ModelEntity;

objectbox-java/src/main/java/io/objectbox/ObjectClassPublisher.java

@@ -16,9 +16,6 @@
 
 package io.objectbox;
 
-import org.greenrobot.essentials.collections.MultimapSet;
-import org.greenrobot.essentials.collections.MultimapSet.SetType;
-
 import java.util.ArrayDeque;
 import java.util.Collection;
 import java.util.Collections;
@@ -32,6 +29,8 @@
 import io.objectbox.reactive.DataPublisher;
 import io.objectbox.reactive.DataPublisherUtils;
 import io.objectbox.reactive.SubscriptionBuilder;
+import org.greenrobot.essentials.collections.MultimapSet;
+import org.greenrobot.essentials.collections.MultimapSet.SetType;
 
 /**
  * A {@link DataPublisher} that notifies {@link DataObserver}s about changes in an entity box.
@@ -45,14 +44,17 @@ class ObjectClassPublisher implements DataPublisher<Class>, Runnable {
  final BoxStore boxStore;
  final MultimapSet<Integer, DataObserver<Class>> observersByEntityTypeId = MultimapSet.create(SetType.THREAD_SAFE);
  private final Deque<PublishRequest> changesQueue = new ArrayDeque<>();
+
  private static class PublishRequest {
  @Nullable private final DataObserver<Class> observer;
  private final int[] entityTypeIds;
+
  PublishRequest(@Nullable DataObserver<Class> observer, int[] entityTypeIds) {
  this.observer = observer;
  this.entityTypeIds = entityTypeIds;
  }
  }
+
  volatile boolean changePublisherRunning;
 
  ObjectClassPublisher(BoxStore boxStore) {

objectbox-java/src/main/java/io/objectbox/Property.java

@@ -16,6 +16,12 @@
 
 package io.objectbox;
 
+import java.io.Serializable;
+import java.util.Collection;
+import java.util.Date;
+
+import javax.annotation.Nullable;
+
 import io.objectbox.annotation.apihint.Internal;
 import io.objectbox.converter.PropertyConverter;
 import io.objectbox.exception.DbException;
@@ -34,11 +40,6 @@
 import io.objectbox.query.PropertyQueryConditionImpl.StringStringCondition;
 import io.objectbox.query.QueryBuilder.StringOrder;
 
-import javax.annotation.Nullable;
-import java.io.Serializable;
-import java.util.Collection;
-import java.util.Date;
-
 /**
  * Meta data describing a Property of an ObjectBox Entity.
  * Properties are typically used when defining {@link io.objectbox.query.Query Query} conditions
@@ -60,7 +61,8 @@ public class Property<ENTITY> implements Serializable {
  public final boolean isId;
  public final boolean isVirtual;
  public final String dbName;
- @SuppressWarnings("rawtypes") // Use raw type of PropertyConverter to allow users to supply a generic implementation.
+ @SuppressWarnings("rawtypes")
+ // Use raw type of PropertyConverter to allow users to supply a generic implementation.
  public final Class<? extends PropertyConverter> converterClass;
 
  /** Type, which is converted to a type supported by the DB. */
@@ -83,14 +85,16 @@ public Property(EntityInfo<ENTITY> entity, int ordinal, int id, Class<?> type, S
  this(entity, ordinal, id, type, name, isId, dbName, null, null);
  }
 
- @SuppressWarnings("rawtypes") // Use raw type of PropertyConverter to allow users to supply a generic implementation.
+ @SuppressWarnings("rawtypes")
+ // Use raw type of PropertyConverter to allow users to supply a generic implementation.
  public Property(EntityInfo<ENTITY> entity, int ordinal, int id, Class<?> type, String name, boolean isId,
  @Nullable String dbName, @Nullable Class<? extends PropertyConverter> converterClass,
  @Nullable Class<?> customType) {
  this(entity, ordinal, id, type, name, isId, false, dbName, converterClass, customType);
  }
 
- @SuppressWarnings("rawtypes") // Use raw type of PropertyConverter to allow users to supply a generic implementation.
+ @SuppressWarnings("rawtypes")
+ // Use raw type of PropertyConverter to allow users to supply a generic implementation.
  public Property(EntityInfo<ENTITY> entity, int ordinal, int id, Class<?> type, String name, boolean isId,
  boolean isVirtual, @Nullable String dbName,
  @Nullable Class<? extends PropertyConverter> converterClass, @Nullable Class<?> customType) {

objectbox-java/src/main/java/io/objectbox/Transaction.java

@@ -184,7 +184,7 @@ public <T> Cursor<T> createCursor(Class<T> entityClass) {
  EntityInfo<T> entityInfo = store.getEntityInfo(entityClass);
  CursorFactory<T> factory = entityInfo.getCursorFactory();
  long cursorHandle = nativeCreateCursor(transaction, entityInfo.getDbName(), entityClass);
- if(cursorHandle == 0) throw new DbException("Could not create native cursor");
+ if (cursorHandle == 0) throw new DbException("Could not create native cursor");
  return factory.createCursor(this, cursorHandle, store);
  }
 

objectbox-java/src/main/java/io/objectbox/ideasonly/ModelModifier.java

@@ -35,7 +35,7 @@ public void remove() {
  }
 
  public PropertyModifier property(String name) {
- return  new PropertyModifier(this, name);
+ return new PropertyModifier(this, name);
  }
  }
 

objectbox-java/src/main/java/io/objectbox/internal/DebugCursor.java

@@ -42,7 +42,7 @@ public class DebugCursor implements Closeable {
  public static DebugCursor create(Transaction tx) {
  long txHandle = InternalAccess.getHandle(tx);
  long handle = nativeCreate(txHandle);
- if(handle == 0) throw new DbException("Could not create native debug cursor");
+ if (handle == 0) throw new DbException("Could not create native debug cursor");
  return new DebugCursor(tx, handle);
  }
 

objectbox-java/src/main/java/io/objectbox/internal/Feature.java

@@ -11,7 +11,7 @@ public enum Feature {
  /** TimeSeries support (date/date-nano companion ID and other time-series functionality). */
  TIME_SERIES(2),
 
-  /** Sync client availability. Visit <a href="https://objectbox.io/sync">the ObjectBox Sync website</a> for more details. */
+ /** Sync client availability. Visit <a href="https://objectbox.io/sync">the ObjectBox Sync website</a> for more details. */
  SYNC(3),
 
  /** Check whether debug log can be enabled during runtime. */