001    package helliker.id3;
002    
003    import java.io.IOException;
004    
005    /*
006     * Copyright (C) 2001 Jonathan Hilliker
007     *
008     * This library is free software; you can redistribute it and/or
009     * modify it under the terms of the GNU Lesser General Public
010     * License as published by the Free Software Foundation; either
011     * version 2.1 of the License, or (at your option) any later version.
012     *
013     * This library is distributed in the hope that it will be useful,
014     * but WITHOUT ANY WARRANTY; without even the implied warranty of
015     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
016     * Lesser General Public License for more details.
017     *
018     * You should have received a copy of the GNU Lesser General Public
019     * License along with this library; if not, write to the Free Software
020     * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
021     */
022    /**
023     *  A common interface for ID3Tag objects so they can easily communicate with
024     *  each other.<br/>
025     */
026    
027    public interface ID3Tag {
028    
029        /**
030         * Copies information from the ID3Tag parameter and inserts it into
031         * this tag.  Previous data will be overwritten.
032         *
033         * @param tag the tag to copy from
034         */
035        public void copyFrom(ID3Tag tag);
036    
037        /**
038         * Saves all data in this tag to the file it is bound to.
039         *
040         * @exception IOException if an error occurs
041         */
042        public void writeTag() throws IOException;
043    
044        /**
045         * Removes this tag from the file it is bound to.
046         *
047         * @exception IOException if an error occurs
048         */
049        public void removeTag() throws IOException;
050    
051        /**
052         * Removes this tag from the file it is bound to.
053         *
054         * @exception IOException if an error occurs
055         */
056        public void removeTag(boolean forceMpegOffset) throws IOException;
057    
058    } // ID3Tag