|
| 1 | +/* |
| 2 | + * Copyright 2015 Krzysztof Suszyński <[email protected]>. |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | +package pl.wavesoftware.eid.exceptions; |
| 17 | + |
| 18 | +import java.io.Serializable; |
| 19 | +import static java.lang.Math.abs; |
| 20 | +import java.util.ArrayList; |
| 21 | +import java.util.List; |
| 22 | +import java.util.Random; |
| 23 | +import javax.annotation.Nullable; |
| 24 | + |
| 25 | +/** |
| 26 | + * <strong>This class shouldn't be used in any public API or library.</strong> It is designed to be used for in-house development |
| 27 | + * of end user applications which will report Bugs in standarized error pages or post them to issue tracker. |
| 28 | + * <p> |
| 29 | + * Exception identifier for all Eid Runtime Exceptions. |
| 30 | + * |
| 31 | + * @author Krzysztof Suszyński <[email protected]> |
| 32 | + */ |
| 33 | +public class Eid implements Serializable { |
| 34 | + |
| 35 | + public static final String DEFAULT_FORMAT = "[%s]<%s>"; |
| 36 | + |
| 37 | + public static final String DEFAULT_REF_FORMAT = "[%s|%s]<%s>"; |
| 38 | + |
| 39 | + private static final long serialVersionUID = -9876432123423401L; |
| 40 | + |
| 41 | + private static final Random RANDOM = new Random(System.currentTimeMillis()); |
| 42 | + |
| 43 | + private static String format = DEFAULT_FORMAT; |
| 44 | + |
| 45 | + private static String refFormat = DEFAULT_REF_FORMAT; |
| 46 | + |
| 47 | + private final String id; |
| 48 | + |
| 49 | + private final String ref; |
| 50 | + |
| 51 | + private final String uniq; |
| 52 | + |
| 53 | + /** |
| 54 | + * Sets the actual format that will be used in {@link toString()} method. It will return previously used format. |
| 55 | + * |
| 56 | + * @param format a format compliant with {@link String#format(String, Object...)} with 2 object arguments |
| 57 | + * @return a previously used format |
| 58 | + * @throws NullPointerException if given format was null |
| 59 | + * @throws IllegalArgumentException if given format hasn't got two format specifiers <tt>"%s"</tt> |
| 60 | + */ |
| 61 | + public static String setFormat(String format) throws NullPointerException, IllegalArgumentException { |
| 62 | + validateFormat(format, 2); |
| 63 | + String prevoiusly = Eid.format; |
| 64 | + Eid.format = format; |
| 65 | + return prevoiusly; |
| 66 | + } |
| 67 | + |
| 68 | + /** |
| 69 | + * Sets the actual format that will be used in {@link toString()} method |
| 70 | + * |
| 71 | + * @param refFormat a format compliant with {@link String#format(String, Object...)} with 3 object arguments |
| 72 | + * @return a previously used format |
| 73 | + * @throws NullPointerException if given format was null |
| 74 | + * @throws IllegalArgumentException if given format hasn't got tree format specifiers <tt>"%s"</tt> |
| 75 | + */ |
| 76 | + public static String setRefFormat(String refFormat) { |
| 77 | + validateFormat(refFormat, 3); |
| 78 | + String prevoiusly = Eid.refFormat; |
| 79 | + Eid.refFormat = refFormat; |
| 80 | + return prevoiusly; |
| 81 | + } |
| 82 | + |
| 83 | + /** |
| 84 | + * Constructor |
| 85 | + * |
| 86 | + * @param id the exception id, must be unique developer insereted string, from date |
| 87 | + * @param ref an optional reference |
| 88 | + */ |
| 89 | + public Eid(String id, @Nullable String ref) { |
| 90 | + uniq = Integer.toString(abs(Long.valueOf(abs(RANDOM.nextLong()) + abs(RANDOM.nextInt())).intValue()), 36); |
| 91 | + this.id = id; |
| 92 | + this.ref = ref == null ? "" : ref; |
| 93 | + } |
| 94 | + |
| 95 | + /** |
| 96 | + * Constructor |
| 97 | + * |
| 98 | + * @param id the exception id, must be unique developer insereted string, from date |
| 99 | + */ |
| 100 | + public Eid(String id) { |
| 101 | + this(id, null); |
| 102 | + } |
| 103 | + |
| 104 | + @Override |
| 105 | + public String toString() { |
| 106 | + if ("".equals(ref)) { |
| 107 | + return String.format(format, id, uniq); |
| 108 | + } |
| 109 | + return String.format(refFormat, id, ref, uniq); |
| 110 | + } |
| 111 | + |
| 112 | + /** |
| 113 | + * Getter for constant Exception ID |
| 114 | + * |
| 115 | + * @return ID of exception |
| 116 | + */ |
| 117 | + public String getId() { |
| 118 | + return id; |
| 119 | + } |
| 120 | + |
| 121 | + /** |
| 122 | + * Get custom ref passed to Exception ID |
| 123 | + * |
| 124 | + * @return ID of exception |
| 125 | + */ |
| 126 | + public String getRef() { |
| 127 | + return ref; |
| 128 | + } |
| 129 | + |
| 130 | + /** |
| 131 | + * Gets uniq generated string for this instance of Eid |
| 132 | + * |
| 133 | + * @return a uniq string |
| 134 | + */ |
| 135 | + public String getUniq() { |
| 136 | + return uniq; |
| 137 | + } |
| 138 | + |
| 139 | + static void validateFormat(String format, int numSpecifiers) throws NullPointerException, IllegalArgumentException { |
| 140 | + if (format == null) { |
| 141 | + throw new NullPointerException("Format can't be null, but just recieved one"); |
| 142 | + } |
| 143 | + List<String> specifiers = new ArrayList<String>(); |
| 144 | + for (int i = 0; i < numSpecifiers; i++) { |
| 145 | + specifiers.add(i + Integer.toString(abs(RANDOM.nextInt()), 36)); |
| 146 | + } |
| 147 | + String formated = String.format(format, specifiers.toArray()); |
| 148 | + for (String specifier : specifiers) { |
| 149 | + if (!formated.contains(specifier)) { |
| 150 | + throw new IllegalArgumentException("Given format contains to little format specifiers, " |
| 151 | + + "expected " + numSpecifiers + " but given \"" + format + "\""); |
| 152 | + } |
| 153 | + } |
| 154 | + } |
| 155 | + |
| 156 | +} |
0 commit comments