Improve exception messages and introduce common base exception type

Author: stefan-ka

src/main/java/io/github/stefanka/protobufgen/exception/FieldAlreadyExistsException.java

@@ -15,10 +15,10 @@
  */
 package io.github.stefanka.protobufgen.exception;
 
-public class FieldAlreadyExistsException extends RuntimeException {
+public class FieldAlreadyExistsException extends ProtocolBufferBuilderException {
 
     public FieldAlreadyExistsException(String fieldName) {
-        super("A field with the name '" + fieldName + "' already exists.");
+        super("A field with the name '" + fieldName + "' already exists. Please ensure that field names are unique.");
     }
 
 }

src/main/java/io/github/stefanka/protobufgen/exception/FieldNumberAlreadyExistsException.java

@@ -15,7 +15,7 @@
  */
 package io.github.stefanka.protobufgen.exception;
 
-public class FieldNumberAlreadyExistsException extends RuntimeException {
+public class FieldNumberAlreadyExistsException extends ProtocolBufferBuilderException {
 
     public FieldNumberAlreadyExistsException(String message, int index) {
         super("The message '" + message + "' already contains a field with the index " + index + ".");

src/main/java/io/github/stefanka/protobufgen/exception/FieldNumberOutOfRangeException.java

@@ -15,7 +15,7 @@
  */
 package io.github.stefanka.protobufgen.exception;
 
-public class FieldNumberOutOfRangeException extends RuntimeException {
+public class FieldNumberOutOfRangeException extends ProtocolBufferBuilderException {
 
     public FieldNumberOutOfRangeException(int number) {
         super("The number " + number + "is out of the supported range (1 - 536'870'911).");

src/main/java/io/github/stefanka/protobufgen/exception/FieldNumberReservedException.java

@@ -15,7 +15,7 @@
  */
 package io.github.stefanka.protobufgen.exception;
 
-public class FieldNumberReservedException extends RuntimeException {
+public class FieldNumberReservedException extends ProtocolBufferBuilderException {
 
     public FieldNumberReservedException() {
         super("Field numbers 19000 through 19999 are reserved for the protocol buffer library implementation.");

src/main/java/io/github/stefanka/protobufgen/exception/FirstEnumFieldZeroValueException.java

@@ -15,7 +15,7 @@
  */
 package io.github.stefanka.protobufgen.exception;
 
-public class FirstEnumFieldZeroValueException extends RuntimeException {
+public class FirstEnumFieldZeroValueException extends ProtocolBufferBuilderException {
 
     public FirstEnumFieldZeroValueException() {
         super("The first enum field must have the value zero (0)!");

src/main/java/io/github/stefanka/protobufgen/exception/NestedMessageAlreadyExistsException.java

@@ -15,10 +15,10 @@
  */
 package io.github.stefanka.protobufgen.exception;
 
-public class NestedMessageAlreadyExistsException extends RuntimeException {
+public class NestedMessageAlreadyExistsException extends ProtocolBufferBuilderException {
 
     public NestedMessageAlreadyExistsException(String name) {
-        super("A nested message with the name '" + name + "' already exists!");
+        super("A nested message with the name '" + name + "' already exists. Please ensure that nested message names are unique.");
     }
 
 }

src/main/java/io/github/stefanka/protobufgen/exception/ProtoSerializationException.java

@@ -15,7 +15,7 @@
  */
 package io.github.stefanka.protobufgen.exception;
 
-public class ProtoSerializationException extends RuntimeException {
+public class ProtoSerializationException extends ProtocolBufferBuilderException {
 
     public ProtoSerializationException(Throwable e) {
         super("The proto file cannot be serialized.", e);

src/main/java/io/github/stefanka/protobufgen/exception/ProtocolBufferBuilderException.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2020 Stefan Kapferer
+ *
+ * Licensed 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 io.github.stefanka.protobufgen.exception;
+
+public class ProtocolBufferBuilderException extends RuntimeException {
+
+    public ProtocolBufferBuilderException(String message) {
+        super(message);
+    }
+
+    public ProtocolBufferBuilderException(String message, Throwable cause) {
+        super(message, cause);
+    }
+
+}

src/main/java/io/github/stefanka/protobufgen/exception/RemoteProcedureCallAlreadyExistsException.java

@@ -15,7 +15,7 @@
  */
 package io.github.stefanka.protobufgen.exception;
 
-public class RemoteProcedureCallAlreadyExistsException extends RuntimeException {
+public class RemoteProcedureCallAlreadyExistsException extends ProtocolBufferBuilderException {
 
     public RemoteProcedureCallAlreadyExistsException(String name) {
         super("An RPC with the name '" + name + "' already exists in your service!");

src/main/java/io/github/stefanka/protobufgen/exception/RootElementAlreadyExistsException.java

@@ -15,10 +15,10 @@
  */
 package io.github.stefanka.protobufgen.exception;
 
-public class RootElementAlreadyExistsException extends RuntimeException {
+public class RootElementAlreadyExistsException extends ProtocolBufferBuilderException {
 
     public RootElementAlreadyExistsException(String name) {
-        super("A root element (message, enum, or service) with the name '" + name + "' already exists in your spec!");
+        super("A root element (message, enum, or service) with the name '" + name + "' already exists in your spec. Please ensure that the names of your messages, enums, and services are unique.");
     }
 
 }