From fb41002ca5e608664f39601c0d6c8a757943b583 Mon Sep 17 00:00:00 2001
From: Adrian Cole <adrian@jclouds.org>
Date: Wed, 14 Mar 2012 11:03:53 -0700
Subject: [PATCH] utility for determining if a method has an optional
 returntype

---
 .../java/org/jclouds/util/Optionals2.java     | 50 ++++++++++++++
 .../java/org/jclouds/util/Optionals2Test.java | 66 +++++++++++++++++++
 2 files changed, 116 insertions(+)
 create mode 100644 core/src/main/java/org/jclouds/util/Optionals2.java
 create mode 100644 core/src/test/java/org/jclouds/util/Optionals2Test.java

diff --git a/core/src/main/java/org/jclouds/util/Optionals2.java b/core/src/main/java/org/jclouds/util/Optionals2.java
new file mode 100644
index 0000000000..2ec4b1efc8
--- /dev/null
+++ b/core/src/main/java/org/jclouds/util/Optionals2.java
@@ -0,0 +1,50 @@
+/**
+ * Licensed to jclouds, Inc. (jclouds) under one or more
+ * contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  jclouds licenses this file
+ * to you 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 org.jclouds.util;
+
+import java.lang.reflect.Method;
+import java.lang.reflect.ParameterizedType;
+
+import com.google.common.base.Optional;
+
+/**
+ * 
+ * @author Adrian Cole
+ */
+public class Optionals2 {
+
+   public static Class<?> returnTypeOrTypeOfOptional(Method method) {
+      boolean optional = isReturnTypeOptional(method);
+      Class<?> syncClass;
+      if (optional) {
+         ParameterizedType futureType = ParameterizedType.class.cast(method.getGenericReturnType());
+         // TODO: error checking in case this is a type, not a class.
+         syncClass = Class.class.cast(futureType.getActualTypeArguments()[0]);
+      } else {
+         syncClass = method.getReturnType();
+      }
+      return syncClass;
+   }
+
+   public static boolean isReturnTypeOptional(Method method) {
+      boolean optional = method.getReturnType().isAssignableFrom(Optional.class);
+      return optional;
+   }
+
+}
diff --git a/core/src/test/java/org/jclouds/util/Optionals2Test.java b/core/src/test/java/org/jclouds/util/Optionals2Test.java
new file mode 100644
index 0000000000..9a2ffbddc6
--- /dev/null
+++ b/core/src/test/java/org/jclouds/util/Optionals2Test.java
@@ -0,0 +1,66 @@
+/**
+ * Licensed to jclouds, Inc. (jclouds) under one or more
+ * contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  jclouds licenses this file
+ * to you 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 org.jclouds.util;
+
+import static org.testng.Assert.assertEquals;
+import static org.testng.Assert.assertFalse;
+import static org.testng.Assert.assertTrue;
+
+import java.lang.reflect.Method;
+
+import org.testng.annotations.Test;
+
+import com.google.common.base.Optional;
+
+/**
+ * @author Adrian Cole
+ */
+@Test
+public class Optionals2Test {
+
+   public static interface Test {
+      Optional<String> getOptional();
+
+      String getNotOptional();
+   }
+
+   public void testReturnTypeOrTypeOfOptionalWhenOptional() throws SecurityException, NoSuchMethodException {
+      Method method = Test.class.getMethod("getOptional");
+
+      assertEquals(Optionals2.returnTypeOrTypeOfOptional(method), String.class);
+   }
+
+   public void testReturnTypeOrTypeOfOptionalWhenNotOptional() throws SecurityException, NoSuchMethodException {
+      Method method = Test.class.getMethod("getNotOptional");
+
+      assertEquals(Optionals2.returnTypeOrTypeOfOptional(method), String.class);
+   }
+
+   public void testIsReturnTypeOptionalWhenOptional() throws SecurityException, NoSuchMethodException {
+      Method method = Test.class.getMethod("getOptional");
+
+      assertTrue(Optionals2.isReturnTypeOptional(method));
+   }
+
+   public void testIsReturnTypeOptionalWhenNotOptional() throws SecurityException, NoSuchMethodException {
+      Method method = Test.class.getMethod("getNotOptional");
+
+      assertFalse(Optionals2.isReturnTypeOptional(method));
+   }
+}