Java Doc for PropertyDescriptor.java in  » Code-Analyzer » pmd-4.2rc1 » net » sourceforge » pmd » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Code Analyzer » pmd 4.2rc1 » net.sourceforge.pmd 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


net.sourceforge.pmd.PropertyDescriptor

All known Subclasses:   net.sourceforge.pmd.properties.AbstractPMDProperty,
PropertyDescriptor
public interface PropertyDescriptor extends Comparable<PropertyDescriptor>(Code)
Property value descriptor that defines the use & requirements for setting property values for use within PMD and any associated GUIs.
author:
   Brian Remedios
version:
   $Revision$


Field Summary
 PropertyDescriptor[]emptyPropertySet
    


Method Summary
 StringasDelimitedString(Object value)
     Formats the object onto a string suitable for storage within the property map.
 Object[][]choices()
     Returns a set of choice tuples of available, returns null if none present.
 ObjectdefaultValue()
     Default value to use when the user hasn't specified one or when they wish to revert to a known-good state.
 Stringdescription()
     Describes the property and the role it plays within the rule it is specified for.
 StringerrorFor(Object value)
     Validation function that returns a diagnostic error message for a sample property value.
 booleanisRequired()
     Denotes whether the value is required before the rule can be executed.
 intmaxValueCount()
     If the property is multi-valued, i.e.
 charmultiValueDelimiter()
     Return the character being used to delimit multiple property values within a single string.
 Stringname()
     The name of the property without spaces as it serves as the key into the property map.
 intpreferredRowCount()
     If the datatype is a String then return the preferred number of rows to allocate in the text widget, returns a value of one for all other types.
 StringpropertyErrorFor(Rule rule)
     A convenience method that returns an error string if the rule holds onto a property value that has a problem.
 Classtype()
     Denotes the value datatype.
 floatuiOrder()
     Denotes the relative order the property field should occupy if we are using an auto-generated UI to display and edit values.
 ObjectvalueFrom(String propertyString)
     If the property is multi-valued then return the separate values after parsing the propertyString provided.

Field Detail
emptyPropertySet
PropertyDescriptor[] emptyPropertySet(Code)





Method Detail
asDelimitedString
String asDelimitedString(Object value)(Code)
Formats the object onto a string suitable for storage within the property map.
Parameters:
  value - Object String



choices
Object[][] choices()(Code)
Returns a set of choice tuples of available, returns null if none present. Object[]



defaultValue
Object defaultValue()(Code)
Default value to use when the user hasn't specified one or when they wish to revert to a known-good state. Object



description
String description()(Code)
Describes the property and the role it plays within the rule it is specified for. Could be used in a tooltip. String



errorFor
String errorFor(Object value)(Code)
Validation function that returns a diagnostic error message for a sample property value. Returns null if the value is acceptable.
Parameters:
  value - Object String



isRequired
boolean isRequired()(Code)
Denotes whether the value is required before the rule can be executed. Has no meaning for primitive types such as booleans, ints, etc. boolean



maxValueCount
int maxValueCount()(Code)
If the property is multi-valued, i.e. an array of strings, then this returns the maximum number permitted. Unary property rule properties normally return a value of one. int



multiValueDelimiter
char multiValueDelimiter()(Code)
Return the character being used to delimit multiple property values within a single string. You must ensure that this character does not appear within any rule property values to avoid deserialization errors. char



name
String name()(Code)
The name of the property without spaces as it serves as the key into the property map. String



preferredRowCount
int preferredRowCount()(Code)
If the datatype is a String then return the preferred number of rows to allocate in the text widget, returns a value of one for all other types. Useful for multi-line XPATH editors. int



propertyErrorFor
String propertyErrorFor(Rule rule)(Code)
A convenience method that returns an error string if the rule holds onto a property value that has a problem. Returns null otherwise.
Parameters:
  rule - Rule String



type
Class type()(Code)
Denotes the value datatype. Class



uiOrder
float uiOrder()(Code)
Denotes the relative order the property field should occupy if we are using an auto-generated UI to display and edit values. If the value returned has a non-zero fractional part then this is can be used to place adjacent fields on the same row. Example: name -> 0.0 description 1.0 minValue -> 2.0 maxValue -> 2.1 ..would have their fields placed like: name: [ ] description: [ ] minimum: [ ] maximum: [ ] float



valueFrom
Object valueFrom(String propertyString) throws IllegalArgumentException(Code)
If the property is multi-valued then return the separate values after parsing the propertyString provided. If it isn't a multi-valued property then the value will be returned within an array of size[1].
Parameters:
  propertyString - String Object
throws:
  IllegalArgumentException -



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.