DATAMONGO-1834 - Polishing.

Increase visibility of Timezone factory methods. Add missing nullable annotation. Tweaked Javadoc. Add tests for Timezone using expressions/field references.

Original Pull Request: #539

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/AbstractAggregationExpression.java

@@ -23,6 +23,7 @@ import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
 
+import org.springframework.util.Assert;
 import org.springframework.util.ObjectUtils;
 
 import com.mongodb.BasicDBObject;
@@ -51,7 +52,6 @@ abstract class AbstractAggregationExpression implements AggregationExpression {
 
 	@SuppressWarnings("unchecked")
 	public DBObject toDbObject(Object value, AggregationOperationContext context) {
-
 		return new BasicDBObject(getMongoMethod(), unpack(value, context));
 	}
 
@@ -105,9 +105,7 @@ abstract class AbstractAggregationExpression implements AggregationExpression {
 			List<Object> clone = new ArrayList<Object>((List) this.value);
 
 			if (value instanceof List) {
-				for (Object val : (List) value) {
-					clone.add(val);
-				}
+				clone.addAll((List) value);
 			} else {
 				clone.add(value);
 			}
@@ -120,9 +118,8 @@ abstract class AbstractAggregationExpression implements AggregationExpression {
 	@SuppressWarnings("unchecked")
 	protected java.util.Map<String, Object> append(String key, Object value) {
 
-		if (!(this.value instanceof java.util.Map)) {
-			throw new IllegalArgumentException("o_O");
-		}
+		Assert.isInstanceOf(Map.class, this.value, "Value must be a type of Map!");
+
 		java.util.Map<String, Object> clone = new LinkedHashMap<String, Object>((java.util.Map) this.value);
 		clone.put(key, value);
 		return clone;
@@ -148,6 +145,7 @@ abstract class AbstractAggregationExpression implements AggregationExpression {
 	 * @return
 	 * @since 2.1
 	 */
+	@SuppressWarnings("unchecked")
 	protected <T> T get(int index) {
 		return (T) values().get(index);
 	}
@@ -160,11 +158,10 @@ abstract class AbstractAggregationExpression implements AggregationExpression {
 	 * @return
 	 * @since 2.1
 	 */
+	@SuppressWarnings("unchecked")
 	protected <T> T get(Object key) {
 
-		if (!(this.value instanceof java.util.Map)) {
-			throw new IllegalArgumentException("o_O");
-		}
+		Assert.isInstanceOf(Map.class, this.value, "Value must be a type of Map!");
 
 		return (T) ((java.util.Map<String, Object>) this.value).get(key);
 	}
@@ -175,11 +172,10 @@ abstract class AbstractAggregationExpression implements AggregationExpression {
 	 * @since 2.1
 	 * @return
 	 */
+	@SuppressWarnings("unchecked")
 	protected java.util.Map<String, Object> argumentMap() {
 
-		if (!(this.value instanceof java.util.Map)) {
-			throw new IllegalArgumentException("o_O");
-		}
+		Assert.isInstanceOf(Map.class, this.value, "Value must be a type of Map!");
 
 		return Collections.unmodifiableMap((java.util.Map) value);
 	}
@@ -191,6 +187,7 @@ abstract class AbstractAggregationExpression implements AggregationExpression {
 	 * @return
 	 * @since 2.1
 	 */
+	@SuppressWarnings("unchecked")
 	protected boolean contains(Object key) {
 
 		if (!(this.value instanceof java.util.Map)) {

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/aggregation/ProjectionOperationUnitTests.java

@@ -1062,6 +1062,28 @@ public class ProjectionOperationUnitTests {
 				"{ $project: { dayOfYear: { $dayOfYear: { \"date\" : \"$date\", \"timezone\" : \"America/Chicago\" } } } }")));
 	}
 
+	@Test // DATAMONGO-1834
+	public void shouldRenderTimeZoneFromField() {
+
+		DBObject agg = project().and(DateOperators.dateOf("date").withTimezone(Timezone.ofField("tz")).dayOfYear())
+				.as("dayOfYear").toDBObject(Aggregation.DEFAULT_CONTEXT);
+
+		assertThat(agg, is(
+				JSON.parse("{ $project: { dayOfYear: { $dayOfYear: { \"date\" : \"$date\", \"timezone\" : \"$tz\" } } } }")));
+	}
+
+	@Test // DATAMONGO-1834
+	public void shouldRenderTimeZoneFromExpression() {
+
+		DBObject agg = project()
+				.and(DateOperators.dateOf("date")
+						.withTimezone(Timezone.ofExpression(LiteralOperators.valueOf("America/Chicago").asLiteral())).dayOfYear())
+				.as("dayOfYear").toDBObject(Aggregation.DEFAULT_CONTEXT);
+
+		assertThat(agg, is(JSON.parse(
+				"{ $project: { dayOfYear: { $dayOfYear: { \"date\" : \"$date\", \"timezone\" : { $literal: \"America/Chicago\"} } } } }")));
+	}
+
 	@Test // DATAMONGO-1536
 	public void shouldRenderDayOfMonthAggregationExpression() {