Refactor Argeo API

[gpl/argeo-slc.git] / org.argeo.api.slc / src / org / argeo / api / slc / UnsupportedException.java

diff --git a/org.argeo.api.slc/src/org/argeo/api/slc/UnsupportedException.java b/org.argeo.api.slc/src/org/argeo/api/slc/UnsupportedException.java
new file mode 100644 (file)
index 0000000..3a7c766
--- /dev/null
+++ b/org.argeo.api.slc/src/org/argeo/api/slc/UnsupportedException.java
@@ -0,0 +1,54 @@
+package org.argeo.api.slc;
+
+/** Exception for unsupported features or actions. */
+public class UnsupportedException extends SlcException {
+       static final long serialVersionUID = 1l;
+
+       /** Action not supported. */
+       public UnsupportedException() {
+               this("Action not supported");
+       }
+
+       /** Constructor with a message. */
+       public UnsupportedException(String message) {
+               super(message);
+       }
+
+       /**
+        * Constructor generating a message.
+        * 
+        * @param nature
+        *            the nature of the unsupported object
+        * @param obj
+        *            the object itself (its class name will be used in message)
+        */
+       public UnsupportedException(String nature, Object obj) {
+               super("Unsupported " + nature + ": "
+                               + (obj != null ? obj.getClass() : "[object is null]"));
+       }
+
+       /**
+        * Constructor generating a message.
+        * 
+        * @param nature
+        *            the nature of the unsupported object
+        * @param clss
+        *            the class itself (will be used in message)
+        */
+       public UnsupportedException(String nature, Class<?> clss) {
+               super("Unsupported " + nature + ": " + clss);
+       }
+
+       /**
+        * Constructor generating a message.
+        * 
+        * @param nature
+        *            the nature of the unsupported object
+        * @param value
+        *            the problematic value itself
+        */
+       public UnsupportedException(String nature, String value) {
+               super("Unsupported " + nature + ": " + value);
+       }
+
+}