View Javadoc
1   /*
2    * dpkg - Debian Package library and the Debian Package Maven plugin
3    * (c) Copyright 2016 Gerrit Hohl
4    *
5    * This program is free software; you can redistribute it and/or
6    * modify it under the terms of the GNU General Public License
7    * as published by the Free Software Foundation; either version 2
8    * of the License, or (at your option) any later version.
9    *
10   * This program is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   * GNU General Public License for more details.
14   *
15   * You should have received a copy of the GNU General Public License
16   * along with this program; if not, write to the Free Software
17   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
18   */
19  package net.sourceforge.javadpkg.control.impl;
20  
21  import net.sourceforge.javadpkg.Warning;
22  
23  
24  /**
25   * <p>
26   * A warning about an recommended field which is not set in the control.
27   * </p>
28   *
29   * @author Gerrit Hohl (gerrit-hohl@users.sourceforge.net)
30   * @version <b>1.0</b>, 28.04.2016 by Gerrit Hohl
31   */
32  public class ControlRecommendedFieldNotSetWarning implements Warning {
33  
34  
35  	/** The field name. */
36  	private String fieldName;
37  
38  
39  	/**
40  	 * <p>
41  	 * Creates a warning.
42  	 * </p>
43  	 *
44  	 * @param fieldName
45  	 *            The field name.
46  	 * @throws IllegalArgumentException
47  	 *             If the field name is <code>null</code>.
48  	 */
49  	public ControlRecommendedFieldNotSetWarning(String fieldName) {
50  		super();
51  		
52  		if (fieldName == null)
53  			throw new IllegalArgumentException("Argument fieldName is null.");
54  
55  		this.fieldName = fieldName;
56  	}
57  	
58  	
59  	@Override
60  	public String getText() {
61  		StringBuilder sb;
62  		
63  		
64  		sb = new StringBuilder();
65  		sb.append("Recommended field |");
66  		sb.append(this.fieldName);
67  		sb.append("| is not set in the control.");
68  		
69  		return sb.toString();
70  	}
71  
72  
73  }