1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.plugins.site;
20
21 import java.util.List;
22 import java.util.Locale;
23
24 import org.apache.maven.doxia.tools.SiteTool;
25 import org.apache.maven.plugin.AbstractMojo;
26 import org.apache.maven.plugins.annotations.Component;
27 import org.apache.maven.plugins.annotations.Parameter;
28 import org.apache.maven.project.MavenProject;
29 import org.codehaus.plexus.i18n.I18N;
30
31 /**
32 * Base class for site mojos.
33 *
34 * @author <a href="mailto:brett@apache.org">Brett Porter</a>
35 */
36 public abstract class AbstractSiteMojo extends AbstractMojo {
37 /**
38 * A comma separated list of locales to render. The first valid token will be the default Locale
39 * for this site.
40 *
41 * @since 2.3
42 */
43 @Parameter(property = "locales", defaultValue = "default")
44 private String locales;
45
46 /**
47 * Set this to 'true' to skip site generation and staging.
48 *
49 * @since 3.0
50 */
51 @Parameter(property = "maven.site.skip", defaultValue = "false")
52 protected boolean skip;
53
54 /**
55 * SiteTool.
56 */
57 @Component
58 protected SiteTool siteTool;
59
60 /**
61 * Internationalization.
62 */
63 @Component
64 protected I18N i18n;
65
66 /**
67 * The Maven project.
68 */
69 @Parameter(defaultValue = "${project}", readonly = true)
70 protected MavenProject project;
71
72 protected List<Locale> getLocales() {
73 return siteTool.getSiteLocales(locales);
74 }
75 }