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.artifact.repository.ArtifactRepository;
25 import org.apache.maven.doxia.tools.SiteTool;
26 import org.apache.maven.plugin.AbstractMojo;
27 import org.apache.maven.plugins.annotations.Component;
28 import org.apache.maven.plugins.annotations.Parameter;
29 import org.apache.maven.project.MavenProject;
30 import org.codehaus.plexus.i18n.I18N;
31
32 /**
33 * Base class for site mojos.
34 *
35 * @author <a href="mailto:brett@apache.org">Brett Porter</a>
36 */
37 public abstract class AbstractSiteMojo extends AbstractMojo {
38 /**
39 * A comma separated list of locales to render. The first valid token will be the default Locale
40 * for this site.
41 *
42 * @since 2.3
43 */
44 @Parameter(property = "locales", defaultValue = "default")
45 private String locales;
46
47 /**
48 * Set this to 'true' to skip site generation and staging.
49 *
50 * @since 3.0
51 */
52 @Parameter(property = "maven.site.skip", defaultValue = "false")
53 protected boolean skip;
54
55 /**
56 * SiteTool.
57 */
58 @Component
59 protected SiteTool siteTool;
60
61 /**
62 * Internationalization.
63 */
64 @Component
65 protected I18N i18n;
66
67 /**
68 * The Maven project.
69 */
70 @Parameter(defaultValue = "${project}", readonly = true)
71 protected MavenProject project;
72
73 /**
74 * The local repository.
75 */
76 @Parameter(defaultValue = "${localRepository}", readonly = true)
77 protected ArtifactRepository localRepository;
78
79 /**
80 * The reactor projects.
81 */
82 @Parameter(defaultValue = "${reactorProjects}", required = true, readonly = true)
83 protected List<MavenProject> reactorProjects;
84
85 protected List<Locale> getLocales() {
86 return siteTool.getSiteLocales(locales);
87 }
88 }