View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2024 the original author or authors.
4   //
5   // This library is free software; you can redistribute it and/or
6   // modify it under the terms of the GNU Lesser General Public
7   // License as published by the Free Software Foundation; either
8   // version 2.1 of the License, or (at your option) any later version.
9   //
10  // This library 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 GNU
13  // Lesser General Public License for more details.
14  //
15  // You should have received a copy of the GNU Lesser General Public
16  // License along with this library; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  ///////////////////////////////////////////////////////////////////////////////////////////////
19  
20  package com.puppycrawl.tools.checkstyle.meta;
21  
22  /** Simple POJO class module's property details. */
23  public final class ModulePropertyDetails {
24  
25      /** Name of property. */
26      private String name;
27  
28      /** Type of property. */
29      private String type;
30  
31      /** Default value of property. */
32      private String defaultValue;
33  
34      /**
35       * This property is java type that plugins can use to validate user input, it is used when
36       * 'type' field is "String". It is used for special cases such as regexp and tokenSet.
37       */
38      private String validationType;
39  
40      /** Description of property. */
41      private String description;
42  
43      /**
44       * Get name of property.
45       *
46       * @return name of property
47       */
48      public String getName() {
49          return name;
50      }
51  
52      /**
53       * Set name of property.
54       *
55       * @param name name of property
56       */
57      public void setName(String name) {
58          this.name = name;
59      }
60  
61      /**
62       * Get type of property.
63       *
64       * @return property type
65       */
66      public String getType() {
67          return type;
68      }
69  
70      /**
71       * Set property type.
72       *
73       * @param type property type
74       */
75      public void setType(String type) {
76          this.type = type;
77      }
78  
79      /**
80       * Get default value of property.
81       *
82       * @return default value of property
83       */
84      public String getDefaultValue() {
85          return defaultValue;
86      }
87  
88      /**
89       * Set default value of property.
90       *
91       * @param defaultValue default value of property
92       */
93      public void setDefaultValue(String defaultValue) {
94          this.defaultValue = defaultValue;
95      }
96  
97      /**
98       * Get validation type of property.
99       *
100      * @return validation type of property
101      */
102     public String getValidationType() {
103         return validationType;
104     }
105 
106     /**
107      * Set validation type of property.
108      *
109      * @param validationType validation type of property
110      */
111     public void setValidationType(String validationType) {
112         this.validationType = validationType;
113     }
114 
115     /**
116      * Get description of property.
117      *
118      * @return property description
119      */
120     public String getDescription() {
121         return description;
122     }
123 
124     /**
125      * Set description of property.
126      *
127      * @param description property description
128      */
129     public void setDescription(String description) {
130         this.description = description;
131     }
132 }