001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *  http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing,
013     * software distributed under the License is distributed on an
014     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     * KIND, either express or implied.  See the License for the
016     * specific language governing permissions and limitations
017     * under the License.
018     */
019    
020    package javax.mail;
021    
022    /**
023     * @version $Rev: 467553 $ $Date: 2006-10-25 06:01:51 +0200 (Mi, 25. Okt 2006) $
024     */
025    public interface UIDFolder {
026        /**
027         * A special value than can be passed as the <code>end</code> parameter to
028         * {@link Folder#getMessages(int, int)} to indicate the last message in this folder.
029         */
030        public static final long LASTUID = -1;
031    
032        public abstract long getUIDValidity() throws MessagingException;
033    
034        public abstract Message getMessageByUID(long uid)
035                throws MessagingException;
036    
037        public abstract Message[] getMessagesByUID(long start, long end)
038                throws MessagingException;
039    
040        public abstract Message[] getMessagesByUID(long[] ids)
041                throws MessagingException;
042    
043        public abstract long getUID(Message message) throws MessagingException;
044    
045        public static class FetchProfileItem extends FetchProfile.Item {
046            public static final FetchProfileItem UID = new FetchProfileItem("Uid");
047    
048            protected FetchProfileItem(String name) {
049                super(name);
050            }
051        }
052    }