| 1 | // SECTION-START[License Header] |
| 2 | // <editor-fold defaultstate="collapsed" desc=" Generated License "> |
| 3 | /* |
| 4 | * Copyright (c) 2010 The JOMC Project |
| 5 | * Copyright (c) 2005 Christian Schulte <schulte2005@users.sourceforge.net> |
| 6 | * All rights reserved. |
| 7 | * |
| 8 | * Redistribution and use in source and binary forms, with or without |
| 9 | * modification, are permitted provided that the following conditions |
| 10 | * are met: |
| 11 | * |
| 12 | * o Redistributions of source code must retain the above copyright |
| 13 | * notice, this list of conditions and the following disclaimer. |
| 14 | * |
| 15 | * o Redistributions in binary form must reproduce the above copyright |
| 16 | * notice, this list of conditions and the following disclaimer in |
| 17 | * the documentation and/or other materials provided with the |
| 18 | * distribution. |
| 19 | * |
| 20 | * THIS SOFTWARE IS PROVIDED BY THE JOMC PROJECT AND CONTRIBUTORS "AS IS" |
| 21 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, |
| 22 | * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
| 23 | * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE JOMC PROJECT OR |
| 24 | * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
| 25 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
| 26 | * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; |
| 27 | * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, |
| 28 | * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR |
| 29 | * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF |
| 30 | * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 31 | * |
| 32 | * $Id: SequenceLimitException.java 2244 2010-06-29 07:58:09Z schulte2005 $ |
| 33 | * |
| 34 | */ |
| 35 | // </editor-fold> |
| 36 | // SECTION-END |
| 37 | package org.jomc.sequences; |
| 38 | |
| 39 | // SECTION-START[Documentation] |
| 40 | // <editor-fold defaultstate="collapsed" desc=" Generated Documentation "> |
| 41 | /** |
| 42 | * Gets thrown whenever the next value of a sequence is requested although its maximum value has already been reached. |
| 43 | * <p><b>Dependencies</b><ul> |
| 44 | * <li>"{@link #getLocale Locale}"<blockquote> |
| 45 | * Dependency on {@code 'java.util.Locale'} {@code (java.util.Locale)} at specification level 1.1 bound to an instance.</blockquote></li> |
| 46 | * </ul></p> |
| 47 | * <p><b>Messages</b><ul> |
| 48 | * <li>"{@link #getSequenceLimitMessage sequenceLimitMessage}"<table> |
| 49 | * <tr><td valign="top">English:</td><td valign="top"><pre>The maximum sequence value {0,number} has been reached. No more sequence values available.</pre></td></tr> |
| 50 | * <tr><td valign="top">Deutsch:</td><td valign="top"><pre>Der Maximalwert {0,number} der Sequenz wurde erreicht. Keine weiteren Sequenz-Werte verfügbar.</pre></td></tr> |
| 51 | * </table> |
| 52 | * </ul></p> |
| 53 | * |
| 54 | * @author <a href="mailto:schulte2005@users.sourceforge.net">Christian Schulte</a> 1.0 |
| 55 | * @version $Id: SequenceLimitException.java 2244 2010-06-29 07:58:09Z schulte2005 $ |
| 56 | */ |
| 57 | // </editor-fold> |
| 58 | // SECTION-END |
| 59 | // SECTION-START[Annotations] |
| 60 | // <editor-fold defaultstate="collapsed" desc=" Generated Annotations "> |
| 61 | @javax.annotation.Generated( value = "org.jomc.tools.SourceFileProcessor 1.0", comments = "See http://jomc.sourceforge.net/jomc/1.0/jomc-tools" ) |
| 62 | // </editor-fold> |
| 63 | // SECTION-END |
| 64 | public class SequenceLimitException extends SequencesException |
| 65 | { |
| 66 | // SECTION-START[SequenceLimitException] |
| 67 | |
| 68 | /** Serial version UID for backwards compatibility with 1.0.x classes. */ |
| 69 | private static final long serialVersionUID = 4150038054934683080L; |
| 70 | |
| 71 | /** |
| 72 | * Current value of the sequence. |
| 73 | * @serial |
| 74 | */ |
| 75 | private final long currentValue; |
| 76 | |
| 77 | /** |
| 78 | * Creates a new {@code SequenceLimitException} taking the current value of the sequence. |
| 79 | * |
| 80 | * @param currentValue The current value of the sequence reaching its limit. |
| 81 | */ |
| 82 | public SequenceLimitException( final long currentValue ) |
| 83 | { |
| 84 | super(); |
| 85 | this.currentValue = currentValue; |
| 86 | } |
| 87 | |
| 88 | /** |
| 89 | * Gets the current value of the sequence reaching its limit. |
| 90 | * |
| 91 | * @return The current value of the sequence reaching its limit. |
| 92 | */ |
| 93 | public long getCurrentValue() |
| 94 | { |
| 95 | return this.currentValue; |
| 96 | } |
| 97 | |
| 98 | /** |
| 99 | * Gets the message of the exception. |
| 100 | * |
| 101 | * @return The message of the exception. |
| 102 | */ |
| 103 | @Override |
| 104 | public String getMessage() |
| 105 | { |
| 106 | return this.getSequenceLimitMessage( this.getLocale(), Long.valueOf( this.getCurrentValue() ) ); |
| 107 | } |
| 108 | |
| 109 | // SECTION-END |
| 110 | // SECTION-START[Dependencies] |
| 111 | // <editor-fold defaultstate="collapsed" desc=" Generated Dependencies "> |
| 112 | |
| 113 | /** |
| 114 | * Gets the {@code Locale} dependency. |
| 115 | * <p>This method returns the {@code 'default'} object of the {@code 'java.util.Locale'} {@code (java.util.Locale)} specification at specification level 1.1.</p> |
| 116 | * <p>That specification does not apply to any scope. A new object is returned whenever requested and bound to this instance.</p> |
| 117 | * @return The {@code Locale} dependency. |
| 118 | * @throws org.jomc.ObjectManagementException if getting the dependency instance fails. |
| 119 | */ |
| 120 | @javax.annotation.Generated( value = "org.jomc.tools.SourceFileProcessor 1.0", comments = "See http://jomc.sourceforge.net/jomc/1.0/jomc-tools" ) |
| 121 | private java.util.Locale getLocale() |
| 122 | { |
| 123 | final java.util.Locale _d = (java.util.Locale) org.jomc.ObjectManagerFactory.getObjectManager( this.getClass().getClassLoader() ).getDependency( this, "Locale" ); |
| 124 | assert _d != null : "'Locale' dependency not found."; |
| 125 | return _d; |
| 126 | } |
| 127 | // </editor-fold> |
| 128 | // SECTION-END |
| 129 | // SECTION-START[Properties] |
| 130 | // SECTION-END |
| 131 | // SECTION-START[Messages] |
| 132 | // <editor-fold defaultstate="collapsed" desc=" Generated Messages "> |
| 133 | |
| 134 | /** |
| 135 | * Gets the text of the {@code sequenceLimitMessage} message. |
| 136 | * <p><b>Templates</b><br/><table> |
| 137 | * <tr><td valign="top">English:</td><td valign="top"><pre>The maximum sequence value {0,number} has been reached. No more sequence values available.</pre></td></tr> |
| 138 | * <tr><td valign="top">Deutsch:</td><td valign="top"><pre>Der Maximalwert {0,number} der Sequenz wurde erreicht. Keine weiteren Sequenz-Werte verfügbar.</pre></td></tr> |
| 139 | * </table></p> |
| 140 | * @param locale The locale of the message to return. |
| 141 | * @param sequenceLimit Format argument. |
| 142 | * @return The text of the {@code sequenceLimitMessage} message. |
| 143 | * |
| 144 | * @throws org.jomc.ObjectManagementException if getting the message instance fails. |
| 145 | */ |
| 146 | @javax.annotation.Generated( value = "org.jomc.tools.SourceFileProcessor 1.0", comments = "See http://jomc.sourceforge.net/jomc/1.0/jomc-tools" ) |
| 147 | private String getSequenceLimitMessage( final java.util.Locale locale, final java.lang.Number sequenceLimit ) |
| 148 | { |
| 149 | final String _m = org.jomc.ObjectManagerFactory.getObjectManager( this.getClass().getClassLoader() ).getMessage( this, "sequenceLimitMessage", locale, sequenceLimit ); |
| 150 | assert _m != null : "'sequenceLimitMessage' message not found."; |
| 151 | return _m; |
| 152 | } |
| 153 | // </editor-fold> |
| 154 | // SECTION-END |
| 155 | } |