com.feilong.net.mail.util.FolderUtil Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation

feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.

There is a newer version: 4.0.8

Show newest version

/*
 * Copyright (C) 2008 feilong
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.feilong.net.mail.util;

import static com.feilong.core.util.MapUtil.newLinkedHashMap;

import java.util.Map;

import javax.mail.Folder;
import javax.mail.MessagingException;

/**
 * 和 {@link javax.mail.Folder} 相关工具类.
 *
 * @author feilong
 * @see "HKEY_CURRENT_USER/Software/Microsoft/Windows/CurrentVersion/Explorer/Shell Folders"
 * @since 1.0.9
 */
public final class FolderUtil{

    /** Don't let anyone instantiate this class. */
    private FolderUtil(){
        //AssertionError不是必须的. 但它可以避免不小心在类的内部调用构造器. 保证该类在任何情况下都不会被实例化.
        //see 《Effective Java》 2nd
        throw new AssertionError("No " + getClass().getName() + " instances for you!");
    }

    //---------------------------------------------------------------

    /**
     * 获得 map for LOGGER.
     *
     * @param folder
     *            the folder
     * @return the map for log
     * @throws MessagingException
     *             the messaging exception
     */
    public static final Map getMapForLog(Folder folder) throws MessagingException{
        Map map = newLinkedHashMap();
        map.put("getName", folder.getName());
        map.put("getFullName", folder.getFullName());
        map.put("getMode", folder.getMode());

        //总邮件数量
        map.put("getMessageCount", folder.getMessageCount());
        map.put("getNewMessageCount", folder.getNewMessageCount());

        //未读邮件数量
        map.put("getUnreadMessageCount", folder.getUnreadMessageCount());
        map.put("getDeletedMessageCount", folder.getDeletedMessageCount());

        map.put("getPermanentFlags", folder.getPermanentFlags());
        map.put("getSeparator", "" + folder.getSeparator());
        map.put("getType", folder.getType());
        map.put("getURLName", "" + folder.getURLName());
        return map;
    }
}