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