Merge pull request #417 from domaframework/improve-docs

Improve documents and polish the related code

Author: nakamura-to

docs/criteria-api.rst

@@ -1,6 +1,6 @@
 package org.seasar.doma.jdbc.criteria.command;
 
-import static java.util.stream.Collectors.*;
+import static java.util.stream.Collectors.toList;
 
 import java.util.LinkedHashMap;
 import java.util.List;
@@ -21,10 +21,8 @@ public class AssociateCommand<ENTITY> implements Command<List<ENTITY>> {
   private final SelectQuery query;
 
   public AssociateCommand(SelectContext context, SelectQuery query) {
-    Objects.requireNonNull(context);
-    Objects.requireNonNull(query);
-    this.context = context;
-    this.query = query;
+    this.context = Objects.requireNonNull(context);
+    this.query = Objects.requireNonNull(query);
   }
 
   @Override

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/command/AssociateCommand.java

@@ -10,9 +10,8 @@ public final class EntityKey {
   private final List<?> items;
 
   public EntityKey(EntityDef<?> entityDef, List<?> items) {
-    Objects.requireNonNull(entityDef);
+    this.entityDef = Objects.requireNonNull(entityDef);
     Objects.requireNonNull(items);
-    this.entityDef = entityDef;
     this.items = Collections.unmodifiableList(items);
   }
 

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/command/EntityKey.java

@@ -14,8 +14,7 @@ public class EntityPoolIterationHandler
 
   public EntityPoolIterationHandler(List<EntityDef<?>> entityDefs) {
     super(new ResultListCallback<>());
-    Objects.requireNonNull(entityDefs);
-    this.entityDefs = entityDefs;
+    this.entityDefs = Objects.requireNonNull(entityDefs);
   }
 
   @Override

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/command/EntityPoolIterationHandler.java

@@ -27,15 +27,12 @@
 import org.seasar.doma.wrapper.Wrapper;
 
 public class EntityPoolProvider implements ObjectProvider<EntityPool> {
-
   private final List<EntityDef<?>> entityDefs;
-
   private final JdbcMappingVisitor jdbcMappingVisitor;
 
   public EntityPoolProvider(List<EntityDef<?>> entityDefs, Query query) {
-    Objects.requireNonNull(entityDefs);
+    this.entityDefs = Objects.requireNonNull(entityDefs);
     Objects.requireNonNull(query);
-    this.entityDefs = entityDefs;
     this.jdbcMappingVisitor = query.getConfig().getDialect().getJdbcMappingVisitor();
   }
 

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/command/EntityPoolProvider.java

@@ -17,8 +17,7 @@ public class MappedResultProvider<RESULT> extends AbstractObjectProvider<RESULT>
 
   public MappedResultProvider(Query query, Function<Row, RESULT> mapper) {
     Objects.requireNonNull(query);
-    Objects.requireNonNull(mapper);
-    this.mapper = mapper;
+    this.mapper = Objects.requireNonNull(mapper);
     this.jdbcMappingVisitor = query.getConfig().getDialect().getJdbcMappingVisitor();
   }
 

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/command/MappedResultProvider.java

@@ -2,6 +2,7 @@
 
 import java.util.Collections;
 import java.util.List;
+import java.util.Objects;
 import org.seasar.doma.jdbc.criteria.option.LikeOption;
 import org.seasar.doma.jdbc.criteria.tuple.Tuple2;
 
@@ -13,8 +14,8 @@ class Eq implements Criterion {
     public final Operand right;
 
     public Eq(Operand.Prop left, Operand right) {
-      this.left = left;
-      this.right = right;
+      this.left = Objects.requireNonNull(left);
+      this.right = Objects.requireNonNull(right);
     }
 
     @Override
@@ -28,8 +29,8 @@ class Ne implements Criterion {
     public final Operand right;
 
     public Ne(Operand.Prop left, Operand right) {
-      this.left = left;
-      this.right = right;
+      this.left = Objects.requireNonNull(left);
+      this.right = Objects.requireNonNull(right);
     }
 
     @Override
@@ -43,8 +44,8 @@ class Gt implements Criterion {
     public final Operand right;
 
     public Gt(Operand.Prop left, Operand right) {
-      this.left = left;
-      this.right = right;
+      this.left = Objects.requireNonNull(left);
+      this.right = Objects.requireNonNull(right);
     }
 
     @Override
@@ -58,8 +59,8 @@ class Ge implements Criterion {
     public final Operand right;
 
     public Ge(Operand.Prop left, Operand right) {
-      this.left = left;
-      this.right = right;
+      this.left = Objects.requireNonNull(left);
+      this.right = Objects.requireNonNull(right);
     }
 
     @Override
@@ -73,8 +74,8 @@ class Lt implements Criterion {
     public final Operand right;
 
     public Lt(Operand.Prop left, Operand right) {
-      this.left = left;
-      this.right = right;
+      this.left = Objects.requireNonNull(left);
+      this.right = Objects.requireNonNull(right);
     }
 
     @Override
@@ -88,8 +89,8 @@ class Le implements Criterion {
     public final Operand right;
 
     public Le(Operand.Prop left, Operand right) {
-      this.left = left;
-      this.right = right;
+      this.left = Objects.requireNonNull(left);
+      this.right = Objects.requireNonNull(right);
     }
 
     @Override
@@ -102,7 +103,7 @@ class IsNull implements Criterion {
     public final Operand.Prop prop;
 
     public IsNull(Operand.Prop prop) {
-      this.prop = prop;
+      this.prop = Objects.requireNonNull(prop);
     }
 
     @Override
@@ -115,7 +116,7 @@ class IsNotNull implements Criterion {
     public final Operand.Prop prop;
 
     public IsNotNull(Operand.Prop prop) {
-      this.prop = prop;
+      this.prop = Objects.requireNonNull(prop);
     }
 
     @Override
@@ -130,9 +131,9 @@ class Like implements Criterion {
     public final LikeOption option;
 
     public Like(Operand.Prop left, Operand right, LikeOption option) {
-      this.left = left;
-      this.right = right;
-      this.option = option;
+      this.left = Objects.requireNonNull(left);
+      this.right = Objects.requireNonNull(right);
+      this.option = Objects.requireNonNull(option);
     }
 
     @Override
@@ -147,9 +148,9 @@ class NotLike implements Criterion {
     public final LikeOption option;
 
     public NotLike(Operand.Prop left, Operand right, LikeOption option) {
-      this.left = left;
-      this.right = right;
-      this.option = option;
+      this.left = Objects.requireNonNull(left);
+      this.right = Objects.requireNonNull(right);
+      this.option = Objects.requireNonNull(option);
     }
 
     @Override
@@ -164,9 +165,9 @@ class Between implements Criterion {
     public final Operand.Param end;
 
     public Between(Operand.Prop prop, Operand.Param start, Operand.Param end) {
-      this.prop = prop;
-      this.start = start;
-      this.end = end;
+      this.prop = Objects.requireNonNull(prop);
+      this.start = Objects.requireNonNull(start);
+      this.end = Objects.requireNonNull(end);
     }
 
     @Override
@@ -180,8 +181,8 @@ class In implements Criterion {
     public final List<Operand.Param> right;
 
     public In(Operand.Prop left, List<Operand.Param> right) {
-      this.left = left;
-      this.right = right;
+      this.left = Objects.requireNonNull(left);
+      this.right = Objects.requireNonNull(right);
     }
 
     @Override
@@ -195,8 +196,8 @@ class NotIn implements Criterion {
     public final List<Operand.Param> right;
 
     public NotIn(Operand.Prop left, List<Operand.Param> right) {
-      this.left = left;
-      this.right = right;
+      this.left = Objects.requireNonNull(left);
+      this.right = Objects.requireNonNull(right);
     }
 
     @Override
@@ -210,8 +211,8 @@ class InSubQuery implements Criterion {
     public final SelectContext right;
 
     public InSubQuery(Operand.Prop left, SelectContext right) {
-      this.left = left;
-      this.right = right;
+      this.left = Objects.requireNonNull(left);
+      this.right = Objects.requireNonNull(right);
     }
 
     @Override
@@ -225,8 +226,8 @@ class NotInSubQuery implements Criterion {
     public final SelectContext right;
 
     public NotInSubQuery(Operand.Prop left, SelectContext right) {
-      this.left = left;
-      this.right = right;
+      this.left = Objects.requireNonNull(left);
+      this.right = Objects.requireNonNull(right);
     }
 
     @Override
@@ -241,8 +242,8 @@ class InTuple2 implements Criterion {
 
     public InTuple2(
         Tuple2<Operand.Prop, Operand.Prop> left, List<Tuple2<Operand.Param, Operand.Param>> right) {
-      this.left = left;
-      this.right = right;
+      this.left = Objects.requireNonNull(left);
+      this.right = Objects.requireNonNull(right);
     }
 
     @Override
@@ -257,8 +258,8 @@ class NotInTuple2 implements Criterion {
 
     public NotInTuple2(
         Tuple2<Operand.Prop, Operand.Prop> left, List<Tuple2<Operand.Param, Operand.Param>> right) {
-      this.left = left;
-      this.right = right;
+      this.left = Objects.requireNonNull(left);
+      this.right = Objects.requireNonNull(right);
     }
 
     @Override
@@ -272,8 +273,8 @@ class InTuple2SubQuery implements Criterion {
     public final SelectContext right;
 
     public InTuple2SubQuery(Tuple2<Operand.Prop, Operand.Prop> left, SelectContext right) {
-      this.left = left;
-      this.right = right;
+      this.left = Objects.requireNonNull(left);
+      this.right = Objects.requireNonNull(right);
     }
 
     @Override
@@ -287,8 +288,8 @@ class NotInTuple2SubQuery implements Criterion {
     public final SelectContext right;
 
     public NotInTuple2SubQuery(Tuple2<Operand.Prop, Operand.Prop> left, SelectContext right) {
-      this.left = left;
-      this.right = right;
+      this.left = Objects.requireNonNull(left);
+      this.right = Objects.requireNonNull(right);
     }
 
     @Override
@@ -301,7 +302,7 @@ class Exists implements Criterion {
     public final SelectContext context;
 
     public Exists(SelectContext context) {
-      this.context = context;
+      this.context = Objects.requireNonNull(context);
     }
 
     @Override
@@ -314,7 +315,7 @@ class NotExists implements Criterion {
     public final SelectContext context;
 
     public NotExists(SelectContext context) {
-      this.context = context;
+      this.context = Objects.requireNonNull(context);
     }
 
     @Override
@@ -327,6 +328,7 @@ class And implements Criterion {
     public final List<Criterion> criterionList;
 
     public And(List<Criterion> criterionList) {
+      Objects.requireNonNull(criterionList);
       this.criterionList = Collections.unmodifiableList(criterionList);
     }
 
@@ -340,6 +342,7 @@ class Or implements Criterion {
     public final List<Criterion> criterionList;
 
     public Or(List<Criterion> criterionList) {
+      Objects.requireNonNull(criterionList);
       this.criterionList = Collections.unmodifiableList(criterionList);
     }
 
@@ -353,6 +356,7 @@ class Not implements Criterion {
     public final List<Criterion> criterionList;
 
     public Not(List<Criterion> criterionList) {
+      Objects.requireNonNull(criterionList);
       this.criterionList = Collections.unmodifiableList(criterionList);
     }
 

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/context/Criterion.java

@@ -10,11 +10,10 @@ public class DeleteContext implements Context {
   public final EntityDef<?> entityDef;
   public final List<EntityDef<?>> entityDefs;
   public List<Criterion> where = new ArrayList<>();
-  public final DeleteSettings options = new DeleteSettings();
+  public final DeleteSettings settings = new DeleteSettings();
 
   public DeleteContext(EntityDef<?> entityDef) {
-    Objects.requireNonNull(entityDef);
-    this.entityDef = entityDef;
+    this.entityDef = Objects.requireNonNull(entityDef);
     this.entityDefs = Collections.singletonList(entityDef);
   }
 
@@ -35,6 +34,6 @@ public void setWhere(List<Criterion> where) {
 
   @Override
   public DeleteSettings getSettings() {
-    return options;
+    return settings;
   }
 }

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/context/DeleteContext.java

@@ -1,8 +1,8 @@
 package org.seasar.doma.jdbc.criteria.context;
 
 public class DeleteSettings extends Settings {
-  int batchSize = 0;
-  boolean allowEmptyWhere;
+  private int batchSize = 0;
+  private boolean allowEmptyWhere;
 
   public int getBatchSize() {
     return batchSize;

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/context/DeleteSettings.java

@@ -10,12 +10,11 @@
 public class InsertContext implements Context {
   public final EntityDef<?> entityDef;
   public final List<EntityDef<?>> entityDefs;
-  public Map<Operand.Prop, Operand.Param> values = new LinkedHashMap<>();
-  public final InsertSettings options = new InsertSettings();
+  public final Map<Operand.Prop, Operand.Param> values = new LinkedHashMap<>();
+  public final InsertSettings settings = new InsertSettings();
 
   public InsertContext(EntityDef<?> entityDef) {
-    Objects.requireNonNull(entityDef);
-    this.entityDef = entityDef;
+    this.entityDef = Objects.requireNonNull(entityDef);
     this.entityDefs = Collections.singletonList(entityDef);
   }
 
@@ -36,6 +35,6 @@ public void setWhere(List<Criterion> where) {
 
   @Override
   public InsertSettings getSettings() {
-    return options;
+    return settings;
   }
 }