View Javadoc

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