[JCS-124] Make the code in Step 5 on the JCS overview page a full working class that can compile

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: jcs-2.0-beta-1
• Fix Version/s: jcs-2.0-beta-2
• Component/s: Documentation
• Environment: Testing
• Assignee: Thomas Vandahl
• Reporter: Richard Eigenmann
• Created: 04/May/14 11:37
• Updated: 25/Dec/16 18:35
• Resolved: 14/Apr/15 13:31

Description

Step 5: http://commons.apache.org/proper/commons-jcs/getting_started/intro.html

Please make this a fully compilable class that can be cut and pasted for a quick success experience for the newby.

Defaults and examples are extremely powerful and many people never venture further than the defaults and samples they discovered so it is extremely important to show sensible default values and good code.

In this vein, drop the words "might" and "could" in the comments. It's either a good way to do it or you should not be showing it for it will be copied.

Please also correct the setCache(c); instruction which doesn't make sense. The example doesn't indicate that it is extending another class where setCache(c) might be defined and isn't defining the method. Is this instruction needed?