/**
 * Copyright (c) 2009 - 2011 AppWork UG(haftungsbeschränkt) <e-mail@appwork.org>
 * 
 * This file is part of org.appwork.txtresource
 * 
 * This software is licensed under the Artistic License 2.0,
 * see the LICENSE file or http://www.opensource.org/licenses/artistic-license-2.0.php
 * for details
 */
package org.appwork.txtresource;

import java.util.ArrayList;

/**
 * Youc an define controller methods in here. all Translation interfaces have
 * this methods. implement these methods in
 * org.appwork.txtresource.TranslationHandler.invoke(Object, Method, Object[])
 * all methods here have to start with _ to improove lookup speed
 * 
 * @author thomas
 * 
 */
public interface TranslateInterface {

    public String _createFile(String lng, boolean comments);

    /**
     * returns all supported languagecodes.
     * 
     * @deprecated Use
     *             org.appwork.txtresource.TranslationFactory.findTranslations
     *             (Class<? extends TranslateInterface>) instead
     * @return
     */
    @Deprecated
    ArrayList<String> _getSupportedLanguages();

    /**
     * Use this method if you need a special translated string
     * 
     * @param lng
     * @param methodname
     * @param parameter
     * @return
     */
    public String _getTranslation(String lng, String methodname, Object... parameter);

    /**
     * Resets the Languageinterface and uses the new language from now
     * 
     * @param loc
     */
    public void _setLanguage(String loc);
}