[#QUARTZ-580] NthIncludedDayTrigger.getFireAtTime() method result does not match the result that is documented in Javadoc.

Quartz Scheduler

NthIncludedDayTrigger.getFireAtTime() method result does not match the result that is documented in Javadoc.

Created: 02/May/07 02:27 PM Updated: 27/Oct/07 01:59 PM

Component/s:

Documentation

Affects Version/s:

1.6

Fix Version/s:

1.6.1

Environment:

Any

Description

« Hide

NthIncludedDayTrigger.getFireAtTime() Javadoc documentation says that the method returns "(...) the fire time for the NthIncludedDayTrigger as a string with the format "HH:MM", with HH representing the 24-hour clock hour of the fire time."

In fact, the method returns the time in "HH:MM:SS" format, where SS are seconds.

All

Comments

Change History

Sort Order:

[ Permlink | « Hide ]

Henri Yandell - [03/May/07 10:12 AM ]

Presumably the code is right and this is a doc change - setting a fix version to 1.6.1.

[ Permlink | « Hide ]

Henri Yandell - [27/Oct/07 01:59 PM ]

Looking at setFireAtTime(String), it states that seconds are optional, so I've changed the javadoc for getFireAtTime to:

     * Returns the fire time for the <CODE>NthIncludedDayTrigger</CODE> as a
     * string with the format "HH:MM[:SS]", with HH representing the
     * 24-hour clock hour of the fire time. Seconds are optional and their
     * inclusion depends on whether or not they were provided to
     * {@link #setFireAtTime(String)}.

r742 on trunk, r743 on the branch.