/*
 *
 *    OPEN-XCHANGE legal information
 *
 *    All intellectual property rights in the Software are protected by
 *    international copyright laws.
 *
 *
 *    In some countries OX, OX Open-Xchange, open xchange and OXtender
 *    as well as the corresponding Logos OX Open-Xchange and OX are registered
 *    trademarks of the Open-Xchange, Inc. group of companies.
 *    The use of the Logos is not covered by the GNU General Public License.
 *    Instead, you are allowed to use these Logos according to the terms and
 *    conditions of the Creative Commons License, Version 2.5, Attribution,
 *    Non-commercial, ShareAlike, and the interpretation of the term
 *    Non-commercial applicable to the aforementioned license is published
 *    on the web site http://www.open-xchange.com/EN/legal/index.html.
 *
 *    Please make sure that third-party modules and libraries are used
 *    according to their respective licenses.
 *
 *    Any modifications to this package must retain all copyright notices
 *    of the original copyright holder(s) for the original code used.
 *
 *    After any such modifications, the original and derivative code shall remain
 *    under the copyright of the copyright holder(s) and/or original author(s)per
 *    the Attribution and Assignment Agreement that can be located at
 *    http://www.open-xchange.com/EN/developer/. The contributing author shall be
 *    given Attribution for the derivative code and a license granting use.
 *
 *     Copyright (C) 2004-2011 Open-Xchange, Inc.
 *     Mail: info@open-xchange.com
 *
 *
 *     This program is free software; you can redistribute it and/or modify it
 *     under the terms of the GNU General Public License, Version 2 as published
 *     by the Free Software Foundation.
 *
 *     This program is distributed in the hope that it will be useful, but
 *     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 *     or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 *     for more details.
 *
 *     You should have received a copy of the GNU General Public License along
 *     with this program; if not, write to the Free Software Foundation, Inc., 59
 *     Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 */

package com.openexchange.i18n.tools;

import java.util.HashMap;
import java.util.Map;

/**
 * {@link TemplateToken} - An enumeration of possible occurring tokens in a
 * template which are supposed to be replaced with user/object information.
 * 
 * @author <a href="mailto:thorben.betten@open-xchange.com">Thorben Betten</a>
 */
public enum TemplateToken {

    /**
     * Display name of the owner
     */
    CREATED_BY("created_by"),
    /**
     * Folder owner
     */
    BEHALF_OF("behalf_of"),
    /**
     * Display name of the changing user
     */
    CHANGED_BY("changed_by"),
    /**
     * Creation date and time in standard date and time format
     */
    CREATION_DATETIME("creation_datetime"),
    /**
     * The tile
     */
    TITLE("title"),
    /**
     * The location
     */
    LOCATION("location"),
    /**
     * The ID of the folder where object is created
     */
    FOLDER_ID("folder"),
    /**
     * The name of the folder where object is created
     */
    FOLDER_NAME("folder_name"),
    /**
     * The object ID
     */
    OBJECT_ID("object"),
    /**
     * The module name; e.g. <i>Calendar</i>
     */
    MODULE("module"),
    /**
     * path to the JavaScript UI on the web server
     */
    UI_WEB_PATH("uiwebpath"),
    /**
     * The host name for generating links to an object
     */
    HOSTNAME("hostname"),
    /**
     * The link to an object
     */
    LINK("link"),
    /**
     * The start date
     */
    START("start"),
    /**
     * The end date
     */
    END("end"),
    /**
     * The recurring information; e.g. <i>Daily, starting 15.02.2007, ending
     * 17.02.2007</i>.
     */
    SERIES("series"),
    /**
     * The comment/description
     */
    DESCRIPTION("description"),
    /**
     * The participant list
     */
    PARTICIPANTS("participants"),
    /**
     * The resource list
     */
    RESOURCES("resources"),
    /**
     * The confirmation status
     */
    STATUS("status"),
    /**
     * The action
     */
    ACTION("action"),
    /**
     * The confirmation action
     */
    CONFIRMATION_ACTIN("confirmation_action"),
    /**
     * Task's priority
     */
    TASK_PRIORITY("priority"),
    /**
     * Task's status
     */
    TASK_STATUS("task_status"),
    /**
     * Delete exceptions
     */
    DELETE_EXCEPTIONS("delete_exceptions"),
    /**
     * Change exceptions
     */
    CHANGE_EXCEPTIONS("change_exceptions");

    private final String token;

    private TemplateToken(final String token) {
        this.token = token;
    }

    /**
     * Gets the tokens
     * 
     * @return The token
     */
    public String getToken() {
        return token;
    }

    private static final transient Map<String, TemplateToken> MAP;

    static {
        final TemplateToken[] tokens = TemplateToken.values();
        MAP = new HashMap<String, TemplateToken>(tokens.length);
        for (final TemplateToken token : tokens) {
            MAP.put(token.token, token);
        }
    }

    /**
     * Gets the template token for specified string or <code>null</code> if
     * there's no corresponding template token.
     * 
     * @param tokenString The token string
     * @return The template token for specified string or <code>null</code> if
     *         there's no corresponding template token.
     */
    public static TemplateToken getByString(final String tokenString) {
        return MAP.get(tokenString);
    }
}
