Repository: cayenne Updated Branches: refs/heads/master 553de2669 -> 23dc84b66
CAY-2487 Removed usage of CayenneException. CayenneException marked as deprecated. Project: http://git-wip-us.apache.org/repos/asf/cayenne/repo Commit: http://git-wip-us.apache.org/repos/asf/cayenne/commit/52df4e18 Tree: http://git-wip-us.apache.org/repos/asf/cayenne/tree/52df4e18 Diff: http://git-wip-us.apache.org/repos/asf/cayenne/diff/52df4e18 Branch: refs/heads/master Commit: 52df4e18424965ed4947765be88461b560b2ea52 Parents: 20b166a Author: kkomyak <const1...@gmail.com> Authored: Mon Oct 15 15:13:33 2018 +0300 Committer: kkomyak <const1...@gmail.com> Committed: Mon Oct 15 15:13:33 2018 +0300 ---------------------------------------------------------------------- .../org/apache/cayenne/CayenneException.java | 7 +++++++ .../apache/cayenne/CayenneRuntimeException.java | 18 ++++++++++++++++-- .../apache/cayenne/access/jdbc/BatchAction.java | 6 +++--- .../cayenne/access/jdbc/SQLTemplateAction.java | 4 ++-- .../cayenne/access/types/ByteArrayType.java | 4 ++-- .../apache/cayenne/access/types/CharType.java | 4 ++-- .../access/util/IteratedSelectObserver.java | 1 - .../dba/oracle/Oracle8LOBBatchAction.java | 3 +-- .../cayenne/dba/oracle/OracleBatchAction.java | 4 ++-- .../apache/cayenne/CayenneExceptionTest.java | 20 ++++++++++---------- .../cayenne/CayenneRuntimeExceptionTest.java | 12 ++++++------ .../org/apache/cayenne/ConfigExceptionTest.java | 8 ++++---- .../java/org/apache/cayenne/util/UtilTest.java | 6 +++--- 13 files changed, 58 insertions(+), 39 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cayenne/blob/52df4e18/cayenne-server/src/main/java/org/apache/cayenne/CayenneException.java ---------------------------------------------------------------------- diff --git a/cayenne-server/src/main/java/org/apache/cayenne/CayenneException.java b/cayenne-server/src/main/java/org/apache/cayenne/CayenneException.java index 0026a4c..e951da1 100644 --- a/cayenne-server/src/main/java/org/apache/cayenne/CayenneException.java +++ b/cayenne-server/src/main/java/org/apache/cayenne/CayenneException.java @@ -23,9 +23,12 @@ import org.apache.cayenne.util.LocalizedStringsHandler; /** + * @deprecated please @since 4.1 use {@link CayenneRuntimeException} + * * A generic checked exception that may be thrown by Cayenne framework. All checked * exceptions in Cayenne inherit from this class. */ +@Deprecated public class CayenneException extends Exception { private static String exceptionLabel; @@ -36,6 +39,10 @@ public class CayenneException extends Exception { exceptionLabel = "[v." + version + " " + date + "] "; } + /** + * @deprecated please @since 4.1 use {@link CayenneRuntimeException#getExceptionLabel()} + */ + @Deprecated public static String getExceptionLabel() { return exceptionLabel; } http://git-wip-us.apache.org/repos/asf/cayenne/blob/52df4e18/cayenne-server/src/main/java/org/apache/cayenne/CayenneRuntimeException.java ---------------------------------------------------------------------- diff --git a/cayenne-server/src/main/java/org/apache/cayenne/CayenneRuntimeException.java b/cayenne-server/src/main/java/org/apache/cayenne/CayenneRuntimeException.java index 135b50c..1d06614 100644 --- a/cayenne-server/src/main/java/org/apache/cayenne/CayenneRuntimeException.java +++ b/cayenne-server/src/main/java/org/apache/cayenne/CayenneRuntimeException.java @@ -19,12 +19,26 @@ package org.apache.cayenne; +import org.apache.cayenne.util.LocalizedStringsHandler; + /** * A generic unchecked exception that may be thrown by Cayenne framework. All runtime * exceptions in Cayenne inherit from this class. */ public class CayenneRuntimeException extends RuntimeException { + private static String exceptionLabel; + + static { + String version = LocalizedStringsHandler.getString("cayenne.version"); + String date = LocalizedStringsHandler.getString("cayenne.build.date"); + exceptionLabel = "[v." + version + " " + date + "] "; + } + + public static String getExceptionLabel() { + return exceptionLabel; + } + /** * Creates new CayenneRuntimeException without detail message. */ @@ -74,7 +88,7 @@ public class CayenneRuntimeException extends RuntimeException { public String getMessage() { String message = super.getMessage(); return (message != null) - ? CayenneException.getExceptionLabel() + message - : CayenneException.getExceptionLabel() + "(no message)"; + ? exceptionLabel + message + : exceptionLabel + "(no message)"; } } http://git-wip-us.apache.org/repos/asf/cayenne/blob/52df4e18/cayenne-server/src/main/java/org/apache/cayenne/access/jdbc/BatchAction.java ---------------------------------------------------------------------- diff --git a/cayenne-server/src/main/java/org/apache/cayenne/access/jdbc/BatchAction.java b/cayenne-server/src/main/java/org/apache/cayenne/access/jdbc/BatchAction.java index 90f5219..132c6be 100644 --- a/cayenne-server/src/main/java/org/apache/cayenne/access/jdbc/BatchAction.java +++ b/cayenne-server/src/main/java/org/apache/cayenne/access/jdbc/BatchAction.java @@ -19,7 +19,7 @@ package org.apache.cayenne.access.jdbc; -import org.apache.cayenne.CayenneException; +import org.apache.cayenne.CayenneRuntimeException; import org.apache.cayenne.ResultIterator; import org.apache.cayenne.access.DataNode; import org.apache.cayenne.access.OperationObserver; @@ -88,7 +88,7 @@ public class BatchAction extends BaseSQLAction { } } - protected BatchTranslator createTranslator() throws CayenneException { + protected BatchTranslator createTranslator() throws CayenneRuntimeException { return dataNode.batchTranslator(query, null); } @@ -219,7 +219,7 @@ public class BatchAction extends BaseSQLAction { */ @SuppressWarnings({ "rawtypes", "unchecked" }) protected void processGeneratedKeys(Statement statement, OperationObserver observer, BatchQueryRow row) - throws SQLException, CayenneException { + throws SQLException, CayenneRuntimeException { ResultSet keysRS = statement.getGeneratedKeys(); http://git-wip-us.apache.org/repos/asf/cayenne/blob/52df4e18/cayenne-server/src/main/java/org/apache/cayenne/access/jdbc/SQLTemplateAction.java ---------------------------------------------------------------------- diff --git a/cayenne-server/src/main/java/org/apache/cayenne/access/jdbc/SQLTemplateAction.java b/cayenne-server/src/main/java/org/apache/cayenne/access/jdbc/SQLTemplateAction.java index 51b3934..edfff38 100644 --- a/cayenne-server/src/main/java/org/apache/cayenne/access/jdbc/SQLTemplateAction.java +++ b/cayenne-server/src/main/java/org/apache/cayenne/access/jdbc/SQLTemplateAction.java @@ -19,7 +19,7 @@ package org.apache.cayenne.access.jdbc; -import org.apache.cayenne.CayenneException; +import org.apache.cayenne.CayenneRuntimeException; import org.apache.cayenne.ResultIterator; import org.apache.cayenne.access.DataNode; import org.apache.cayenne.access.OperationObserver; @@ -96,7 +96,7 @@ public class SQLTemplateAction implements SQLAction { // sanity check - misconfigured templates if (template == null) { - throw new CayenneException("No template string configured for adapter " + dbAdapter.getClass().getName()); + throw new CayenneRuntimeException("No template string configured for adapter " + dbAdapter.getClass().getName()); } boolean loggable = dataNode.getJdbcEventLogger().isLoggable(); http://git-wip-us.apache.org/repos/asf/cayenne/blob/52df4e18/cayenne-server/src/main/java/org/apache/cayenne/access/types/ByteArrayType.java ---------------------------------------------------------------------- diff --git a/cayenne-server/src/main/java/org/apache/cayenne/access/types/ByteArrayType.java b/cayenne-server/src/main/java/org/apache/cayenne/access/types/ByteArrayType.java index ed77148..1197673 100644 --- a/cayenne-server/src/main/java/org/apache/cayenne/access/types/ByteArrayType.java +++ b/cayenne-server/src/main/java/org/apache/cayenne/access/types/ByteArrayType.java @@ -19,7 +19,7 @@ package org.apache.cayenne.access.types; -import org.apache.cayenne.CayenneException; +import org.apache.cayenne.CayenneRuntimeException; import org.apache.cayenne.util.IDUtil; import org.apache.cayenne.util.MemoryBlob; @@ -123,7 +123,7 @@ public class ByteArrayType implements ExtendedType<byte[]> { if (type == Types.BLOB) { if (!isUsingBlobs()) { - throw new CayenneException("Binary streams are not supported in stored procedure parameters."); + throw new CayenneRuntimeException("Binary streams are not supported in stored procedure parameters."); } bytes = readBlob(cs.getBlob(index)); } else { http://git-wip-us.apache.org/repos/asf/cayenne/blob/52df4e18/cayenne-server/src/main/java/org/apache/cayenne/access/types/CharType.java ---------------------------------------------------------------------- diff --git a/cayenne-server/src/main/java/org/apache/cayenne/access/types/CharType.java b/cayenne-server/src/main/java/org/apache/cayenne/access/types/CharType.java index cf807a9..f82203a 100644 --- a/cayenne-server/src/main/java/org/apache/cayenne/access/types/CharType.java +++ b/cayenne-server/src/main/java/org/apache/cayenne/access/types/CharType.java @@ -19,7 +19,7 @@ package org.apache.cayenne.access.types; -import org.apache.cayenne.CayenneException; +import org.apache.cayenne.CayenneRuntimeException; import java.io.IOException; import java.io.Reader; @@ -72,7 +72,7 @@ public class CharType implements ExtendedType<String> { if (type == Types.CLOB || type == Types.NCLOB) { if (!isUsingClobs()) { - throw new CayenneException("Character streams are not supported in stored procedure parameters."); + throw new CayenneRuntimeException("Character streams are not supported in stored procedure parameters."); } return readClob(cs.getClob(index)); http://git-wip-us.apache.org/repos/asf/cayenne/blob/52df4e18/cayenne-server/src/main/java/org/apache/cayenne/access/util/IteratedSelectObserver.java ---------------------------------------------------------------------- diff --git a/cayenne-server/src/main/java/org/apache/cayenne/access/util/IteratedSelectObserver.java b/cayenne-server/src/main/java/org/apache/cayenne/access/util/IteratedSelectObserver.java index 4b1a313..09540f1 100644 --- a/cayenne-server/src/main/java/org/apache/cayenne/access/util/IteratedSelectObserver.java +++ b/cayenne-server/src/main/java/org/apache/cayenne/access/util/IteratedSelectObserver.java @@ -24,7 +24,6 @@ import java.io.PrintWriter; import java.io.StringWriter; import java.util.List; -import org.apache.cayenne.CayenneException; import org.apache.cayenne.CayenneRuntimeException; import org.apache.cayenne.ResultIterator; import org.apache.cayenne.query.Query; http://git-wip-us.apache.org/repos/asf/cayenne/blob/52df4e18/cayenne-server/src/main/java/org/apache/cayenne/dba/oracle/Oracle8LOBBatchAction.java ---------------------------------------------------------------------- diff --git a/cayenne-server/src/main/java/org/apache/cayenne/dba/oracle/Oracle8LOBBatchAction.java b/cayenne-server/src/main/java/org/apache/cayenne/dba/oracle/Oracle8LOBBatchAction.java index 184793e..7a0df48 100644 --- a/cayenne-server/src/main/java/org/apache/cayenne/dba/oracle/Oracle8LOBBatchAction.java +++ b/cayenne-server/src/main/java/org/apache/cayenne/dba/oracle/Oracle8LOBBatchAction.java @@ -31,7 +31,6 @@ import java.sql.SQLException; import java.sql.Types; import java.util.List; -import org.apache.cayenne.CayenneException; import org.apache.cayenne.CayenneRuntimeException; import org.apache.cayenne.access.OperationObserver; import org.apache.cayenne.access.translator.DbAttributeBinding; @@ -81,7 +80,7 @@ class Oracle8LOBBatchAction implements SQLAction { translator = new Oracle8LOBUpdateBatchTranslator((UpdateBatchQuery) query, adapter, OracleAdapter.TRIM_FUNCTION); } else { - throw new CayenneException("Unsupported batch type for special LOB processing: " + query); + throw new CayenneRuntimeException("Unsupported batch type for special LOB processing: " + query); } translator.setNewBlobFunction(OracleAdapter.NEW_BLOB_FUNCTION); http://git-wip-us.apache.org/repos/asf/cayenne/blob/52df4e18/cayenne-server/src/main/java/org/apache/cayenne/dba/oracle/OracleBatchAction.java ---------------------------------------------------------------------- diff --git a/cayenne-server/src/main/java/org/apache/cayenne/dba/oracle/OracleBatchAction.java b/cayenne-server/src/main/java/org/apache/cayenne/dba/oracle/OracleBatchAction.java index 72aebbf..b55f960 100644 --- a/cayenne-server/src/main/java/org/apache/cayenne/dba/oracle/OracleBatchAction.java +++ b/cayenne-server/src/main/java/org/apache/cayenne/dba/oracle/OracleBatchAction.java @@ -19,7 +19,7 @@ package org.apache.cayenne.dba.oracle; -import org.apache.cayenne.CayenneException; +import org.apache.cayenne.CayenneRuntimeException; import org.apache.cayenne.access.DataNode; import org.apache.cayenne.access.jdbc.BatchAction; import org.apache.cayenne.access.translator.batch.BatchTranslator; @@ -38,7 +38,7 @@ class OracleBatchAction extends BatchAction { } @Override - protected BatchTranslator createTranslator() throws CayenneException { + protected BatchTranslator createTranslator() throws CayenneRuntimeException { return dataNode.batchTranslator(query, OracleAdapter.TRIM_FUNCTION); } } http://git-wip-us.apache.org/repos/asf/cayenne/blob/52df4e18/cayenne-server/src/test/java/org/apache/cayenne/CayenneExceptionTest.java ---------------------------------------------------------------------- diff --git a/cayenne-server/src/test/java/org/apache/cayenne/CayenneExceptionTest.java b/cayenne-server/src/test/java/org/apache/cayenne/CayenneExceptionTest.java index 9fac950..4772faa 100644 --- a/cayenne-server/src/test/java/org/apache/cayenne/CayenneExceptionTest.java +++ b/cayenne-server/src/test/java/org/apache/cayenne/CayenneExceptionTest.java @@ -30,45 +30,45 @@ public class CayenneExceptionTest { @Test public void testConstructor1() throws Exception { - CayenneException ex = new CayenneException(); + CayenneRuntimeException ex = new CayenneRuntimeException(); assertNull(ex.getCause()); - assertTrue(ex.getMessage().startsWith(CayenneException.getExceptionLabel())); + assertTrue(ex.getMessage().startsWith(CayenneRuntimeException.getExceptionLabel())); } @Test public void testConstructor2() throws Exception { - CayenneException ex = new CayenneException("abc"); + CayenneRuntimeException ex = new CayenneRuntimeException("abc"); assertNull(ex.getCause()); - assertEquals(CayenneException.getExceptionLabel() + "abc", ex.getMessage()); + assertEquals(CayenneRuntimeException.getExceptionLabel() + "abc", ex.getMessage()); } @Test public void testConstructor3() throws Exception { Throwable cause = new Throwable(); - CayenneException ex = new CayenneException(cause); + CayenneRuntimeException ex = new CayenneRuntimeException(cause); assertSame(cause, ex.getCause()); - assertEquals(CayenneException.getExceptionLabel() + cause.toString(), ex + assertEquals(CayenneRuntimeException.getExceptionLabel() + cause.toString(), ex .getMessage()); } @Test public void testConstructor4() throws Exception { Throwable cause = new Throwable(); - CayenneException ex = new CayenneException("abc", cause); + CayenneRuntimeException ex = new CayenneRuntimeException("abc", cause); assertSame(cause, ex.getCause()); - assertEquals(CayenneException.getExceptionLabel() + "abc", ex.getMessage()); + assertEquals(CayenneRuntimeException.getExceptionLabel() + "abc", ex.getMessage()); } @Test public void testMessageFormatting1() throws Exception { - CayenneException ex = new CayenneException("x%sx%sx", "a", "b"); + CayenneRuntimeException ex = new CayenneRuntimeException("x%sx%sx", "a", "b"); assertEquals("xaxbx", ex.getUnlabeledMessage()); } @Test public void testMessageFormatting2() throws Exception { Throwable cause = new Throwable(); - CayenneException ex = new CayenneException("x%sx%sx", cause, "a", "b"); + CayenneRuntimeException ex = new CayenneRuntimeException("x%sx%sx", cause, "a", "b"); assertEquals("xaxbx", ex.getUnlabeledMessage()); } } http://git-wip-us.apache.org/repos/asf/cayenne/blob/52df4e18/cayenne-server/src/test/java/org/apache/cayenne/CayenneRuntimeExceptionTest.java ---------------------------------------------------------------------- diff --git a/cayenne-server/src/test/java/org/apache/cayenne/CayenneRuntimeExceptionTest.java b/cayenne-server/src/test/java/org/apache/cayenne/CayenneRuntimeExceptionTest.java index 0e60ecf..f24a927 100644 --- a/cayenne-server/src/test/java/org/apache/cayenne/CayenneRuntimeExceptionTest.java +++ b/cayenne-server/src/test/java/org/apache/cayenne/CayenneRuntimeExceptionTest.java @@ -35,14 +35,14 @@ public class CayenneRuntimeExceptionTest { public void testConstructor1() { CayenneRuntimeException ex = new CayenneRuntimeException(); assertNull(ex.getCause()); - assertTrue(ex.getMessage().startsWith(CayenneException.getExceptionLabel())); + assertTrue(ex.getMessage().startsWith(CayenneRuntimeException.getExceptionLabel())); } @Test public void testConstructor2() { CayenneRuntimeException ex = new CayenneRuntimeException("abc"); assertNull(ex.getCause()); - assertEquals(CayenneException.getExceptionLabel() + "abc", ex.getMessage()); + assertEquals(CayenneRuntimeException.getExceptionLabel() + "abc", ex.getMessage()); } @Test @@ -51,7 +51,7 @@ public class CayenneRuntimeExceptionTest { CayenneRuntimeException ex = new CayenneRuntimeException(cause); assertSame(cause, ex.getCause()); assertEquals( - CayenneException.getExceptionLabel() + cause.toString(), + CayenneRuntimeException.getExceptionLabel() + cause.toString(), ex.getMessage()); } @@ -60,7 +60,7 @@ public class CayenneRuntimeExceptionTest { Throwable cause = new Throwable(); CayenneRuntimeException ex = new CayenneRuntimeException("abc", cause); assertSame(cause, ex.getCause()); - assertEquals(CayenneException.getExceptionLabel() + "abc", ex.getMessage()); + assertEquals(CayenneRuntimeException.getExceptionLabel() + "abc", ex.getMessage()); } @Test @@ -69,12 +69,12 @@ public class CayenneRuntimeExceptionTest { CayenneRuntimeException ex = new CayenneRuntimeException(null, cause); assertSame(cause, ex.getCause()); - assertEquals(CayenneException.getExceptionLabel() + "(no message)", ex.getMessage()); + assertEquals(CayenneRuntimeException.getExceptionLabel() + "(no message)", ex.getMessage()); assertNull(ex.getUnlabeledMessage()); CayenneRuntimeException ex2 = new CayenneRuntimeException((String)null); assertNull(ex2.getCause()); - assertEquals(CayenneException.getExceptionLabel() + "(no message)", ex2.getMessage()); + assertEquals(CayenneRuntimeException.getExceptionLabel() + "(no message)", ex2.getMessage()); assertNull(ex2.getUnlabeledMessage()); } http://git-wip-us.apache.org/repos/asf/cayenne/blob/52df4e18/cayenne-server/src/test/java/org/apache/cayenne/ConfigExceptionTest.java ---------------------------------------------------------------------- diff --git a/cayenne-server/src/test/java/org/apache/cayenne/ConfigExceptionTest.java b/cayenne-server/src/test/java/org/apache/cayenne/ConfigExceptionTest.java index c4bfd90..a7b29f0 100644 --- a/cayenne-server/src/test/java/org/apache/cayenne/ConfigExceptionTest.java +++ b/cayenne-server/src/test/java/org/apache/cayenne/ConfigExceptionTest.java @@ -34,14 +34,14 @@ public class ConfigExceptionTest { public void testConstructor1() throws Exception { ConfigurationException ex = new ConfigurationException(); assertNull(ex.getCause()); - assertTrue(ex.getMessage().startsWith(CayenneException.getExceptionLabel())); + assertTrue(ex.getMessage().startsWith(CayenneRuntimeException.getExceptionLabel())); } @Test public void testConstructor2() throws Exception { ConfigurationException ex = new ConfigurationException("abc"); assertNull(ex.getCause()); - assertEquals(CayenneException.getExceptionLabel() + "abc", ex.getMessage()); + assertEquals(CayenneRuntimeException.getExceptionLabel() + "abc", ex.getMessage()); } @Test @@ -50,7 +50,7 @@ public class ConfigExceptionTest { ConfigurationException ex = new ConfigurationException(cause); assertSame(cause, ex.getCause()); assertEquals( - CayenneException.getExceptionLabel() + cause.toString(), + CayenneRuntimeException.getExceptionLabel() + cause.toString(), ex.getMessage()); } @@ -59,6 +59,6 @@ public class ConfigExceptionTest { Throwable cause = new Throwable(); ConfigurationException ex = new ConfigurationException("abc", cause); assertSame(cause, ex.getCause()); - assertEquals(CayenneException.getExceptionLabel() + "abc", ex.getMessage()); + assertEquals(CayenneRuntimeException.getExceptionLabel() + "abc", ex.getMessage()); } } http://git-wip-us.apache.org/repos/asf/cayenne/blob/52df4e18/cayenne-server/src/test/java/org/apache/cayenne/util/UtilTest.java ---------------------------------------------------------------------- diff --git a/cayenne-server/src/test/java/org/apache/cayenne/util/UtilTest.java b/cayenne-server/src/test/java/org/apache/cayenne/util/UtilTest.java index 8d9c563..a05a4b7 100644 --- a/cayenne-server/src/test/java/org/apache/cayenne/util/UtilTest.java +++ b/cayenne-server/src/test/java/org/apache/cayenne/util/UtilTest.java @@ -19,7 +19,7 @@ package org.apache.cayenne.util; -import org.apache.cayenne.CayenneException; +import org.apache.cayenne.CayenneRuntimeException; import org.junit.After; import org.junit.Before; import org.junit.Test; @@ -267,14 +267,14 @@ public class UtilTest { @Test public void testUnwindException2() throws Exception { - CayenneException e = new CayenneException(); + CayenneRuntimeException e = new CayenneRuntimeException(); assertSame(e, Util.unwindException(e)); } @Test public void testUnwindException3() throws Exception { Throwable root = new Throwable(); - CayenneException e = new CayenneException(root); + CayenneRuntimeException e = new CayenneRuntimeException(root); assertSame(root, Util.unwindException(e)); }
