001 // SECTION-START[License Header]
002 // <editor-fold defaultstate="collapsed" desc=" Generated License ">
003 /*
004 * Copyright (c) 2010 The JOMC Project
005 * Copyright (c) 2005 Christian Schulte <schulte2005@users.sourceforge.net>
006 * All rights reserved.
007 *
008 * Redistribution and use in source and binary forms, with or without
009 * modification, are permitted provided that the following conditions
010 * are met:
011 *
012 * o Redistributions of source code must retain the above copyright
013 * notice, this list of conditions and the following disclaimer.
014 *
015 * o Redistributions in binary form must reproduce the above copyright
016 * notice, this list of conditions and the following disclaimer in
017 * the documentation and/or other materials provided with the
018 * distribution.
019 *
020 * THIS SOFTWARE IS PROVIDED BY THE JOMC PROJECT AND CONTRIBUTORS "AS IS"
021 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
022 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
023 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE JOMC PROJECT OR
024 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
025 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
026 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
027 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
028 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
029 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
030 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
031 *
032 * $Id: CapacityLimitException.java 2244 2010-06-29 07:58:09Z schulte2005 $
033 *
034 */
035 // </editor-fold>
036 // SECTION-END
037 package org.jomc.sequences;
038
039 import java.math.BigInteger;
040
041 // SECTION-START[Documentation]
042 // <editor-fold defaultstate="collapsed" desc=" Generated Documentation ">
043 /**
044 * Gets thrown whenever the directories capacity limit has been reached.
045 * <p><b>Dependencies</b><ul>
046 * <li>"{@link #getLocale Locale}"<blockquote>
047 * Dependency on {@code 'java.util.Locale'} {@code (java.util.Locale)} at specification level 1.1 bound to an instance.</blockquote></li>
048 * </ul></p>
049 * <p><b>Messages</b><ul>
050 * <li>"{@link #getCapacityLimitMessage capacityLimitMessage}"<table>
051 * <tr><td valign="top">English:</td><td valign="top"><pre>The capacity limit {0,number} of the sequence directory has been reached.</pre></td></tr>
052 * <tr><td valign="top">Deutsch:</td><td valign="top"><pre>Kapazitätsgrenze {0,number} des Sequenz-Verzeichnisses erreicht.</pre></td></tr>
053 * </table>
054 * </ul></p>
055 *
056 * @author <a href="mailto:schulte2005@users.sourceforge.net">Christian Schulte</a> 1.0
057 * @version $Id: CapacityLimitException.java 2244 2010-06-29 07:58:09Z schulte2005 $
058 */
059 // </editor-fold>
060 // SECTION-END
061 // SECTION-START[Annotations]
062 // <editor-fold defaultstate="collapsed" desc=" Generated Annotations ">
063 @javax.annotation.Generated( value = "org.jomc.tools.SourceFileProcessor 1.0", comments = "See http://jomc.sourceforge.net/jomc/1.0/jomc-tools" )
064 // </editor-fold>
065 // SECTION-END
066 public class CapacityLimitException extends SequencesException
067 {
068 // SECTION-START[CapacityLimitException]
069
070 /** Serial version UID for backwards compatibility with 1.0.x classes. */
071 private static final long serialVersionUID = 5107026746069981206L;
072
073 /**
074 * Capacity limit value.
075 * @serial
076 */
077 private final BigInteger capacityLimit;
078
079 /**
080 * Creates a new {@code CapacityLimitException} taking the capacity limit value.
081 *
082 * @param capacityLimit The capacity limit to report.
083 */
084 public CapacityLimitException( final BigInteger capacityLimit )
085 {
086 super();
087 this.capacityLimit = capacityLimit;
088 }
089
090 /**
091 * Gets the reported capacity limit.
092 *
093 * @return The reported capacity limit.
094 */
095 public BigInteger getCapacityLimit()
096 {
097 return this.capacityLimit;
098 }
099
100 /**
101 * Gets the message of the exception.
102 *
103 * @return The message of the exception.
104 */
105 @Override
106 public String getMessage()
107 {
108 return this.getCapacityLimitMessage( this.getLocale(), this.getCapacityLimit() );
109 }
110
111 // SECTION-END
112 // SECTION-START[Dependencies]
113 // <editor-fold defaultstate="collapsed" desc=" Generated Dependencies ">
114
115 /**
116 * Gets the {@code Locale} dependency.
117 * <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>
118 * <p>That specification does not apply to any scope. A new object is returned whenever requested and bound to this instance.</p>
119 * @return The {@code Locale} dependency.
120 * @throws org.jomc.ObjectManagementException if getting the dependency instance fails.
121 */
122 @javax.annotation.Generated( value = "org.jomc.tools.SourceFileProcessor 1.0", comments = "See http://jomc.sourceforge.net/jomc/1.0/jomc-tools" )
123 private java.util.Locale getLocale()
124 {
125 final java.util.Locale _d = (java.util.Locale) org.jomc.ObjectManagerFactory.getObjectManager( this.getClass().getClassLoader() ).getDependency( this, "Locale" );
126 assert _d != null : "'Locale' dependency not found.";
127 return _d;
128 }
129 // </editor-fold>
130 // SECTION-END
131 // SECTION-START[Properties]
132 // SECTION-END
133 // SECTION-START[Messages]
134 // <editor-fold defaultstate="collapsed" desc=" Generated Messages ">
135
136 /**
137 * Gets the text of the {@code capacityLimitMessage} message.
138 * <p><b>Templates</b><br/><table>
139 * <tr><td valign="top">English:</td><td valign="top"><pre>The capacity limit {0,number} of the sequence directory has been reached.</pre></td></tr>
140 * <tr><td valign="top">Deutsch:</td><td valign="top"><pre>Kapazitätsgrenze {0,number} des Sequenz-Verzeichnisses erreicht.</pre></td></tr>
141 * </table></p>
142 * @param locale The locale of the message to return.
143 * @param limit Format argument.
144 * @return The text of the {@code capacityLimitMessage} message.
145 *
146 * @throws org.jomc.ObjectManagementException if getting the message instance fails.
147 */
148 @javax.annotation.Generated( value = "org.jomc.tools.SourceFileProcessor 1.0", comments = "See http://jomc.sourceforge.net/jomc/1.0/jomc-tools" )
149 private String getCapacityLimitMessage( final java.util.Locale locale, final java.lang.Number limit )
150 {
151 final String _m = org.jomc.ObjectManagerFactory.getObjectManager( this.getClass().getClassLoader() ).getMessage( this, "capacityLimitMessage", locale, limit );
152 assert _m != null : "'capacityLimitMessage' message not found.";
153 return _m;
154 }
155 // </editor-fold>
156 // SECTION-END
157 }