View Javadoc

1   /*
2    =================== DO NOT EDIT THIS FILE ====================
3    Generated by Modello 1.4.1 on 2012-09-23 20:27:39,
4    any modifications will be overwritten.
5    ==============================================================
6    */
7   
8   package org.apache.maven.plugin.javadoc.options;
9   
10  /**
11   * Root class to contain all javadoc configuration options for
12   * inclusion in javadoc bundle archives.
13   * 
14   * @version $Revision$ $Date$
15   */
16  @SuppressWarnings( "all" )
17  public class JavadocOptions
18      implements java.io.Serializable
19  {
20  
21        //--------------------------/
22       //- Class/Member Variables -/
23      //--------------------------/
24  
25      /**
26       * Field groups.
27       */
28      private java.util.List<Group> groups;
29  
30      /**
31       * Field tags.
32       */
33      private java.util.List<Tag> tags;
34  
35      /**
36       * Field docletArtifacts.
37       */
38      private java.util.List<DocletArtifact> docletArtifacts;
39  
40      /**
41       * Field taglets.
42       */
43      private java.util.List<Taglet> taglets;
44  
45      /**
46       * Field offlineLinks.
47       */
48      private java.util.List<OfflineLink> offlineLinks;
49  
50      /**
51       * Field tagletArtifacts.
52       */
53      private java.util.List<TagletArtifact> tagletArtifacts;
54  
55      /**
56       * Field resourcesArtifacts.
57       */
58      private java.util.List<ResourcesArtifact> resourcesArtifacts;
59  
60      /**
61       * Field bootclasspathArtifacts.
62       */
63      private java.util.List<BootclasspathArtifact> bootclasspathArtifacts;
64  
65      /**
66       * Field links.
67       */
68      private java.util.List<String> links;
69  
70      /**
71       * Field excludePackageNames.
72       */
73      private java.util.List<String> excludePackageNames;
74  
75      /**
76       * Enables deep copying of the '&#42;&#42;/doc-files'
77       * directories and the specific 'resources' directory.
78       */
79      private boolean docfilesSubdirsUsed = false;
80  
81      /**
82       * List of exclusion patterns separated by ':' for deep copying
83       * of the '&#42;&#42;/doc-files' directories.
84       */
85      private String excludedDocfilesSubdirs;
86  
87      /**
88       * 
89       *             Path relative to project basedir where javadoc
90       * resources were located. 
91       *             This is mainly useful in multimodule builds
92       * where the reactor is still populated.
93       *           
94       */
95      private String javadocResourcesDirectory;
96  
97      /**
98       * Field modelEncoding.
99       */
100     private String modelEncoding = "UTF-8";
101 
102 
103       //-----------/
104      //- Methods -/
105     //-----------/
106 
107     /**
108      * Method addBootclasspathArtifact.
109      * 
110      * @param bootclasspathArtifact
111      */
112     public void addBootclasspathArtifact( BootclasspathArtifact bootclasspathArtifact )
113     {
114         getBootclasspathArtifacts().add( bootclasspathArtifact );
115     } //-- void addBootclasspathArtifact( BootclasspathArtifact )
116 
117     /**
118      * Method addDocletArtifact.
119      * 
120      * @param docletArtifact
121      */
122     public void addDocletArtifact( DocletArtifact docletArtifact )
123     {
124         getDocletArtifacts().add( docletArtifact );
125     } //-- void addDocletArtifact( DocletArtifact )
126 
127     /**
128      * Method addExcludePackageName.
129      * 
130      * @param string
131      */
132     public void addExcludePackageName( String string )
133     {
134         getExcludePackageNames().add( string );
135     } //-- void addExcludePackageName( String )
136 
137     /**
138      * Method addGroup.
139      * 
140      * @param group
141      */
142     public void addGroup( Group group )
143     {
144         getGroups().add( group );
145     } //-- void addGroup( Group )
146 
147     /**
148      * Method addLink.
149      * 
150      * @param string
151      */
152     public void addLink( String string )
153     {
154         getLinks().add( string );
155     } //-- void addLink( String )
156 
157     /**
158      * Method addOfflineLink.
159      * 
160      * @param offlineLink
161      */
162     public void addOfflineLink( OfflineLink offlineLink )
163     {
164         getOfflineLinks().add( offlineLink );
165     } //-- void addOfflineLink( OfflineLink )
166 
167     /**
168      * Method addResourcesArtifact.
169      * 
170      * @param resourcesArtifact
171      */
172     public void addResourcesArtifact( ResourcesArtifact resourcesArtifact )
173     {
174         getResourcesArtifacts().add( resourcesArtifact );
175     } //-- void addResourcesArtifact( ResourcesArtifact )
176 
177     /**
178      * Method addTag.
179      * 
180      * @param tag
181      */
182     public void addTag( Tag tag )
183     {
184         getTags().add( tag );
185     } //-- void addTag( Tag )
186 
187     /**
188      * Method addTaglet.
189      * 
190      * @param taglet
191      */
192     public void addTaglet( Taglet taglet )
193     {
194         getTaglets().add( taglet );
195     } //-- void addTaglet( Taglet )
196 
197     /**
198      * Method addTagletArtifact.
199      * 
200      * @param tagletArtifact
201      */
202     public void addTagletArtifact( TagletArtifact tagletArtifact )
203     {
204         getTagletArtifacts().add( tagletArtifact );
205     } //-- void addTagletArtifact( TagletArtifact )
206 
207     /**
208      * Method getBootclasspathArtifacts.
209      * 
210      * @return List
211      */
212     public java.util.List<BootclasspathArtifact> getBootclasspathArtifacts()
213     {
214         if ( this.bootclasspathArtifacts == null )
215         {
216             this.bootclasspathArtifacts = new java.util.ArrayList<BootclasspathArtifact>();
217         }
218 
219         return this.bootclasspathArtifacts;
220     } //-- java.util.List<BootclasspathArtifact> getBootclasspathArtifacts()
221 
222     /**
223      * Method getDocletArtifacts.
224      * 
225      * @return List
226      */
227     public java.util.List<DocletArtifact> getDocletArtifacts()
228     {
229         if ( this.docletArtifacts == null )
230         {
231             this.docletArtifacts = new java.util.ArrayList<DocletArtifact>();
232         }
233 
234         return this.docletArtifacts;
235     } //-- java.util.List<DocletArtifact> getDocletArtifacts()
236 
237     /**
238      * Method getExcludePackageNames.
239      * 
240      * @return List
241      */
242     public java.util.List<String> getExcludePackageNames()
243     {
244         if ( this.excludePackageNames == null )
245         {
246             this.excludePackageNames = new java.util.ArrayList<String>();
247         }
248 
249         return this.excludePackageNames;
250     } //-- java.util.List<String> getExcludePackageNames()
251 
252     /**
253      * Get list of exclusion patterns separated by ':' for deep
254      * copying of the '&#42;&#42;/doc-files' directories.
255      * 
256      * @return String
257      */
258     public String getExcludedDocfilesSubdirs()
259     {
260         return this.excludedDocfilesSubdirs;
261     } //-- String getExcludedDocfilesSubdirs()
262 
263     /**
264      * Method getGroups.
265      * 
266      * @return List
267      */
268     public java.util.List<Group> getGroups()
269     {
270         if ( this.groups == null )
271         {
272             this.groups = new java.util.ArrayList<Group>();
273         }
274 
275         return this.groups;
276     } //-- java.util.List<Group> getGroups()
277 
278     /**
279      * Get path relative to project basedir where javadoc resources
280      * were located. 
281      *             This is mainly useful in multimodule builds
282      * where the reactor is still populated.
283      * 
284      * @return String
285      */
286     public String getJavadocResourcesDirectory()
287     {
288         return this.javadocResourcesDirectory;
289     } //-- String getJavadocResourcesDirectory()
290 
291     /**
292      * Method getLinks.
293      * 
294      * @return List
295      */
296     public java.util.List<String> getLinks()
297     {
298         if ( this.links == null )
299         {
300             this.links = new java.util.ArrayList<String>();
301         }
302 
303         return this.links;
304     } //-- java.util.List<String> getLinks()
305 
306     /**
307      * Get the modelEncoding field.
308      * 
309      * @return String
310      */
311     public String getModelEncoding()
312     {
313         return this.modelEncoding;
314     } //-- String getModelEncoding()
315 
316     /**
317      * Method getOfflineLinks.
318      * 
319      * @return List
320      */
321     public java.util.List<OfflineLink> getOfflineLinks()
322     {
323         if ( this.offlineLinks == null )
324         {
325             this.offlineLinks = new java.util.ArrayList<OfflineLink>();
326         }
327 
328         return this.offlineLinks;
329     } //-- java.util.List<OfflineLink> getOfflineLinks()
330 
331     /**
332      * Method getResourcesArtifacts.
333      * 
334      * @return List
335      */
336     public java.util.List<ResourcesArtifact> getResourcesArtifacts()
337     {
338         if ( this.resourcesArtifacts == null )
339         {
340             this.resourcesArtifacts = new java.util.ArrayList<ResourcesArtifact>();
341         }
342 
343         return this.resourcesArtifacts;
344     } //-- java.util.List<ResourcesArtifact> getResourcesArtifacts()
345 
346     /**
347      * Method getTagletArtifacts.
348      * 
349      * @return List
350      */
351     public java.util.List<TagletArtifact> getTagletArtifacts()
352     {
353         if ( this.tagletArtifacts == null )
354         {
355             this.tagletArtifacts = new java.util.ArrayList<TagletArtifact>();
356         }
357 
358         return this.tagletArtifacts;
359     } //-- java.util.List<TagletArtifact> getTagletArtifacts()
360 
361     /**
362      * Method getTaglets.
363      * 
364      * @return List
365      */
366     public java.util.List<Taglet> getTaglets()
367     {
368         if ( this.taglets == null )
369         {
370             this.taglets = new java.util.ArrayList<Taglet>();
371         }
372 
373         return this.taglets;
374     } //-- java.util.List<Taglet> getTaglets()
375 
376     /**
377      * Method getTags.
378      * 
379      * @return List
380      */
381     public java.util.List<Tag> getTags()
382     {
383         if ( this.tags == null )
384         {
385             this.tags = new java.util.ArrayList<Tag>();
386         }
387 
388         return this.tags;
389     } //-- java.util.List<Tag> getTags()
390 
391     /**
392      * Get enables deep copying of the '&#42;&#42;/doc-files'
393      * directories and the specific 'resources' directory.
394      * 
395      * @return boolean
396      */
397     public boolean isDocfilesSubdirsUsed()
398     {
399         return this.docfilesSubdirsUsed;
400     } //-- boolean isDocfilesSubdirsUsed()
401 
402     /**
403      * Method removeBootclasspathArtifact.
404      * 
405      * @param bootclasspathArtifact
406      */
407     public void removeBootclasspathArtifact( BootclasspathArtifact bootclasspathArtifact )
408     {
409         getBootclasspathArtifacts().remove( bootclasspathArtifact );
410     } //-- void removeBootclasspathArtifact( BootclasspathArtifact )
411 
412     /**
413      * Method removeDocletArtifact.
414      * 
415      * @param docletArtifact
416      */
417     public void removeDocletArtifact( DocletArtifact docletArtifact )
418     {
419         getDocletArtifacts().remove( docletArtifact );
420     } //-- void removeDocletArtifact( DocletArtifact )
421 
422     /**
423      * Method removeExcludePackageName.
424      * 
425      * @param string
426      */
427     public void removeExcludePackageName( String string )
428     {
429         getExcludePackageNames().remove( string );
430     } //-- void removeExcludePackageName( String )
431 
432     /**
433      * Method removeGroup.
434      * 
435      * @param group
436      */
437     public void removeGroup( Group group )
438     {
439         getGroups().remove( group );
440     } //-- void removeGroup( Group )
441 
442     /**
443      * Method removeLink.
444      * 
445      * @param string
446      */
447     public void removeLink( String string )
448     {
449         getLinks().remove( string );
450     } //-- void removeLink( String )
451 
452     /**
453      * Method removeOfflineLink.
454      * 
455      * @param offlineLink
456      */
457     public void removeOfflineLink( OfflineLink offlineLink )
458     {
459         getOfflineLinks().remove( offlineLink );
460     } //-- void removeOfflineLink( OfflineLink )
461 
462     /**
463      * Method removeResourcesArtifact.
464      * 
465      * @param resourcesArtifact
466      */
467     public void removeResourcesArtifact( ResourcesArtifact resourcesArtifact )
468     {
469         getResourcesArtifacts().remove( resourcesArtifact );
470     } //-- void removeResourcesArtifact( ResourcesArtifact )
471 
472     /**
473      * Method removeTag.
474      * 
475      * @param tag
476      */
477     public void removeTag( Tag tag )
478     {
479         getTags().remove( tag );
480     } //-- void removeTag( Tag )
481 
482     /**
483      * Method removeTaglet.
484      * 
485      * @param taglet
486      */
487     public void removeTaglet( Taglet taglet )
488     {
489         getTaglets().remove( taglet );
490     } //-- void removeTaglet( Taglet )
491 
492     /**
493      * Method removeTagletArtifact.
494      * 
495      * @param tagletArtifact
496      */
497     public void removeTagletArtifact( TagletArtifact tagletArtifact )
498     {
499         getTagletArtifacts().remove( tagletArtifact );
500     } //-- void removeTagletArtifact( TagletArtifact )
501 
502     /**
503      * Set a list of BootclasspathArtifact parameters.
504      * 
505      * @param bootclasspathArtifacts
506      */
507     public void setBootclasspathArtifacts( java.util.List<BootclasspathArtifact> bootclasspathArtifacts )
508     {
509         this.bootclasspathArtifacts = bootclasspathArtifacts;
510     } //-- void setBootclasspathArtifacts( java.util.List )
511 
512     /**
513      * Set enables deep copying of the '&#42;&#42;/doc-files'
514      * directories and the specific 'resources' directory.
515      * 
516      * @param docfilesSubdirsUsed
517      */
518     public void setDocfilesSubdirsUsed( boolean docfilesSubdirsUsed )
519     {
520         this.docfilesSubdirsUsed = docfilesSubdirsUsed;
521     } //-- void setDocfilesSubdirsUsed( boolean )
522 
523     /**
524      * Set a list of DocletArtifact parameters.
525      * 
526      * @param docletArtifacts
527      */
528     public void setDocletArtifacts( java.util.List<DocletArtifact> docletArtifacts )
529     {
530         this.docletArtifacts = docletArtifacts;
531     } //-- void setDocletArtifacts( java.util.List )
532 
533     /**
534      * Set list of subpackage patterns to exclude from javadoc
535      * generation.
536      * 
537      * @param excludePackageNames
538      */
539     public void setExcludePackageNames( java.util.List<String> excludePackageNames )
540     {
541         this.excludePackageNames = excludePackageNames;
542     } //-- void setExcludePackageNames( java.util.List )
543 
544     /**
545      * Set list of exclusion patterns separated by ':' for deep
546      * copying of the '&#42;&#42;/doc-files' directories.
547      * 
548      * @param excludedDocfilesSubdirs
549      */
550     public void setExcludedDocfilesSubdirs( String excludedDocfilesSubdirs )
551     {
552         this.excludedDocfilesSubdirs = excludedDocfilesSubdirs;
553     } //-- void setExcludedDocfilesSubdirs( String )
554 
555     /**
556      * Set a list of Group parameters.
557      * 
558      * @param groups
559      */
560     public void setGroups( java.util.List<Group> groups )
561     {
562         this.groups = groups;
563     } //-- void setGroups( java.util.List )
564 
565     /**
566      * Set path relative to project basedir where javadoc resources
567      * were located. 
568      *             This is mainly useful in multimodule builds
569      * where the reactor is still populated.
570      * 
571      * @param javadocResourcesDirectory
572      */
573     public void setJavadocResourcesDirectory( String javadocResourcesDirectory )
574     {
575         this.javadocResourcesDirectory = javadocResourcesDirectory;
576     } //-- void setJavadocResourcesDirectory( String )
577 
578     /**
579      * Set list of URLs to javadocs for external classes.
580      * 
581      * @param links
582      */
583     public void setLinks( java.util.List<String> links )
584     {
585         this.links = links;
586     } //-- void setLinks( java.util.List )
587 
588     /**
589      * Set the modelEncoding field.
590      * 
591      * @param modelEncoding
592      */
593     public void setModelEncoding( String modelEncoding )
594     {
595         this.modelEncoding = modelEncoding;
596     } //-- void setModelEncoding( String )
597 
598     /**
599      * Set a list of OfflineLink parameters.
600      * 
601      * @param offlineLinks
602      */
603     public void setOfflineLinks( java.util.List<OfflineLink> offlineLinks )
604     {
605         this.offlineLinks = offlineLinks;
606     } //-- void setOfflineLinks( java.util.List )
607 
608     /**
609      * Set a list of ResourcesArtifact parameters.
610      * 
611      * @param resourcesArtifacts
612      */
613     public void setResourcesArtifacts( java.util.List<ResourcesArtifact> resourcesArtifacts )
614     {
615         this.resourcesArtifacts = resourcesArtifacts;
616     } //-- void setResourcesArtifacts( java.util.List )
617 
618     /**
619      * Set a list of TagletArtifact parameters.
620      * 
621      * @param tagletArtifacts
622      */
623     public void setTagletArtifacts( java.util.List<TagletArtifact> tagletArtifacts )
624     {
625         this.tagletArtifacts = tagletArtifacts;
626     } //-- void setTagletArtifacts( java.util.List )
627 
628     /**
629      * Set a list of Taglet parameters.
630      * 
631      * @param taglets
632      */
633     public void setTaglets( java.util.List<Taglet> taglets )
634     {
635         this.taglets = taglets;
636     } //-- void setTaglets( java.util.List )
637 
638     /**
639      * Set a list of Tag parameters.
640      * 
641      * @param tags
642      */
643     public void setTags( java.util.List<Tag> tags )
644     {
645         this.tags = tags;
646     } //-- void setTags( java.util.List )
647 
648 }