search

easyfmxu / concurrentlinkedhashmap

Automatically exported from code.google.com/p/concurrentlinkedhashmap
Apache License 2.0
0 stars 0 forks source link

Checkstyles issues #4

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
Email from Greg Luck (ehcache):
-------------------------------

I get the following checkstyle issues. It will be a lot easier to stay in 
sync with you if we can fix these. 

The other thing this is showing up is that the standard JavaDoc and Sun 
naming conventions are not being followed.

e.g. private static final AtomicReferenceFieldUpdater<Node, Node> 
prevUpdater  would normally be PREV_UPDATER as it is a constant.

/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:77: Type Javadoc comment is missing an @param 
<K> tag.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:77: Type Javadoc comment is missing an @param 
<V> tag.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:79:5: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:79:40: Variable 'listeners' must be private 
and have accessor methods.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:80:5: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:80:40: Variable 'data' must be private and 
have accessor methods.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:81:5: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:81:25: Variable 'capacity' must be private 
and have accessor methods.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:82:5: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:82:26: Variable 'policy' must be private and 
have accessor methods.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:83:5: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:83:25: Variable 'length' must be private and 
have accessor methods.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:84:5: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:84:22: Variable 'head' must be private and 
have accessor methods.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:85:5: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:85:22: Variable 'tail' must be private and 
have accessor methods.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:96:39: '16' is a magic number.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:113:75: '0.75f' is a magic number.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:178: Don't use trailing comments.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:251: Don't use trailing comments.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:411:13: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:414:13: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:423:13: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:426:13: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:430:13: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:443:13: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:452:13: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:484:72: Name 'valueUpdater' must match 
pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$'.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:486:71: Name 'stateUpdater' must match 
pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$'.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:488:70: Name 'prevUpdater' must match pattern 
'^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$'.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:490:70: Name 'nextUpdater' must match pattern 
'^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$'.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:493: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:494:13: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:494:23: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:494:33: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:494:44: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:494:53: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:521:9: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:525:9: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:528:9: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:531:9: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:534:9: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:538:9: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:541:9: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:544:9: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:548:9: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:551:9: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:554:9: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:558:9: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:561:9: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:565:9: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:568:9: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:571:9: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:585:15: 'value' hides a field.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:599:9: Missing a Javadoc comment.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:608:69: ',' is not followed by whitespace.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:718:46: ',' is not followed by whitespace.
/Users/gluck/work/ehcache/core/src/main/java/net/sf/ehcache/concurrent/
ConcurrentLinkedHashMap.java:718:68: ',' is not followed by whitespace.

Original issue reported on code.google.com by Ben.Manes@gmail.com on 26 Feb 2009 at 1:53

GoogleCodeExporter commented 9 years ago

Original comment by Ben.Manes@gmail.com on 26 Feb 2009 at 1:53

GoogleCodeExporter commented 9 years ago 
The majority of this is noise. The ones regarding fields being package private 
is to 
allow verification of the internal state by the unit tests. If the unit tests 
are 
not migrated into any project that integrates this data structure, then those 
fields 
can be made private.

The constants warnings in regards to AtomicUpdaters is, well, opinion and I 
followed 
j.u.c. as a reference. For example, see ConcurrentLinkedQueue.

The rest seem to expect documentation on every single field and method. That 
seems a 
bit much. It seems like checkstyles was run with the default settings and not 
customized for common-sense usage.

I'll review these, but its low priority.

Original comment by Ben.Manes@gmail.com on 26 Feb 2009 at 2:01

GoogleCodeExporter commented 9 years ago

Original comment by Ben.Manes@gmail.com on 1 Mar 2009 at 8:59

GoogleCodeExporter commented 9 years ago 
I ran CheckStyles and PMD, and made minor changes. Most of the stylistic issues 
found I am considering noise.

I ran FindBugs, which found no issues.

Original comment by Ben.Manes@gmail.com on 23 May 2009 at 4:42