Deprecate common.util.Arguments for removal
[controller.git] / opendaylight / md-sal / sal-common-util / src / main / java / org / opendaylight / controller / sal / common / util / Arguments.java
index 2d10fba8a5fd77c18b872991669d576f9aae7a7e..6d8081edb6415a92f3bf898ea14245d74b6f9c9e 100644 (file)
@@ -1,23 +1,32 @@
+/*
+ * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
 package org.opendaylight.controller.sal.common.util;
 
-public class Arguments {
-
+@Deprecated(forRemoval = true)
+public final class Arguments {
     private Arguments() {
         throw new UnsupportedOperationException("Utility class");
     }
-    
+
     /**
-     * Checks if value is instance of provided class
-     * 
-     * 
+     * Checks if value is instance of provided class.
+     *
      * @param value Value to check
      * @param type Type to check
      * @return Reference which was checked
+     * @deprecated This utility is not used in this project, please brew your own or
+     *             use {@code Preconditions.checkArgument()}.
      */
-    @SuppressWarnings("unchecked")
-    public static <T> T checkInstanceOf(Object value, Class<T> type) {
-        if(!type.isInstance(value))
-            throw new IllegalArgumentException();
-        return (T) value;
+    @Deprecated(forRemoval = true)
+    public static <T> T checkInstanceOf(final Object value, final Class<T> type) {
+        if (!type.isInstance(value)) {
+            throw new IllegalArgumentException(String.format("Value %s is not of type %s", value, type));
+        }
+        return type.cast(value);
     }
 }