Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
Book |
|
| 1.0;1 |
1 | package org.apache.maven.doxia.plugin; | |
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.util.List; | |
23 | ||
24 | /** | |
25 | * A model for a Book. | |
26 | * | |
27 | * @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a> | |
28 | * @version $Id: Book.java 1090706 2011-04-09 23:15:28Z hboutemy $ | |
29 | * @since 1.0 | |
30 | */ | |
31 | 0 | public class Book |
32 | { | |
33 | /** Path to the book descriptor file. */ | |
34 | private String descriptor; | |
35 | ||
36 | /** The list of formats to produce. */ | |
37 | private List<Format> formats; | |
38 | ||
39 | /** The base directory of source files. */ | |
40 | private String directory; | |
41 | ||
42 | /** Files to include. */ | |
43 | private List<String> includes; | |
44 | ||
45 | /** Files to exclude. */ | |
46 | private List<String> excludes; | |
47 | ||
48 | /** | |
49 | * Returns the path to the book descriptor file. | |
50 | * | |
51 | * @return the book descriptor file. | |
52 | */ | |
53 | public String getDescriptor() | |
54 | { | |
55 | 0 | return descriptor; |
56 | } | |
57 | ||
58 | /** | |
59 | * Returns the list of {@link Format}s to produce. | |
60 | * | |
61 | * @return the list of formats. | |
62 | */ | |
63 | public List<Format> getFormats() | |
64 | { | |
65 | 0 | return formats; |
66 | } | |
67 | ||
68 | /** | |
69 | * Returns the base directory of source files. | |
70 | * | |
71 | * @return the base directory. | |
72 | */ | |
73 | public String getDirectory() | |
74 | { | |
75 | 0 | return directory; |
76 | } | |
77 | ||
78 | /** | |
79 | * Returns the list of files to include. | |
80 | * | |
81 | * @return the list of files to include. | |
82 | */ | |
83 | public List<String> getIncludes() | |
84 | { | |
85 | 0 | return includes; |
86 | } | |
87 | ||
88 | /** | |
89 | * Returns the list of files to exclude. | |
90 | * | |
91 | * @return the list of files to exclude. | |
92 | */ | |
93 | public List<String> getExcludes() | |
94 | { | |
95 | 0 | return excludes; |
96 | } | |
97 | } |