1 package org.apache.maven.plugins.pdf;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.io.File;
23 import java.io.IOException;
24
25 import org.apache.maven.plugin.AbstractMojo;
26
27 /**
28 * Common code to create pdf, either module pdf or reactor aggregate.
29 *
30 * @since 1.5
31 */
32 public abstract class AbstractPdfMojo
33 extends AbstractMojo
34 {
35 protected abstract File getOutputDirectory();
36 protected abstract File getWorkingDirectory();
37 protected abstract boolean isIncludeReports();
38
39 /**
40 * The temp Site dir to have all site and generated-site files.
41 *
42 * @since 1.1
43 */
44 private File siteDirectoryTmp;
45
46 protected abstract void prepareTempSiteDirectory( final File tmpSiteDir )
47 throws IOException;
48
49 /**
50 * @return the default tmpSiteDirectory.
51 * @throws IOException if any
52 * @since 1.1
53 */
54 protected File getSiteDirectoryTmp()
55 throws IOException
56 {
57 if ( this.siteDirectoryTmp == null )
58 {
59 final File tmpSiteDir = new File( getWorkingDirectory(), "site.tmp" );
60 prepareTempSiteDirectory( tmpSiteDir );
61
62 this.siteDirectoryTmp = tmpSiteDir;
63 }
64
65 return this.siteDirectoryTmp;
66 }
67
68 }