View Javadoc

1   /*
2    =================== DO NOT EDIT THIS FILE ====================
3    Generated by Modello 1.0.1 on 2009-07-11 18:48:37,
4    any modifications will be overwritten.
5    ==============================================================
6    */
7   
8   package org.apache.maven.model;
9   
10  /**
11   * Represents a set of reports and configuration to be used to
12   * generate them.
13   * 
14   * @version $Revision$ $Date$
15   */
16  public class ReportSet
17      implements java.io.Serializable
18  {
19  
20        //--------------------------/
21       //- Class/Member Variables -/
22      //--------------------------/
23  
24      /**
25       * The unique id for this report set, to be used during POM
26       * inheritance.
27       */
28      private String id = "default";
29  
30      /**
31       * Configuration of the report to be used when generating this
32       * set.
33       */
34      private Object configuration;
35  
36      /**
37       * Whether any configuration should be propagated to child POMs.
38       */
39      private String inherited;
40  
41      /**
42       * Field reports.
43       */
44      private java.util.List<String> reports;
45  
46  
47        //-----------/
48       //- Methods -/
49      //-----------/
50  
51      /**
52       * Method addReport.
53       * 
54       * @param string
55       */
56      public void addReport( String string )
57      {
58          if ( !(string instanceof String) )
59          {
60              throw new ClassCastException( "ReportSet.addReports(string) parameter must be instanceof " + String.class.getName() );
61          }
62          getReports().add( string );
63      } //-- void addReport( String )
64  
65      /**
66       * Get configuration of the report to be used when generating
67       * this set.
68       * 
69       * @return Object
70       */
71      public Object getConfiguration()
72      {
73          return this.configuration;
74      } //-- Object getConfiguration()
75  
76      /**
77       * Get the unique id for this report set, to be used during POM
78       * inheritance.
79       * 
80       * @return String
81       */
82      public String getId()
83      {
84          return this.id;
85      } //-- String getId()
86  
87      /**
88       * Get whether any configuration should be propagated to child
89       * POMs.
90       * 
91       * @return String
92       */
93      public String getInherited()
94      {
95          return this.inherited;
96      } //-- String getInherited()
97  
98      /**
99       * Method getReports.
100      * 
101      * @return List
102      */
103     public java.util.List<String> getReports()
104     {
105         if ( this.reports == null )
106         {
107             this.reports = new java.util.ArrayList<String>();
108         }
109 
110         return this.reports;
111     } //-- java.util.List<String> getReports()
112 
113     /**
114      * Method removeReport.
115      * 
116      * @param string
117      */
118     public void removeReport( String string )
119     {
120         if ( !(string instanceof String) )
121         {
122             throw new ClassCastException( "ReportSet.removeReports(string) parameter must be instanceof " + String.class.getName() );
123         }
124         getReports().remove( string );
125     } //-- void removeReport( String )
126 
127     /**
128      * Set configuration of the report to be used when generating
129      * this set.
130      * 
131      * @param configuration
132      */
133     public void setConfiguration( Object configuration )
134     {
135         this.configuration = configuration;
136     } //-- void setConfiguration( Object )
137 
138     /**
139      * Set the unique id for this report set, to be used during POM
140      * inheritance.
141      * 
142      * @param id
143      */
144     public void setId( String id )
145     {
146         this.id = id;
147     } //-- void setId( String )
148 
149     /**
150      * Set whether any configuration should be propagated to child
151      * POMs.
152      * 
153      * @param inherited
154      */
155     public void setInherited( String inherited )
156     {
157         this.inherited = inherited;
158     } //-- void setInherited( String )
159 
160     /**
161      * Set the list of reports from this plugin which should be
162      * generated from this set.
163      * 
164      * @param reports
165      */
166     public void setReports( java.util.List<String> reports )
167     {
168         this.reports = reports;
169     } //-- void setReports( java.util.List )
170 
171 
172             
173     private boolean inheritanceApplied = true;
174 
175     public void unsetInheritanceApplied()
176     {
177         this.inheritanceApplied = false;
178     }
179 
180     public boolean isInheritanceApplied()
181     {
182         return inheritanceApplied;
183     }
184             
185           
186 }