Project Report: fawkez

Packagesummary org.jcoderz.phoenix.templategen

org.jcoderz.phoenix.templategen.Parameter

LineHitsNoteSource
1  /*
2   * $Id: Parameter.java 1011 2008-06-16 17:57:36Z amandel $
3   *
4   * Copyright 2006, The jCoderZ.org Project. All rights reserved.
5   *
6   * Redistribution and use in source and binary forms, with or without
7   * modification, are permitted provided that the following conditions are
8   * met:
9   *
10   *    * Redistributions of source code must retain the above copyright
11   *      notice, this list of conditions and the following disclaimer.
12   *    * Redistributions in binary form must reproduce the above
13   *      copyright notice, this list of conditions and the following
14   *      disclaimer in the documentation and/or other materials
15   *      provided with the distribution.
16   *    * Neither the name of the jCoderZ.org Project nor the names of
17   *      its contributors may be used to endorse or promote products
18   *      derived from this software without specific prior written
19   *      permission.
20   *
21   * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND
22   * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24   * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS
25   * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
28   * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29   * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
30   * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
31   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32   */
33  package org.jcoderz.phoenix.templategen;
34  
35  import java.util.regex.Pattern;
36  
37  /**
38   * @author Albrecht Messner
39   */
40  public class Parameter
41  {
42     private final String mName;
43     private final int mMinLength;
44     private final int mMaxLength;
45     private final boolean mMultiLine;
46  
47     private String mDescription;
48     private String mDefaultValue;
49     private String mRegexp;
50  
51 (1)   public Parameter (
52           String name,
53           int minLength,
54           int maxLength,
55           boolean multiLine)
560    {
570       mName = name;
580       mMinLength = minLength;
590       mMaxLength = maxLength;
600       mMultiLine = multiLine;
610    }
62  
63 (2)   public int getMaxLength ()
64     {
650       return mMaxLength;
66     }
67  
68 (3)   public int getMinLength ()
69     {
700       return mMinLength;
71     }
72  
73 (4)   public boolean isMultiLine ()
74     {
750       return mMultiLine;
76     }
77  
78 (5)   public String getName ()
79     {
800       return mName;
81     }
82  
83 (6)   public String getDescription ()
84     {
850       return mDescription;
86     }
87  
88 (7)   public void setDescription (String string)
89     {
900       mDescription = string;
910    }
92  
93 (8)   public String getDefaultValue ()
94     {
950       return mDefaultValue;
96     }
97  
98 (9)   public String getRegexp ()
99     {
1000       return mRegexp;
101     }
102  
103 (10)   public void setDefaultValue (String string)
104     {
1050       mDefaultValue = string;
1060    }
107  
108 (11)   public void setRegexp (String string)
109     {
1100       mRegexp = string;
1110    }
112  
113 (12)   public void checkValue (String value) throws TemplateGeneratorException
114     {
1150       if (value.length() < mMinLength
116              || value.length() > mMaxLength)
117        {
1180          throw new TemplateGeneratorException(
119                 "Invalid value '" + value + "' for parameter " + mName
120                 + ": length must be between " + mMinLength
121                 + " and " + mMaxLength + " characters");
122        }
1230       if (mRegexp != null)
124        {
1250          if (! Pattern.matches(mRegexp, value))
126           {
1270             throw new TemplateGeneratorException(
128                    "Invalid value '" + value + "' for parameter " + mName
129                    + ": does not match regular expression "
130                    + "'" + mRegexp + "'");
131           }
132        }
1330    }
134  
135     /** {@inheritDoc} */
136     public String toString ()
137     {
1380       return "[Parameter name=" + mName
139              + ", minLength=" + mMinLength
140              + ", maxLength=" + mMaxLength
141              + ", multiLine=" + mMultiLine
142              + ", description=" + mDescription
143              + ", default=" + mDefaultValue
144              + ", regexp=" + mRegexp
145              + "]";
146     }
147  }

Findings in this File

c (1) 51 : 4 Missing a Javadoc comment.
c (2) 63 : 4 Missing a Javadoc comment.
c (3) 68 : 4 Missing a Javadoc comment.
c (4) 73 : 4 Missing a Javadoc comment.
c (5) 78 : 4 Missing a Javadoc comment.
c (6) 83 : 4 Missing a Javadoc comment.
c (7) 88 : 4 Missing a Javadoc comment.
c (8) 93 : 4 Missing a Javadoc comment.
c (9) 98 : 4 Missing a Javadoc comment.
c (10) 103 : 4 Missing a Javadoc comment.
c (11) 108 : 4 Missing a Javadoc comment.
c (12) 113 : 4 Missing a Javadoc comment.