org.nuiton.i18n.plugin.parser.FileParser Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of i18n-maven-plugin Show documentation

Maven plugin to deal with i18n stuff in a project, mainly base on the i18n api (but not only).

There is a newer version: 4.0-beta-28

/*
 * #%L
 * I18n :: Maven Plugin
 * %%
 * Copyright (C) 2007 - 2024 Code Lutin, Ultreia.io
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * 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 Lesser Public License for more details.
 *
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

package org.nuiton.i18n.plugin.parser;

import java.io.File;
import java.io.IOException;
import java.nio.charset.Charset;
import java.util.TreeSet;


/**
 * the contract of a i18n file parser.
 *
 * @author Tony Chemit - [email protected]
 * @since 1.2
 */
public interface FileParser {

    /**
     * Gets encoding used to read and write files.
     *
     * @return the encoding
     */
    Charset getEncoding();

    /**
     * @return {@code true} if file was touched (says contains at least one i18n key)
     */
    boolean isTouched();

    /**
     * @return the results of i18n keys found for the given file
     */
    TreeSet getResult();

    /**
     * Parse sur un fichier
     *
     * @param file le fichier à parser
     * @throws IOException if any pb
     */
    void parseFile(File file) throws IOException;

    /**
     * Parse une partie du fichier
     *
     * @param file le fichier à parser
     * @param line la ligne à parser
     * @throws IOException if any pb
     */
    void parseLine(File file, String line) throws IOException;

    /** clean file parser. */
    void destroy();
}