/*
 Copyright (C) 2008 Richard Gomes

 This source code is release under the BSD License.
 
 This file is part of JQuantLib, a free-software/open-source library
 for financial quantitative analysts and developers - http://jquantlib.org/

 JQuantLib is free software: you can redistribute it and/or modify it
 under the terms of the JQuantLib license.  You should have received a
 copy of the license along with this program; if not, please email
 . The license is also available online at
 .

 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 license for more details.
 
 JQuantLib is based on QuantLib. http://quantlib.org/
 When applicable, the original copyright notice follows this notice.
 */

/*
 Copyright (C) 2004, 2005, 2006 Ferdinando Ametrano
 Copyright (C) 2006 Katiuscia Manzoni
 Copyright (C) 2000, 2001, 2002, 2003 RiskMap srl
 Copyright (C) 2003, 2004, 2005, 2006 StatPro Italia srl

 This file is part of QuantLib, a free-software/open-source library
 for financial quantitative analysts and developers - http://quantlib.org/

 QuantLib is free software: you can redistribute it and/or modify it
 under the terms of the QuantLib license.  You should have received a
 copy of the license along with this program; if not, please email
 . The license is also available online at
 .

 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 license for more details.
 */

package org.jquantlib.time;

/**
 * Time units
 * 
 * @author Richard Gomes
 */
public enum TimeUnit {
    Days, Weeks, Months, Years;

    /**
     * Returns the name of time unit in long format (e.g. "week")
     * 
     * @return the name of time unit in long format (e.g. "week")
     */
    public String getLongFormat() {
        return getLongFormatString();
    }

    /**
     * Returns the name of time unit in short format (e.g. "w")
     * 
     * @return the name of time unit in short format (e.g. "w")
     */
    public String getShortFormat() {
        return getShortFormatString();
    }

    /**
     * Output time units in long format (e.g. "week")
     * 
     * @note message in singular form
     */
    private String getLongFormatString() {
        StringBuilder sb = new StringBuilder();
        sb.append(toString().toLowerCase());
        sb.setLength(sb.length() - 1);
        return sb.toString();
    }

    /**
     * Output time units in short format (e.g. "W")
     */
    private String getShortFormatString() {
        StringBuilder sb = new StringBuilder();
        sb.append(toString().charAt(0));
        return sb.toString();
    }

}