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: SequenceVetoException.java 2244 2010-06-29 07:58:09Z schulte2005 $
033 *
034 */
035 // </editor-fold>
036 // SECTION-END
037 package org.jomc.sequences;
038
039 // SECTION-START[Documentation]
040 // <editor-fold defaultstate="collapsed" desc=" Generated Documentation ">
041 /**
042 * Gets thrown whenever illegal sequence information is passed to a method expecting legal sequence data.
043 * <p><b>Dependencies</b><ul>
044 * <li>"{@link #getLocale Locale}"<blockquote>
045 * Dependency on {@code 'java.util.Locale'} {@code (java.util.Locale)} at specification level 1.1 bound to an instance.</blockquote></li>
046 * </ul></p>
047 * <p><b>Messages</b><ul>
048 * <li>"{@link #getIllegalSequenceMessage illegalSequenceMessage}"<table>
049 * <tr><td valign="top">English:</td><td valign="top"><pre>Illegal sequence data.</pre></td></tr>
050 * <tr><td valign="top">Deutsch:</td><td valign="top"><pre>Ungültige Sequenzdaten.</pre></td></tr>
051 * </table>
052 * </ul></p>
053 *
054 * @author <a href="mailto:schulte2005@users.sourceforge.net">Christian Schulte</a> 1.0
055 * @version $Id: SequenceVetoException.java 2244 2010-06-29 07:58:09Z schulte2005 $
056 */
057 // </editor-fold>
058 // SECTION-END
059 // SECTION-START[Annotations]
060 // <editor-fold defaultstate="collapsed" desc=" Generated Annotations ">
061 @javax.annotation.Generated( value = "org.jomc.tools.SourceFileProcessor 1.0", comments = "See http://jomc.sourceforge.net/jomc/1.0/jomc-tools" )
062 // </editor-fold>
063 // SECTION-END
064 public class SequenceVetoException extends SequencesException
065 {
066 // SECTION-START[SequenceVetoException]
067
068 /** Serial version UID for backwards compatibility with 1.0.x classes. */
069 private static final long serialVersionUID = 5024149161696766768L;
070
071 /**
072 * Event describing a vetoed sequence change.
073 * @serial
074 */
075 private final SequenceChangeEvent sequenceChangeEvent;
076
077 /**
078 * Creates a new {@code SequenceVetoException} taking an event describing a vetoed sequence change.
079 *
080 * @param evt An event describing a vetoed sequence change.
081 */
082 public SequenceVetoException( final SequenceChangeEvent evt )
083 {
084 super();
085 this.sequenceChangeEvent = evt;
086 }
087
088 /**
089 * Gets the event describing the vetoed change.
090 *
091 * @return The event describing the vetoed change.
092 */
093 public SequenceChangeEvent getSequenceChangeEvent()
094 {
095 return this.sequenceChangeEvent;
096 }
097
098 /**
099 * 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.getIllegalSequenceMessage( this.getLocale() );
107 }
108
109 // SECTION-END
110 // SECTION-START[Constructors]
111 // <editor-fold defaultstate="collapsed" desc=" Generated Constructors ">
112
113 /** Creates a new {@code SequenceVetoException} instance. */
114 @javax.annotation.Generated( value = "org.jomc.tools.SourceFileProcessor 1.0", comments = "See http://jomc.sourceforge.net/jomc/1.0/jomc-tools" )
115 public SequenceVetoException()
116 {
117 // SECTION-START[Default Constructor]
118 super();
119 this.sequenceChangeEvent = null;
120 // SECTION-END
121 }
122 // </editor-fold>
123 // SECTION-END
124 // SECTION-START[Dependencies]
125 // <editor-fold defaultstate="collapsed" desc=" Generated Dependencies ">
126
127 /**
128 * Gets the {@code Locale} dependency.
129 * <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>
130 * <p>That specification does not apply to any scope. A new object is returned whenever requested and bound to this instance.</p>
131 * @return The {@code Locale} dependency.
132 * @throws org.jomc.ObjectManagementException if getting the dependency instance fails.
133 */
134 @javax.annotation.Generated( value = "org.jomc.tools.SourceFileProcessor 1.0", comments = "See http://jomc.sourceforge.net/jomc/1.0/jomc-tools" )
135 private java.util.Locale getLocale()
136 {
137 final java.util.Locale _d = (java.util.Locale) org.jomc.ObjectManagerFactory.getObjectManager( this.getClass().getClassLoader() ).getDependency( this, "Locale" );
138 assert _d != null : "'Locale' dependency not found.";
139 return _d;
140 }
141 // </editor-fold>
142 // SECTION-END
143 // SECTION-START[Properties]
144 // SECTION-END
145 // SECTION-START[Messages]
146 // <editor-fold defaultstate="collapsed" desc=" Generated Messages ">
147
148 /**
149 * Gets the text of the {@code illegalSequenceMessage} message.
150 * <p><b>Templates</b><br/><table>
151 * <tr><td valign="top">English:</td><td valign="top"><pre>Illegal sequence data.</pre></td></tr>
152 * <tr><td valign="top">Deutsch:</td><td valign="top"><pre>Ungültige Sequenzdaten.</pre></td></tr>
153 * </table></p>
154 * @param locale The locale of the message to return.
155 * @return The text of the {@code illegalSequenceMessage} message.
156 *
157 * @throws org.jomc.ObjectManagementException if getting the message instance fails.
158 */
159 @javax.annotation.Generated( value = "org.jomc.tools.SourceFileProcessor 1.0", comments = "See http://jomc.sourceforge.net/jomc/1.0/jomc-tools" )
160 private String getIllegalSequenceMessage( final java.util.Locale locale )
161 {
162 final String _m = org.jomc.ObjectManagerFactory.getObjectManager( this.getClass().getClassLoader() ).getMessage( this, "illegalSequenceMessage", locale );
163 assert _m != null : "'illegalSequenceMessage' message not found.";
164 return _m;
165 }
166 // </editor-fold>
167 // SECTION-END
168 }