From: <mu...@us...> - 2015-09-06 07:55:29
|
Revision: 3311 http://sourceforge.net/p/jfreechart/code/3311 Author: mungady Date: 2015-09-06 07:55:27 +0000 (Sun, 06 Sep 2015) Log Message: ----------- Javadoc formatting changes. Modified Paths: -------------- branches/jfreechart-1.0.x-branch/source/org/jfree/data/time/TimeSeries.java Modified: branches/jfreechart-1.0.x-branch/source/org/jfree/data/time/TimeSeries.java =================================================================== --- branches/jfreechart-1.0.x-branch/source/org/jfree/data/time/TimeSeries.java 2015-09-06 07:41:59 UTC (rev 3310) +++ branches/jfreechart-1.0.x-branch/source/org/jfree/data/time/TimeSeries.java 2015-09-06 07:55:27 UTC (rev 3311) @@ -167,7 +167,7 @@ * created. Use one of the other constructors if you require a different * time period. * - * @param name the series name (<code>null</code> not permitted). + * @param name the series name ({@code null} not permitted). */ public TimeSeries(Comparable name) { this(name, DEFAULT_DOMAIN_DESCRIPTION, DEFAULT_RANGE_DESCRIPTION); @@ -180,9 +180,9 @@ * where this is helpful is when generating a chart for the time series - * axis labels can be taken from the domain and range description. * - * @param name the name of the series (<code>null</code> not permitted). - * @param domain the domain description (<code>null</code> permitted). - * @param range the range description (<code>null</code> permitted). + * @param name the name of the series ({@code null} not permitted). + * @param domain the domain description ({@code null} permitted). + * @param range the range description ({@code null} permitted). * * @since 1.0.13 */ @@ -201,7 +201,7 @@ /** * Returns the domain description. * - * @return The domain description (possibly <code>null</code>). + * @return The domain description (possibly {@code null}). * * @see #setDomainDescription(String) */ @@ -210,11 +210,11 @@ } /** - * Sets the domain description and sends a <code>PropertyChangeEvent</code> - * (with the property name <code>Domain</code>) to all registered + * Sets the domain description and sends a {@code PropertyChangeEvent} + * (with the property name {@code Domain}) to all registered * property change listeners. * - * @param description the description (<code>null</code> permitted). + * @param description the description ({@code null} permitted). * * @see #getDomainDescription() */ @@ -227,7 +227,7 @@ /** * Returns the range description. * - * @return The range description (possibly <code>null</code>). + * @return The range description (possibly {@code null}). * * @see #setRangeDescription(String) */ @@ -236,10 +236,10 @@ } /** - * Sets the range description and sends a <code>PropertyChangeEvent</code> - * (with the property name <code>Range</code>) to all registered listeners. + * Sets the range description and sends a {@code PropertyChangeEvent} + * (with the property name {@code Range}) to all registered listeners. * - * @param description the description (<code>null</code> permitted). + * @param description the description ({@code null} permitted). * * @see #getRangeDescription() */ @@ -272,7 +272,7 @@ /** * Returns the maximum number of items that will be retained in the series. - * The default value is <code>Integer.MAX_VALUE</code>. + * The default value is {@code Integer.MAX_VALUE}. * * @return The maximum item count. * @@ -459,7 +459,7 @@ * If you add a data item with a {@link Year} for the time period, then all * subsequent data items must also have a {@link Year} for the time period. * - * @return The time period class (may be <code>null</code> but only for + * @return The time period class (may be {@code null} but only for * an empty series). */ public Class getTimePeriodClass() { @@ -485,10 +485,10 @@ * object is a clone of the item in the series, so modifying it will have * no effect on the data series. * - * @param period the period of interest (<code>null</code> not allowed). + * @param period the period of interest ({@code null} not allowed). * * @return The data item matching the specified period (or - * <code>null</code> if there is no match). + * {@code null} if there is no match). * * @see #getDataItem(int) */ @@ -597,7 +597,7 @@ * Returns the index for the item (if any) that corresponds to a time * period. * - * @param period the time period (<code>null</code> not permitted). + * @param period the time period ({@code null} not permitted). * * @return The index. */ @@ -613,7 +613,7 @@ * * @param index index of a value. * - * @return The value (possibly <code>null</code>). + * @return The value (possibly {@code null}). */ public Number getValue(int index) { return getRawDataItem(index).getValue(); @@ -621,11 +621,11 @@ /** * Returns the value for a time period. If there is no data item with the - * specified period, this method will return <code>null</code>. + * specified period, this method will return {@code null}. * - * @param period time period (<code>null</code> not permitted). + * @param period time period ({@code null} not permitted). * - * @return The value (possibly <code>null</code>). + * @return The value (possibly {@code null}). */ public Number getValue(RegularTimePeriod period) { int index = getIndex(period); @@ -639,8 +639,7 @@ * Adds a data item to the series and sends a {@link SeriesChangeEvent} to * all registered listeners. * - * @param item the (timeperiod, value) pair (<code>null</code> not - * permitted). + * @param item the (timeperiod, value) pair ({@code null} not permitted). */ public void add(TimeSeriesDataItem item) { add(item, true); @@ -650,8 +649,7 @@ * Adds a data item to the series and sends a {@link SeriesChangeEvent} to * all registered listeners. * - * @param item the (timeperiod, value) pair (<code>null</code> not - * permitted). + * @param item the (timeperiod, value) pair ({@code null} not permitted). * @param notify notify listeners? */ public void add(TimeSeriesDataItem item, boolean notify) { @@ -725,7 +723,7 @@ * Adds a new data item to the series and sends a {@link SeriesChangeEvent} * to all registered listeners. * - * @param period the time period (<code>null</code> not permitted). + * @param period the time period ({@code null} not permitted). * @param value the value. */ public void add(RegularTimePeriod period, double value) { @@ -737,7 +735,7 @@ * Adds a new data item to the series and sends a {@link SeriesChangeEvent} * to all registered listeners. * - * @param period the time period (<code>null</code> not permitted). + * @param period the time period ({@code null} not permitted). * @param value the value. * @param notify notify listeners? */ @@ -752,8 +750,8 @@ * a {@link org.jfree.data.general.SeriesChangeEvent} to all registered * listeners. * - * @param period the time period (<code>null</code> not permitted). - * @param value the value (<code>null</code> permitted). + * @param period the time period ({@code null} not permitted). + * @param value the value ({@code null} permitted). */ public void add(RegularTimePeriod period, Number value) { // defer argument checking... @@ -764,8 +762,8 @@ * Adds a new data item to the series and sends a {@link SeriesChangeEvent} * to all registered listeners. * - * @param period the time period (<code>null</code> not permitted). - * @param value the value (<code>null</code> permitted). + * @param period the time period ({@code null} not permitted). + * @param value the value ({@code null} permitted). * @param notify notify listeners? */ public void add(RegularTimePeriod period, Number value, boolean notify) { @@ -778,7 +776,7 @@ * Updates (changes) the value for a time period. Throws a * {@link SeriesException} if the period does not exist. * - * @param period the period (<code>null</code> not permitted). + * @param period the period ({@code null} not permitted). * @param value the value. * * @since 1.0.14 @@ -791,8 +789,8 @@ * Updates (changes) the value for a time period. Throws a * {@link SeriesException} if the period does not exist. * - * @param period the period (<code>null</code> not permitted). - * @param value the value (<code>null</code> permitted). + * @param period the period ({@code null} not permitted). + * @param value the value ({@code null} permitted). */ public void update(RegularTimePeriod period, Number value) { TimeSeriesDataItem temp = new TimeSeriesDataItem(period, value); @@ -808,7 +806,7 @@ * Updates (changes) the value of a data item. * * @param index the index of the data item. - * @param value the new value (<code>null</code> permitted). + * @param value the new value ({@code null} permitted). */ public void update(int index, Number value) { TimeSeriesDataItem item = (TimeSeriesDataItem) this.data.get(index); @@ -858,11 +856,11 @@ * Adds or updates an item in the times series and sends a * {@link SeriesChangeEvent} to all registered listeners. * - * @param period the time period to add/update (<code>null</code> not + * @param period the time period to add/update ({@code null} not * permitted). * @param value the new value. * - * @return A copy of the overwritten data item, or <code>null</code> if no + * @return A copy of the overwritten data item, or {@code null} if no * item was overwritten. */ public TimeSeriesDataItem addOrUpdate(RegularTimePeriod period, @@ -874,15 +872,15 @@ * Adds or updates an item in the times series and sends a * {@link SeriesChangeEvent} to all registered listeners. * - * @param period the time period to add/update (<code>null</code> not + * @param period the time period to add/update ({@code null} not * permitted). - * @param value the new value (<code>null</code> permitted). + * @param value the new value ({@code null} permitted). * - * @return A copy of the overwritten data item, or <code>null</code> if no + * @return A copy of the overwritten data item, or {@code null} if no * item was overwritten. */ public TimeSeriesDataItem addOrUpdate(RegularTimePeriod period, - Number value) { + Number value) { return addOrUpdate(new TimeSeriesDataItem(period, value)); } @@ -890,9 +888,9 @@ * Adds or updates an item in the times series and sends a * {@link SeriesChangeEvent} to all registered listeners. * - * @param item the data item (<code>null</code> not permitted). + * @param item the data item ({@code null} not permitted). * - * @return A copy of the overwritten data item, or <code>null</code> if no + * @return A copy of the overwritten data item, or {@code null} if no * item was overwritten. * * @since 1.0.14 @@ -1052,7 +1050,7 @@ * {@link SeriesChangeEvent} to all registered listeners. If there is no * item with the specified time period, this method does nothing. * - * @param period the period of the item to delete (<code>null</code> not + * @param period the period of the item to delete ({@code null} not * permitted). */ public void delete(RegularTimePeriod period) { @@ -1169,10 +1167,9 @@ * Creates a new timeseries by copying a subset of the data in this time * series. * - * @param start the first time period to copy (<code>null</code> not + * @param start the first time period to copy ({@code null} not * permitted). - * @param end the last time period to copy (<code>null</code> not - * permitted). + * @param end the last time period to copy ({@code null} not permitted). * * @return A time series containing a copy of this time series from start * until end. @@ -1215,7 +1212,7 @@ /** * Tests the series for equality with an arbitrary object. * - * @param obj the object to test against (<code>null</code> permitted). + * @param obj the object to test against ({@code null} permitted). * * @return A boolean. */ @@ -1292,7 +1289,7 @@ /** * Updates the cached values for the minimum and maximum data values. * - * @param item the item added (<code>null</code> not permitted). + * @param item the item added ({@code null} not permitted). * * @since 1.0.14 */ @@ -1309,7 +1306,7 @@ * Updates the cached values for the minimum and maximum data values on * the basis that the specified item has just been removed. * - * @param item the item added (<code>null</code> not permitted). + * @param item the item added ({@code null} not permitted). * * @since 1.0.14 */ @@ -1386,12 +1383,12 @@ * Creates a new (empty) time series with the specified name and class * of {@link RegularTimePeriod}. * - * @param name the series name (<code>null</code> not permitted). - * @param timePeriodClass the type of time period (<code>null</code> not + * @param name the series name ({@code null} not permitted). + * @param timePeriodClass the type of time period ({@code null} not * permitted). * * @deprecated As of 1.0.13, it is not necessary to specify the - * <code>timePeriodClass</code> as this will be inferred when the + * {@code timePeriodClass} as this will be inferred when the * first data item is added to the dataset. */ public TimeSeries(Comparable name, Class timePeriodClass) { @@ -1406,14 +1403,14 @@ * where this is helpful is when generating a chart for the time series - * axis labels can be taken from the domain and range description. * - * @param name the name of the series (<code>null</code> not permitted). - * @param domain the domain description (<code>null</code> permitted). - * @param range the range description (<code>null</code> permitted). - * @param timePeriodClass the type of time period (<code>null</code> not + * @param name the name of the series ({@code null} not permitted). + * @param domain the domain description ({@code null} permitted). + * @param range the range description ({@code null} permitted). + * @param timePeriodClass the type of time period ({@code null} not * permitted). * * @deprecated As of 1.0.13, it is not necessary to specify the - * <code>timePeriodClass</code> as this will be inferred when the + * {@code timePeriodClass} as this will be inferred when the * first data item is added to the dataset. */ public TimeSeries(Comparable name, String domain, String range, This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |