001    package biweekly.io.json;
002    
003    import biweekly.ICalException;
004    
005    import com.fasterxml.jackson.core.JsonToken;
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 parsing of a JSON-encoded iCalendar object (jCal) when the
034     * jCal object is not formatted in the correct way (the JSON syntax is valid,
035     * but it's not in the correct jCal format).
036     * @author Michael Angstadt
037     */
038    @SuppressWarnings("serial")
039    public class JCalParseException extends ICalException {
040            private final JsonToken expected, actual;
041    
042            /**
043             * Creates a jCal parse exception.
044             * @param expected the JSON token that the parser was expecting
045             * @param actual the actual JSON token
046             */
047            public JCalParseException(JsonToken expected, JsonToken actual) {
048                    super("Expected " + expected + " but was " + actual + ".");
049                    this.expected = expected;
050                    this.actual = actual;
051            }
052    
053            /**
054             * Gets the JSON token that the parser was expected.
055             * @return the expected token
056             */
057            public JsonToken getExpectedToken() {
058                    return expected;
059            }
060    
061            /**
062             * Gets the JSON token that was read.
063             * @return the actual token
064             */
065            public JsonToken getActualToken() {
066                    return actual;
067            }
068    }