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 org.apache.james.mime4j.dom.address;
021    
022    import java.io.Serializable;
023    import java.util.List;
024    
025    /**
026     * The abstract base for classes that represent RFC2822 addresses. This includes
027     * groups and mailboxes.
028     */
029    public abstract class Address implements Serializable {
030    
031        private static final long serialVersionUID = 634090661990433426L;
032    
033        /**
034         * Adds any mailboxes represented by this address into the given List. Note
035         * that this method has default (package) access, so a doAddMailboxesTo
036         * method is needed to allow the behavior to be overridden by subclasses.
037         */
038        final void addMailboxesTo(List<Mailbox> results) {
039            doAddMailboxesTo(results);
040        }
041    
042        /**
043         * Adds any mailboxes represented by this address into the given List. Must
044         * be overridden by concrete subclasses.
045         */
046        protected abstract void doAddMailboxesTo(List<Mailbox> results);
047    
048    }