001    package ezvcard.io;
002    
003    import java.io.IOException;
004    import java.util.List;
005    
006    import ezvcard.VCard;
007    import ezvcard.types.VCardType;
008    
009    /*
010     Copyright (c) 2012, Michael Angstadt
011     All rights reserved.
012    
013     Redistribution and use in source and binary forms, with or without
014     modification, are permitted provided that the following conditions are met: 
015    
016     1. Redistributions of source code must retain the above copyright notice, this
017     list of conditions and the following disclaimer. 
018     2. Redistributions in binary form must reproduce the above copyright notice,
019     this list of conditions and the following disclaimer in the documentation
020     and/or other materials provided with the distribution. 
021    
022     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
023     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
024     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
025     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
026     ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
027     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
028     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
029     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
030     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
031     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
032    
033     The views and conclusions contained in the software and documentation are those
034     of the authors and should not be interpreted as representing official policies, 
035     either expressed or implied, of the FreeBSD Project.
036     */
037    
038    /**
039     * Common methods that all vCard reader classes must have.
040     * @author Michael Angstadt
041     */
042    public interface IParser {
043            /**
044             * Registers an extended type class.
045             * @param clazz the extended type class to register (MUST have a public,
046             * no-arg constructor)
047             */
048            void registerExtendedType(Class<? extends VCardType> clazz);
049    
050            /**
051             * Removes an extended type class that was previously registered.
052             * @param clazz the extended type class to remove (MUST have a public,
053             * no-arg constructor)
054             */
055            void unregisterExtendedType(Class<? extends VCardType> clazz);
056    
057            /**
058             * Gets the warnings from the last vCard that was unmarshalled. This list is
059             * reset every time a new vCard is read.
060             * @return the warnings or empty list if there were no warnings
061             */
062            List<String> getWarnings();
063    
064            /**
065             * Reads the next vCard.
066             * @return the next vCard or null if there are no more
067             * @throws IOException if there's a problem reading from the stream
068             */
069            VCard readNext() throws IOException;
070    }