1 /*
2 * Copyright 2007-2013 smartics, Kronseder & Reiner GmbH
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package de.smartics.maven.exceptions.conf;
17
18 import java.util.Collection;
19 import java.util.List;
20
21 /**
22 * Provides information to be passed to the Javadoc tool.
23 */
24 public interface JavadocProjectConfiguration
25 {
26 // ********************************* Fields *********************************
27
28 // --- constants ------------------------------------------------------------
29
30 // ****************************** Initializer *******************************
31
32 // ****************************** Inner Classes *****************************
33
34 // ********************************* Methods ********************************
35
36 // --- get&set --------------------------------------------------------------
37
38 /**
39 * Returns the name of the project being processed.
40 *
41 * @return the name of the project being processed.
42 */
43 String getProjectName();
44
45 /**
46 * Returns the class path elements to use for tools we call.
47 *
48 * @return the list of class path root elements of this project.
49 */
50 List<String> getToolClassPath();
51
52 /**
53 * Returns the list of class path root elements of this project.
54 *
55 * @return the list of class path root elements of this project.
56 */
57 Collection<String> getClassRootDirectoryNames();
58
59 /**
60 * Returns the class loader to load project classes.
61 *
62 * @return the class loader to load project classes.
63 */
64 ClassLoader getProjectClassLoader();
65
66 /**
67 * Returns the list of source path root elements of this project.
68 *
69 * @return the list of source path root elements of this project.
70 */
71 Collection<String> getSourceRootDirectoryNames();
72
73 /**
74 * Returns the includes for the scanner.
75 *
76 * @return the includes for the scanner.
77 */
78 List<String> getIncludes();
79
80 /**
81 * Returns the excludes for the scanner.
82 *
83 * @return the excludes for the scanner.
84 */
85 List<String> getExcludes();
86
87 /**
88 * Returns the encoding specified for the sources in the project.
89 *
90 * @return the encoding specified for the sources in the project.
91 */
92 String getSourceEncoding();
93
94 /**
95 * Returns the Java version specified for the sources in the project.
96 *
97 * @return the Java version specified for the sources in the project.
98 */
99 String getSourceVersion();
100
101 // --- business -------------------------------------------------------------
102
103 // --- object basics --------------------------------------------------------
104 }