001    package biweekly.io;
002    
003    import biweekly.ICalException;
004    import biweekly.ICalendar;
005    import biweekly.Warning;
006    
007    /*
008     Copyright (c) 2013, Michael Angstadt
009     All rights reserved.
010    
011     Redistribution and use in source and binary forms, with or without
012     modification, are permitted provided that the following conditions are met: 
013    
014     1. Redistributions of source code must retain the above copyright notice, this
015     list of conditions and the following disclaimer. 
016     2. Redistributions in binary form must reproduce the above copyright notice,
017     this list of conditions and the following disclaimer in the documentation
018     and/or other materials provided with the distribution. 
019    
020     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
021     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
022     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
023     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
024     ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
025     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
026     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
027     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
028     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
029     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
030     */
031    
032    /**
033     * Thrown during the reading or writing of an iCalendar property to show that
034     * the property should not be written to the iCalendar data stream or not be
035     * included in the parsed {@link ICalendar} object.
036     * @author Michael Angstadt
037     */
038    @SuppressWarnings("serial")
039    public class SkipMeException extends ICalException {
040            private final Warning warning;
041    
042            /**
043             * Creates a new "skip me" exception.
044             * @param code the warning message code
045             * @param args the warning message arguments
046             */
047            public SkipMeException(int code, Object... args) {
048                    this(Warning.parse(code, args));
049            }
050    
051            /**
052             * Creates a new "skip me" exception.
053             * @param reason the reason why the property value cannot be parsed
054             */
055            public SkipMeException(String reason) {
056                    this(new Warning(reason));
057            }
058    
059            private SkipMeException(Warning warning) {
060                    super(warning.toString());
061                    this.warning = warning;
062            }
063    
064            public Warning getWarning() {
065                    return warning;
066            }
067    }