Skip to content

Commit

Permalink
Merge pull request #412 from bug-bulletin-forks/fix-typos
Browse files Browse the repository at this point in the history
Fix some Javadoc typos
  • Loading branch information
jodastephen authored Feb 3, 2017
2 parents 52757ea + 45d8197 commit 43b1799
Show file tree
Hide file tree
Showing 47 changed files with 74 additions and 74 deletions.
2 changes: 1 addition & 1 deletion src/example/org/joda/example/time/DateTimeBrowser.java
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@

import org.joda.time.DateTime;

/** DateTimeBrowser is a Java Swing application which reads a file contining
/** DateTimeBrowser is a Java Swing application which reads a file containing
* strings and displays DateTime values in a JTable.<p>
* The input strings must be suitable for instantiation
* of DateTime objects. The file is read, and an attempt is made
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/joda/time/Chronology.java
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ public abstract class Chronology {
/**
* Returns an instance of this Chronology that operates in the UTC time
* zone. Chronologies that do not operate in a time zone or are already
* UTC must return themself.
* UTC must return themselves.
*
* @return a version of this chronology that ignores time zones
*/
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/joda/time/DateMidnight.java
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
* This class uses a Chronology internally. The Chronology determines how the
* millisecond instant value is converted into the date time fields.
* The default Chronology is <code>ISOChronology</code> which is the agreed
* international standard and compatable with the modern Gregorian calendar.
* international standard and compatible with the modern Gregorian calendar.
*
* <p>Each individual field can be queried in two ways:
* <ul>
Expand Down Expand Up @@ -922,7 +922,7 @@ public DateMidnight withEra(int era) {
* Instead, this method returns a new instance with the value of
* century of era changed.
*
* @param centuryOfEra the centurey of era to set
* @param centuryOfEra the century of era to set
* @return a copy of this object with the field set
* @throws IllegalArgumentException if the value is invalid
* @since 1.3
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/org/joda/time/DateTime.java
Original file line number Diff line number Diff line change
Expand Up @@ -1634,7 +1634,7 @@ public DateTime withEra(int era) {
* Instead, this method returns a new instance with the value of
* century of era changed.
*
* @param centuryOfEra the centurey of era to set
* @param centuryOfEra the century of era to set
* @return a copy of this object with the field set
* @throws IllegalArgumentException if the value is invalid
* @since 1.3
Expand Down Expand Up @@ -2268,7 +2268,7 @@ public DateTime setCopy(String text) {
* may need to call {@link DateTime#withLaterOffsetAtOverlap()} on the result
* to force the later time during a DST overlap if desired.
* <p>
* From v2.2, this method handles a daylight svaings time gap, setting the
* From v2.2, this method handles a daylight savings time gap, setting the
* time to the last instant before the gap.
* <p>
* The DateTime attached to this property is unchanged by this call.
Expand Down Expand Up @@ -2297,7 +2297,7 @@ public DateTime withMaximumValue() {
* may need to call {@link DateTime#withEarlierOffsetAtOverlap()} on the result
* to force the earlier time during a DST overlap if desired.
* <p>
* From v2.2, this method handles a daylight svaings time gap, setting the
* From v2.2, this method handles a daylight savings time gap, setting the
* time to the first instant after the gap.
* <p>
* The DateTime attached to this property is unchanged by this call.
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/joda/time/DateTimeConstants.java
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ public class DateTimeConstants {
/**
* Constant (1) representing AD, years after zero (from Calendar).
* <p>
* All new chronologies with differrent Era values should try to assign
* All new chronologies with different Era values should try to assign
* eras as follows. The era that was in force at 1970-01-01 (ISO) is assigned
* the value 1. Earlier eras are assigned sequentially smaller numbers.
* Later eras are assigned sequentially greater numbers.
Expand All @@ -112,7 +112,7 @@ public class DateTimeConstants {
/**
* Alternative constant (1) representing CE, Common Era (secular).
* <p>
* All new chronologies with differrent Era values should try to assign
* All new chronologies with different Era values should try to assign
* eras as follows. The era that was in force at 1970-01-01 (ISO) is assigned
* the value 1. Earlier eras are assigned sequentially smaller numbers.
* Later eras are assigned sequentially greater numbers.
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/joda/time/DateTimeField.java
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ public abstract class DateTimeField {
* <p>
* Partial instants only contain some fields. This may result in a maximum
* possible value, such as TimeOfDay normally being limited to 23:59:59:999.
* If ths limit is reached by the addition, this method will wrap back to
* If this limit is reached by the addition, this method will wrap back to
* 00:00:00.000. In fact, you would generally only use this method for
* classes that have a limitation such as this.
* <p>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/joda/time/DateTimeFieldType.java
Original file line number Diff line number Diff line change
Expand Up @@ -435,7 +435,7 @@ private static class StandardDateTimeFieldType extends DateTimeFieldType {
* Constructor.
*
* @param name the name to use
* @param ordinal the byte value for the oridinal index
* @param ordinal the byte value for the ordinal index
* @param unitType the unit duration type
* @param rangeType the range duration type
*/
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/joda/time/DateTimeZone.java
Original file line number Diff line number Diff line change
Expand Up @@ -1259,7 +1259,7 @@ public java.util.TimeZone toTimeZone() {
public abstract boolean equals(Object object);

/**
* Gets a hash code compatable with equals.
* Gets a hash code compatible with equals.
*
* @return suitable hashcode
*/
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/org/joda/time/Days.java
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public final class Days extends BaseSingleFieldPeriod {
/** Constant representing the minimum number of days that can be stored in this object. */
public static final Days MIN_VALUE = new Days(Integer.MIN_VALUE);

/** The paser to use for this class. */
/** The parser to use for this class. */
private static final PeriodFormatter PARSER = ISOPeriodFormat.standard().withParseType(PeriodType.days());
/** Serialization version. */
private static final long serialVersionUID = 87525275727380865L;
Expand Down Expand Up @@ -106,7 +106,7 @@ public static Days days(int days) {
//-----------------------------------------------------------------------
/**
* Creates a <code>Days</code> representing the number of whole days
* between the two specified datetimes. This method corectly handles
* between the two specified datetimes. This method correctly handles
* any daylight savings time changes that may occur during the interval.
*
* @param start the start instant, must not be null
Expand Down Expand Up @@ -144,7 +144,7 @@ public static Days daysBetween(ReadablePartial start, ReadablePartial end) {

/**
* Creates a <code>Days</code> representing the number of whole days
* in the specified interval. This method corectly handles any daylight
* in the specified interval. This method correctly handles any daylight
* savings time changes that may occur during the interval.
*
* @param interval the interval to extract days from, null returns zero
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/joda/time/Hours.java
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public final class Hours extends BaseSingleFieldPeriod {
/** Constant representing the minimum number of hours that can be stored in this object. */
public static final Hours MIN_VALUE = new Hours(Integer.MIN_VALUE);

/** The paser to use for this class. */
/** The parser to use for this class. */
private static final PeriodFormatter PARSER = ISOPeriodFormat.standard().withParseType(PeriodType.hours());
/** Serialization version. */
private static final long serialVersionUID = 87525275727380864L;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public class IllegalFieldValueException extends IllegalArgumentException {
* @param fieldName the field name
* @param value the value rejected
* @param lowerBound the lower bound allowed
* @param upperBound the uppe bound allowed
* @param upperBound the upper bound allowed
* @param explain an explanation
* @return the message
*/
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/joda/time/LocalDate.java
Original file line number Diff line number Diff line change
Expand Up @@ -509,7 +509,7 @@ protected DateTimeField getField(int index, Chronology chrono) {
}

/**
* Gets the value of the field at the specifed index.
* Gets the value of the field at the specified index.
* <p>
* This method is required to support the <code>ReadablePartial</code>
* interface. The supported fields are Year, MonthOfYear and DayOfMonth.
Expand Down Expand Up @@ -1567,7 +1567,7 @@ public LocalDate withEra(int era) {
* Instead, this method returns a new instance with the value of
* century of era changed.
*
* @param centuryOfEra the centurey of era to set
* @param centuryOfEra the century of era to set
* @return a copy of this object with the field set
* @throws IllegalArgumentException if the value is invalid
*/
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/joda/time/LocalDateTime.java
Original file line number Diff line number Diff line change
Expand Up @@ -564,7 +564,7 @@ protected DateTimeField getField(int index, Chronology chrono) {
}

/**
* Gets the value of the field at the specifed index.
* Gets the value of the field at the specified index.
* <p>
* This method is required to support the <code>ReadablePartial</code>
* interface. The supported fields are Year, MonthOfDay, DayOfMonth and MillisOfDay.
Expand Down Expand Up @@ -1700,7 +1700,7 @@ public LocalDateTime withEra(int era) {
* Instead, this method returns a new instance with the value of
* century of era changed.
*
* @param centuryOfEra the centurey of era to set
* @param centuryOfEra the century of era to set
* @return a copy of this object with the field set
* @throws IllegalArgumentException if the value is invalid
*/
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/org/joda/time/LocalTime.java
Original file line number Diff line number Diff line change
Expand Up @@ -560,7 +560,7 @@ protected DateTimeField getField(int index, Chronology chrono) {
}

/**
* Gets the value of the field at the specifed index.
* Gets the value of the field at the specified index.
* <p>
* This method is required to support the <code>ReadablePartial</code>
* interface. The supported fields are HourOfDay, MinuteOfHour,
Expand Down Expand Up @@ -1264,7 +1264,7 @@ public Property millisOfDay() {
* setting the time fields from this instance and the date fields from
* the current date.
*
* @return this time as a datetime using todays date
* @return this time as a datetime using today's date
*/
public DateTime toDateTimeToday() {
return toDateTimeToday(null);
Expand All @@ -1279,7 +1279,7 @@ public DateTime toDateTimeToday() {
* specified.
*
* @param zone the zone to use, null means default
* @return this time as a datetime using todays date
* @return this time as a datetime using today's date
*/
public DateTime toDateTimeToday(DateTimeZone zone) {
Chronology chrono = getChronology().withZone(zone);
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/joda/time/Minutes.java
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public final class Minutes extends BaseSingleFieldPeriod {
/** Constant representing the minimum number of minutes that can be stored in this object. */
public static final Minutes MIN_VALUE = new Minutes(Integer.MIN_VALUE);

/** The paser to use for this class. */
/** The parser to use for this class. */
private static final PeriodFormatter PARSER = ISOPeriodFormat.standard().withParseType(PeriodType.minutes());
/** Serialization version. */
private static final long serialVersionUID = 87525275727380863L;
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/joda/time/Months.java
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ public static Months months(int months) {
//-----------------------------------------------------------------------
/**
* Creates a <code>Months</code> representing the number of whole months
* between the two specified datetimes. This method corectly handles
* between the two specified datetimes. This method correctly handles
* any daylight savings time changes that may occur during the interval.
* <p>
* This method calculates by adding months to the start date until the result
Expand Down Expand Up @@ -172,7 +172,7 @@ public static Months monthsBetween(ReadablePartial start, ReadablePartial end) {

/**
* Creates a <code>Months</code> representing the number of whole months
* in the specified interval. This method corectly handles any daylight
* in the specified interval. This method correctly handles any daylight
* savings time changes that may occur during the interval.
*
* @param interval the interval to extract months from, null returns zero
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/joda/time/Partial.java
Original file line number Diff line number Diff line change
Expand Up @@ -583,7 +583,7 @@ public Partial withFieldAdded(DurationFieldType fieldType, int amount) {
* <p>
* If the addition is zero, then <code>this</code> is returned.
* The addition will overflow into larger fields (eg. minute to hour).
* If the maximum is reached, the addition will wra.
* If the maximum is reached, the addition will wrap.
*
* @param fieldType the field type to add to, not null
* @param amount the amount to add
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/joda/time/Period.java
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@ public static Period fieldDifference(ReadablePartial start, ReadablePartial end)
* </pre>
* Bear in mind that this creates four period instances in total, three of
* which are immediately discarded.
* The alterative is more efficient, but less readable:
* The alternative is more efficient, but less readable:
* <pre>
* Period = new Period(6, 3, 0, 0, 0, 0, 23, 0);
* </pre>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/joda/time/ReadableDuration.java
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ public interface ReadableDuration extends Comparable<ReadableDuration> {
boolean equals(Object readableDuration);

/**
* Gets a hash code for the duration that is compatable with the
* Gets a hash code for the duration that is compatible with the
* equals method.
* The following formula must be used:
* <pre>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/joda/time/ReadableInterval.java
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ public interface ReadableInterval {
boolean equals(Object readableInterval);

/**
* Gets a hash code for the time interval that is compatable with the
* Gets a hash code for the time interval that is compatible with the
* equals method.
* <p>
* The formula used must be as follows:
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/joda/time/Seconds.java
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public final class Seconds extends BaseSingleFieldPeriod {
/** Constant representing the minimum number of seconds that can be stored in this object. */
public static final Seconds MIN_VALUE = new Seconds(Integer.MIN_VALUE);

/** The paser to use for this class. */
/** The parser to use for this class. */
private static final PeriodFormatter PARSER = ISOPeriodFormat.standard().withParseType(PeriodType.seconds());
/** Serialization version. */
private static final long serialVersionUID = 87525275727380862L;
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/joda/time/TimeOfDay.java
Original file line number Diff line number Diff line change
Expand Up @@ -1108,7 +1108,7 @@ public TimeOfDay addToCopy(int valueToAdd) {
* Smaller fields are unaffected.
* <p>
* If the result would be too large (beyond 23:59:59:999) or too
* small (less than 00:00:00.000) then an Execption is thrown.
* small (less than 00:00:00.000) then an Exception is thrown.
* For the alternate behaviour which wraps to the next 'day',
* see {@link #addToCopy(int)}.
* <p>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/joda/time/Weeks.java
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public final class Weeks extends BaseSingleFieldPeriod {
/** Constant representing the minimum number of weeks that can be stored in this object. */
public static final Weeks MIN_VALUE = new Weeks(Integer.MIN_VALUE);

/** The paser to use for this class. */
/** The parser to use for this class. */
private static final PeriodFormatter PARSER = ISOPeriodFormat.standard().withParseType(PeriodType.weeks());
/** Serialization version. */
private static final long serialVersionUID = 87525275727380866L;
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/org/joda/time/YearMonthDay.java
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ public final class YearMonthDay
* <p>
* Each field is queried from the Calendar and assigned to the YearMonthDay.
* This is useful if you have been using the Calendar as a local date,
* ignoing the zone.
* ignoring the zone.
* <p>
* This factory method ignores the type of the calendar and always
* creates a YearMonthDay with ISO chronology. It is expected that you
Expand Down Expand Up @@ -119,7 +119,7 @@ public static YearMonthDay fromCalendarFields(Calendar calendar) {
* <p>
* Each field is queried from the Date and assigned to the YearMonthDay.
* This is useful if you have been using the Date as a local date,
* ignoing the zone.
* ignoring the zone.
* <p>
* This factory method always creates a YearMonthDay with ISO chronology.
*
Expand Down Expand Up @@ -222,7 +222,7 @@ public YearMonthDay(long instant, Chronology chronology) {
* The chronology used will be derived from the object, defaulting to ISO.
* <p>
* NOTE: Prior to v1.3 the string format was described by
* {@link ISODateTimeFormat#dateTimeParser()}. Time ony strings are now rejected.
* {@link ISODateTimeFormat#dateTimeParser()}. Time only strings are now rejected.
*
* @param instant the datetime object, null means now
* @throws IllegalArgumentException if the instant is invalid
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/org/joda/time/Years.java
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public final class Years extends BaseSingleFieldPeriod {
/** Constant representing the minimum number of years that can be stored in this object. */
public static final Years MIN_VALUE = new Years(Integer.MIN_VALUE);

/** The paser to use for this class. */
/** The parser to use for this class. */
private static final PeriodFormatter PARSER = ISOPeriodFormat.standard().withParseType(PeriodType.years());
/** Serialization version. */
private static final long serialVersionUID = 87525275727380868L;
Expand Down Expand Up @@ -90,7 +90,7 @@ public static Years years(int years) {
//-----------------------------------------------------------------------
/**
* Creates a <code>Years</code> representing the number of whole years
* between the two specified datetimes. This method corectly handles
* between the two specified datetimes. This method correctly handles
* any daylight savings time changes that may occur during the interval.
*
* @param start the start instant, must not be null
Expand Down Expand Up @@ -128,7 +128,7 @@ public static Years yearsBetween(ReadablePartial start, ReadablePartial end) {

/**
* Creates a <code>Years</code> representing the number of whole years
* in the specified interval. This method corectly handles any daylight
* in the specified interval. This method correctly handles any daylight
* savings time changes that may occur during the interval.
*
* @param interval the interval to extract years from, null returns zero
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/joda/time/base/AbstractDateTime.java
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ public int getMillisOfSecond() {
* differ in accuracy. Joda-Time's implementation is generally more up to
* date and thus more accurate - for example JDK1.3 has no historical data.
* The effect of this is that the field values of the <code>Calendar</code>
* may differ from those of this object, even though the milliseond value
* may differ from those of this object, even though the millisecond value
* is the same. Most of the time this just means that the JDK field values
* are wrong, as our time zone information is more up to date.
*
Expand All @@ -285,7 +285,7 @@ public Calendar toCalendar(Locale locale) {
* differ in accuracy. Joda-Time's implementation is generally more up to
* date and thus more accurate - for example JDK1.3 has no historical data.
* The effect of this is that the field values of the <code>Calendar</code>
* may differ from those of this object, even though the milliseond value
* may differ from those of this object, even though the millisecond value
* is the same. Most of the time this just means that the JDK field values
* are wrong, as our time zone information is more up to date.
*
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/joda/time/base/AbstractPartial.java
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ protected AbstractPartial() {

//-----------------------------------------------------------------------
/**
* Gets the field type at the specifed index.
* Gets the field type at the specified index.
*
* @param index the index
* @return the field type
Expand All @@ -95,7 +95,7 @@ public DateTimeFieldType[] getFieldTypes() {
}

/**
* Gets the field at the specifed index.
* Gets the field at the specified index.
*
* @param index the index
* @return the field
Expand Down
Loading

0 comments on commit 43b1799

Please sign in to comment.