//FincDate.java with javadoc comments.
//Within /** and */ are first description then @tags, both optional,
//for documenting classes, methods, constructors, constants.
//To generate the HTML page of javadoc documentation:
// javadoc -author -version FincDate.java
//(javadoc of a source file with no javadoc comments produces HTML page too.)
//and then view the HTML file. Wow, just like the Sun documentation.
//Warning: do this in a separate folder. many files are created.
/**
* The FincDate
class adds increment capability to Date
.
*
* @author Dale Weems
* @version 1.0
* @see the wonderful book by Dale Weems. Also: CMIS 241
*
*/
public class FincDate extends Date {
/** Maximum allowable geegaws in a wonka bar */
public final static int MY_DUMMY_CONSTANT = 12345;
/**
* Constructs a newly created FincDate object with the month, day and year parameters.
* @param newMonth the month
* @param newDay the day
* @param newYear the year
*/
public FincDate(int newMonth, int newDay, int newYear) {
super(newMonth, newDay, newYear);
}
/**
* Changes the date to the next day.
*/
public void increment() {
// increment algorithm goes here
// it updates the year, month, and day attributes
day = day + 1;
}
/**
* Multiplies a silly number by two and returns it.
* @param myParam1 the quadratic radix elliptic curvature degree
* @param myParam2 quotation of the week to be permuted
* @return the permuted symbiotic alpha-beta primogeniture
*/
public int myDummyMethod(int myParam1, String myParam2) {
int x;
x = 2 * myParam1;
return x;
}
}