org.nuiton.plugin.PluginWithEncoding Maven / Gradle / Ivy

Go to download

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

Simple maven mojo api for our projects

There is a newer version: 2.4.1

Show newest version

package org.nuiton.plugin;

/*
 * #%L
 * Helper Maven Plugin :: API
 * $Id: PluginWithEncoding.java 876 2012-11-11 08:14:19Z tchemit $
 * $HeadURL: http://svn.nuiton.org/svn/maven-helper-plugin/tags/maven-helper-plugin-2.1/helper-maven-plugin-api/src/main/java/org/nuiton/plugin/PluginWithEncoding.java $
 * %%
 * Copyright (C) 2009 - 2012 Codelutin, Tony Chemit
 * %%
 * 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%
 */

/**
 * A common contract to be implements by our mojo and reports which needs encoding.
 * 
 * Just expose a getter-setter {@link #getEncoding()} and {@link #setEncoding(String)}.
 *
 * @author tchemit 
 * @since 1.2.6
 */
public interface PluginWithEncoding extends Plugin {


    /**
     * Gets the encoding to be used to read and write io resources.
     *
     * @return the encoding used.
     */
    String getEncoding();

    /**
     * Sets the encoding to use in mojo.
     *
     * @param encoding the new encoding to use in mojo
     */
    void setEncoding(String encoding);
}