org.zanata.maven.ConfigurableProjectMojo Maven / Gradle / Ivy

Go to download

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

Zanata client for managing projects, publishing source text and retrieving translations.

There is a newer version: 4.6.2

package org.zanata.maven;

import java.io.File;

import org.zanata.client.commands.ConfigurableOptions;
import org.zanata.client.commands.ConfigurableProjectOptions;
import org.zanata.client.config.LocaleList;

/**
 * Base class for mojos which support configuration by the user's
 * zanata.ini and by a project's zanata.xml
 * 
 * @author Sean Flanigan 
 * 
 */
public abstract class ConfigurableProjectMojo extends ConfigurableMojo implements ConfigurableProjectOptions
{

   // @formatter:off
   /*
    * @parameter should work on setter methods - see
    * http://www.sonatype.com/books/mvnref-book/reference/writing-plugins-sect-param-annot.html
    * - but it doesn't.  So we have to put @parameter on the fields instead.
    */
   // @formatter:on  

   /**
    * Zanata project configuration file.
    * 
    * @parameter expression="${zanata.projectConfig}"
    *            default-value="${basedir}/zanata.xml"
    */
   private File projectConfig;

   /**
    * Project slug (id) within Zanata server.
    * 
    * @parameter expression="${zanata.project}"
    */
   private String project;

   /**
    * Project version slug (id) within Zanata server.
    * 
    * @parameter expression="${zanata.projectVersion}"
    */
   private String projectVersion;

   /**
    * Type of project (
    * "properties" = Java .properties,
    * "podir" = publican-style gettext directories,
    * "utf8properties" = UTF-8 .properties files,
    * "gettext" = gettext PO files,
    * "file" = EXPERIMENTAL document files of various types).
    * 
    * If 'file' is used, transDir must not be the same as or nested within srcDir,
    * and vice versa.
    * 
    * @parameter expression="${zanata.projectType}"
    */
   private String projectType;

   private LocaleList localeMapList;

   public ConfigurableProjectMojo()
   {
      super();
   }

   @Override
   public File getProjectConfig()
   {
      return projectConfig;
   }

   @Override
   public void setProjectConfig(File projectConfig)
   {
      this.projectConfig = projectConfig;
   }

   @Override
   public String getProj()
   {
      return project;
   }

   @Override
   public void setProj(String project)
   {
      this.project = project;
   }

   @Override
   public String getProjectVersion()
   {
      return projectVersion;
   }

   @Override
   public void setProjectVersion(String projectVersion)
   {
      this.projectVersion = projectVersion;
   }

   @Override
   public String getProjectType()
   {
      return projectType;
   }

   @Override
   public void setProjectType(String projectType)
   {
      this.projectType = projectType;
   }

   @Override
   public LocaleList getLocaleMapList()
   {
      return localeMapList;
   }

   @Override
   public void setLocaleMapList(LocaleList localeMapList)
   {
      this.localeMapList = localeMapList;
   }

}