001    /**
002     * Jetrix TetriNET Server
003     * Copyright (C) 2004-2005  Emmanuel Bourg
004     *
005     * This program is free software; you can redistribute it and/or
006     * modify it under the terms of the GNU General Public License
007     * as published by the Free Software Foundation; either version 2
008     * of the License, or (at your option) any later version.
009     *
010     * This program is distributed in the hope that it will be useful,
011     * but WITHOUT ANY WARRANTY; without even the implied warranty of
012     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
013     * GNU General Public License for more details.
014     *
015     * You should have received a copy of the GNU General Public License
016     * along with this program; if not, write to the Free Software
017     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
018     */
019    
020    package net.jetrix.config;
021    
022    import net.jetrix.Language;
023    
024    import java.util.Locale;
025    
026    /**
027     * Special blocks enumeration.
028     *
029     * @since 0.2
030     * 
031     * @author Emmanuel Bourg
032     * @version $Revision: 833 $, $Date: 2010-03-08 10:04:45 +0100 (lun., 08 mars 2010) $
033     */
034    public enum Special
035    {
036        ADDLINE('a'),
037        CLEARLINE('c'),
038        NUKEFIELD('n'),
039        RANDOMCLEAR('r'),
040        SWITCHFIELD('s'),
041        CLEARSPECIAL('b'),
042        GRAVITY('g'),
043        QUAKEFIELD('q'),
044        BLOCKBOMB('o');
045    
046        private final char letter;
047    
048        Special(char letter)
049        {
050            this.letter = letter;
051        }
052    
053        public char getLetter()
054        {
055            return letter;
056        }
057    
058        public String getCode()
059        {
060            return name().toLowerCase();
061        }
062    
063        public String getName(Locale locale)
064        {
065            return Language.getText("command.config.specials." + getCode(), locale);
066        }
067    
068        /**
069         * Return the special matching the specified letter.
070         *
071         * @param letter the letter of the special
072         * @since 0.3
073         */
074        public static Special valueOf(char letter)
075        {
076            for (Special special : values())
077            {
078                if (special.getLetter() == letter)
079                {
080                    return special;
081                }
082            }
083            
084            return null;
085        }
086    }