View Javadoc
1   /*
2    * Copyright (C) 2025 the original author or authors.
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  
17  package org.codehaus.gmavenplus.model;
18  
19  import org.apache.maven.shared.model.fileset.FileSet;
20  
21  import java.io.File;
22  import java.io.Serializable;
23  import java.util.List;
24  import java.util.Properties;
25  
26  /**
27   * Holds configuration for GroovyDoc generation.
28   *
29   * @author Keegan Witt
30   */
31  public class GroovyDocConfiguration implements Serializable {
32      private static final long serialVersionUID = 1L;
33  
34      private FileSet[] sourceDirectories;
35      private List<?> classpath;
36      private File outputDirectory;
37      private IncludeClasspath includeClasspath;
38      private Properties docProperties;
39      private List<Link> links;
40      private String[] defaultDocTemplates;
41      private String[] defaultPackageTemplates;
42      private String[] defaultClassTemplates;
43      private String groovyDocToolClass;
44      private String outputToolClass;
45      private String fileOutputToolClass;
46      private String resourceManagerClass;
47      private String classpathResourceManagerClass;
48      private String linkArgumentClass;
49      private boolean attachGroovyDocAnnotation;
50      private File overviewFile;
51      private String scope;
52      private String windowTitle;
53      private String docTitle;
54      private String footer;
55      private String header;
56      private boolean displayAuthor;
57      private String languageLevel;
58  
59      public GroovyDocConfiguration(FileSet[] sourceDirectories, List<?> classpath, File outputDirectory) {
60          this.sourceDirectories = sourceDirectories;
61          this.classpath = classpath;
62          this.outputDirectory = outputDirectory;
63      }
64  
65      public FileSet[] getSourceDirectories() {
66          return sourceDirectories;
67      }
68  
69      public List<?> getClasspath() {
70          return classpath;
71      }
72  
73      public File getOutputDirectory() {
74          return outputDirectory;
75      }
76  
77      public IncludeClasspath getIncludeClasspath() {
78          return includeClasspath;
79      }
80  
81      public void setIncludeClasspath(IncludeClasspath includeClasspath) {
82          this.includeClasspath = includeClasspath;
83      }
84  
85      public List<Link> getLinks() {
86          return links;
87      }
88  
89      public void setLinks(List<Link> links) {
90          this.links = links;
91      }
92  
93      public String[] getDefaultDocTemplates() {
94          return defaultDocTemplates;
95      }
96  
97      public void setDefaultDocTemplates(String[] defaultDocTemplates) {
98          this.defaultDocTemplates = defaultDocTemplates;
99      }
100 
101     public String[] getDefaultPackageTemplates() {
102         return defaultPackageTemplates;
103     }
104 
105     public void setDefaultPackageTemplates(String[] defaultPackageTemplates) {
106         this.defaultPackageTemplates = defaultPackageTemplates;
107     }
108 
109     public String[] getDefaultClassTemplates() {
110         return defaultClassTemplates;
111     }
112 
113     public void setDefaultClassTemplates(String[] defaultClassTemplates) {
114         this.defaultClassTemplates = defaultClassTemplates;
115     }
116 
117     public Properties getDocProperties() {
118         return docProperties;
119     }
120 
121     public void setDocProperties(Properties docProperties) {
122         this.docProperties = docProperties;
123     }
124 
125     public String getGroovyDocToolClass() {
126         return groovyDocToolClass;
127     }
128 
129     public void setGroovyDocToolClass(String groovyDocToolClass) {
130         this.groovyDocToolClass = groovyDocToolClass;
131     }
132 
133     public String getOutputToolClass() {
134         return outputToolClass;
135     }
136 
137     public void setOutputToolClass(String outputToolClass) {
138         this.outputToolClass = outputToolClass;
139     }
140 
141     public String getFileOutputToolClass() {
142         return fileOutputToolClass;
143     }
144 
145     public void setFileOutputToolClass(String fileOutputToolClass) {
146         this.fileOutputToolClass = fileOutputToolClass;
147     }
148 
149     public String getResourceManagerClass() {
150         return resourceManagerClass;
151     }
152 
153     public void setResourceManagerClass(String resourceManagerClass) {
154         this.resourceManagerClass = resourceManagerClass;
155     }
156 
157     public String getClasspathResourceManagerClass() {
158         return classpathResourceManagerClass;
159     }
160 
161     public void setClasspathResourceManagerClass(String classpathResourceManagerClass) {
162         this.classpathResourceManagerClass = classpathResourceManagerClass;
163     }
164 
165     public String getLinkArgumentClass() {
166         return linkArgumentClass;
167     }
168 
169     public void setLinkArgumentClass(String linkArgumentClass) {
170         this.linkArgumentClass = linkArgumentClass;
171     }
172 
173     public boolean isAttachGroovyDocAnnotation() {
174         return attachGroovyDocAnnotation;
175     }
176 
177     public void setAttachGroovyDocAnnotation(boolean attachGroovyDocAnnotation) {
178         this.attachGroovyDocAnnotation = attachGroovyDocAnnotation;
179     }
180 
181     public File getOverviewFile() {
182         return overviewFile;
183     }
184 
185     public void setOverviewFile(File overviewFile) {
186         this.overviewFile = overviewFile;
187     }
188 
189     public String getScope() {
190         return scope;
191     }
192 
193     public void setScope(String scope) {
194         this.scope = scope;
195     }
196 
197     public String getWindowTitle() {
198         return windowTitle;
199     }
200 
201     public void setWindowTitle(String windowTitle) {
202         this.windowTitle = windowTitle;
203     }
204 
205     public String getDocTitle() {
206         return docTitle;
207     }
208 
209     public void setDocTitle(String docTitle) {
210         this.docTitle = docTitle;
211     }
212 
213     public String getFooter() {
214         return footer;
215     }
216 
217     public void setFooter(String footer) {
218         this.footer = footer;
219     }
220 
221     public String getHeader() {
222         return header;
223     }
224 
225     public void setHeader(String header) {
226         this.header = header;
227     }
228 
229     public boolean isDisplayAuthor() {
230         return displayAuthor;
231     }
232 
233     public void setDisplayAuthor(boolean displayAuthor) {
234         this.displayAuthor = displayAuthor;
235     }
236 
237     public String getLanguageLevel() {
238         return languageLevel;
239     }
240 
241     public void setLanguageLevel(String languageLevel) {
242         this.languageLevel = languageLevel;
243     }
244 }