Skip to content

Commit

Permalink
Disable mvn javadoc warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
xerial committed May 5, 2020
1 parent 881057b commit c8122cc
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 44 deletions.
6 changes: 4 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>org.xerial</groupId>
<artifactId>sqlite-jdbc</artifactId>
<version>3.31.1-SNAPSHOT</version>
<version>3.31.1</version>
<name>SQLite JDBC</name>
<description>SQLite JDBC library</description>

Expand Down Expand Up @@ -117,9 +117,11 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.3</version>
<version>3.2.0</version>
<configuration>
<additionalparam>-Xdoclint:none</additionalparam>
<additionalOptions>-Xdoclint:none</additionalOptions>
<additionalJOption>-Xdoclint:none</additionalJOption>
</configuration>
</plugin>

Expand Down
46 changes: 23 additions & 23 deletions src/main/java/org/sqlite/date/DateFormatUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Expand All @@ -25,9 +25,9 @@
* <p>Date and time formatting utilities and constants.</p>
*
* <p>Formatting is performed using the thread-safe
* {@link org.apache.commons.lang3.time.FastDateFormat} class.</p>
* org.apache.commons.lang3.time.FastDateFormat class.</p>
*
* <p>Note that the JDK has a bug wherein calling Calendar.get(int) will
* <p>Note that the JDK has a bug wherein calling Calendar.get(int) will
* override any previously called Calendar.clear() calls. See LANG-755.</p>
*
* @since 2.0
Expand Down Expand Up @@ -122,7 +122,7 @@ public DateFormatUtils() {

/**
* <p>Formats a date/time into a specific pattern using the UTC time zone.</p>
*
*
* @param millis the date to format expressed in milliseconds
* @param pattern the pattern to use to format the date, not null
* @return the formatted date
Expand All @@ -133,18 +133,18 @@ public static String formatUTC(final long millis, final String pattern) {

/**
* <p>Formats a date/time into a specific pattern using the UTC time zone.</p>
*
*
* @param date the date to format, not null
* @param pattern the pattern to use to format the date, not null
* @return the formatted date
*/
public static String formatUTC(final Date date, final String pattern) {
return format(date, pattern, UTC_TIME_ZONE, null);
}

/**
* <p>Formats a date/time into a specific pattern using the UTC time zone.</p>
*
*
* @param millis the date to format expressed in milliseconds
* @param pattern the pattern to use to format the date, not null
* @param locale the locale to use, may be <code>null</code>
Expand All @@ -156,7 +156,7 @@ public static String formatUTC(final long millis, final String pattern, final Lo

/**
* <p>Formats a date/time into a specific pattern using the UTC time zone.</p>
*
*
* @param date the date to format, not null
* @param pattern the pattern to use to format the date, not null
* @param locale the locale to use, may be <code>null</code>
Expand All @@ -165,10 +165,10 @@ public static String formatUTC(final long millis, final String pattern, final Lo
public static String formatUTC(final Date date, final String pattern, final Locale locale) {
return format(date, pattern, UTC_TIME_ZONE, locale);
}

/**
* <p>Formats a date/time into a specific pattern.</p>
*
*
* @param millis the date to format expressed in milliseconds
* @param pattern the pattern to use to format the date, not null
* @return the formatted date
Expand All @@ -179,7 +179,7 @@ public static String format(final long millis, final String pattern) {

/**
* <p>Formats a date/time into a specific pattern.</p>
*
*
* @param date the date to format, not null
* @param pattern the pattern to use to format the date, not null
* @return the formatted date
Expand All @@ -190,7 +190,7 @@ public static String format(final Date date, final String pattern) {

/**
* <p>Formats a calendar into a specific pattern.</p>
*
*
* @param calendar the calendar to format, not null
* @param pattern the pattern to use to format the calendar, not null
* @return the formatted calendar
Expand All @@ -200,10 +200,10 @@ public static String format(final Date date, final String pattern) {
public static String format(final Calendar calendar, final String pattern) {
return format(calendar, pattern, null, null);
}

/**
* <p>Formats a date/time into a specific pattern in a time zone.</p>
*
*
* @param millis the time expressed in milliseconds
* @param pattern the pattern to use to format the date, not null
* @param timeZone the time zone to use, may be <code>null</code>
Expand All @@ -215,7 +215,7 @@ public static String format(final long millis, final String pattern, final TimeZ

/**
* <p>Formats a date/time into a specific pattern in a time zone.</p>
*
*
* @param date the date to format, not null
* @param pattern the pattern to use to format the date, not null
* @param timeZone the time zone to use, may be <code>null</code>
Expand All @@ -227,7 +227,7 @@ public static String format(final Date date, final String pattern, final TimeZon

/**
* <p>Formats a calendar into a specific pattern in a time zone.</p>
*
*
* @param calendar the calendar to format, not null
* @param pattern the pattern to use to format the calendar, not null
* @param timeZone the time zone to use, may be <code>null</code>
Expand All @@ -241,7 +241,7 @@ public static String format(final Calendar calendar, final String pattern, final

/**
* <p>Formats a date/time into a specific pattern in a locale.</p>
*
*
* @param millis the date to format expressed in milliseconds
* @param pattern the pattern to use to format the date, not null
* @param locale the locale to use, may be <code>null</code>
Expand All @@ -253,7 +253,7 @@ public static String format(final long millis, final String pattern, final Local

/**
* <p>Formats a date/time into a specific pattern in a locale.</p>
*
*
* @param date the date to format, not null
* @param pattern the pattern to use to format the date, not null
* @param locale the locale to use, may be <code>null</code>
Expand All @@ -265,7 +265,7 @@ public static String format(final Date date, final String pattern, final Locale

/**
* <p>Formats a calendar into a specific pattern in a locale.</p>
*
*
* @param calendar the calendar to format, not null
* @param pattern the pattern to use to format the calendar, not null
* @param locale the locale to use, may be <code>null</code>
Expand All @@ -279,7 +279,7 @@ public static String format(final Calendar calendar, final String pattern, final

/**
* <p>Formats a date/time into a specific pattern in a time zone and locale.</p>
*
*
* @param millis the date to format expressed in milliseconds
* @param pattern the pattern to use to format the date, not null
* @param timeZone the time zone to use, may be <code>null</code>
Expand All @@ -292,7 +292,7 @@ public static String format(final long millis, final String pattern, final TimeZ

/**
* <p>Formats a date/time into a specific pattern in a time zone and locale.</p>
*
*
* @param date the date to format, not null
* @param pattern the pattern to use to format the date, not null, not null
* @param timeZone the time zone to use, may be <code>null</code>
Expand All @@ -306,7 +306,7 @@ public static String format(final Date date, final String pattern, final TimeZon

/**
* <p>Formats a calendar into a specific pattern in a time zone and locale.</p>
*
*
* @param calendar the calendar to format, not null
* @param pattern the pattern to use to format the calendar, not null
* @param timeZone the time zone to use, may be <code>null</code>
Expand Down
32 changes: 16 additions & 16 deletions src/main/java/org/sqlite/date/FastDateParser.java
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,14 @@
* <p>FastDateParser is a fast and thread-safe version of
* {@link java.text.SimpleDateFormat}.</p>
*
* <p>To obtain a proxy to a FastDateParser, use {@link FastDateFormat#getInstance(String, TimeZone, Locale)}
* <p>To obtain a proxy to a FastDateParser, use {@link FastDateFormat#getInstance(String, TimeZone, Locale)}
* or another variation of the factory methods of {@link FastDateFormat}.</p>
*
*
* <p>Since FastDateParser is thread safe, you can use a static member instance:</p>
* <code>
* private static final DateParser DATE_PARSER = FastDateFormat.getInstance("yyyy-MM-dd");
* </code>
*
*
* <p>This class can be used as a direct replacement for
* <code>SimpleDateFormat</code> in most parsing situations.
* This class is especially useful in multi-threaded server environments.
Expand Down Expand Up @@ -96,8 +96,8 @@ public class FastDateParser implements DateParser, Serializable {

/**
* <p>Constructs a new FastDateParser.</p>
*
* Use {@link FastDateFormat#getInstance(String, TimeZone, Locale)} or another variation of the
*
* Use {@link FastDateFormat#getInstance(String, TimeZone, Locale)} or another variation of the
* factory methods of {@link FastDateFormat} to get a cached FastDateParser instance.
*
* @param pattern non-null {@link java.text.SimpleDateFormat} compatible
Expand Down Expand Up @@ -317,7 +317,7 @@ public Object parseObject(final String source, final ParsePosition pos) {
* given by {@link ParsePosition#getIndex()} has been updated. If the input buffer has been fully
* parsed, then the index will point to just after the end of the input buffer.
*
* @see org.apache.commons.lang3.time.DateParser#parse(java.lang.String, java.text.ParsePosition)
* See org.apache.commons.lang3.time.DateParser#parse(java.lang.String, java.text.ParsePosition)
* {@inheritDoc}
*/
public Date parse(final String source, final ParsePosition pos) {
Expand Down Expand Up @@ -430,7 +430,7 @@ int getFieldWidth() {
* A strategy to parse a single field from the parsing pattern
*/
private static abstract class Strategy {

/**
* Is this field a number?
* The default implementation returns false.
Expand All @@ -440,7 +440,7 @@ private static abstract class Strategy {
boolean isNumber() {
return false;
}

/**
* Set the Calendar with the parsed field.
*
Expand All @@ -453,7 +453,7 @@ boolean isNumber() {
void setCalendar(final FastDateParser parser, final Calendar cal, final String value) {

}

/**
* Generate a <code>Pattern</code> regular expression to the <code>StringBuilder</code>
* which will accept this field
Expand Down Expand Up @@ -497,7 +497,7 @@ private Strategy getStrategy(final String formatField, final Calendar definingCa
return getLocaleSpecificStrategy(Calendar.ERA, definingCalendar);
case 'H': // Hour in day (0-23)
return HOUR_OF_DAY_STRATEGY;
case 'K': // Hour in am/pm (0-11)
case 'K': // Hour in am/pm (0-11)
return HOUR_STRATEGY;
case 'M':
return formatField.length()>=3 ?getLocaleSpecificStrategy(Calendar.MONTH, definingCalendar) :NUMBER_MONTH_STRATEGY;
Expand Down Expand Up @@ -830,9 +830,9 @@ else if(value.startsWith("GMT")) {
cal.setTimeZone(tz);
}
}

private static class ISO8601TimeZoneStrategy extends Strategy {
// Z, +hh, -hh, +hhmm, -hhmm, +hh:mm or -hh:mm
// Z, +hh, -hh, +hhmm, -hhmm, +hh:mm or -hh:mm
private final String pattern;

/**
Expand All @@ -842,7 +842,7 @@ private static class ISO8601TimeZoneStrategy extends Strategy {
ISO8601TimeZoneStrategy(String pattern) {
this.pattern = pattern;
}

/**
* {@inheritDoc}
*/
Expand All @@ -851,7 +851,7 @@ boolean addRegex(FastDateParser parser, StringBuilder regex) {
regex.append(pattern);
return true;
}

/**
* {@inheritDoc}
*/
Expand All @@ -863,14 +863,14 @@ void setCalendar(FastDateParser parser, Calendar cal, String value) {
cal.setTimeZone(TimeZone.getTimeZone("GMT" + value));
}
}

private static final Strategy ISO_8601_1_STRATEGY = new ISO8601TimeZoneStrategy("(Z|(?:[+-]\\d{2}))");
private static final Strategy ISO_8601_2_STRATEGY = new ISO8601TimeZoneStrategy("(Z|(?:[+-]\\d{2}\\d{2}))");
private static final Strategy ISO_8601_3_STRATEGY = new ISO8601TimeZoneStrategy("(Z|(?:[+-]\\d{2}(?::)\\d{2}))");

/**
* Factory method for ISO8601TimeZoneStrategies.
*
*
* @param tokenLen a token indicating the length of the TimeZone String to be formatted.
* @return a ISO8601TimeZoneStrategy that can format TimeZone String of length {@code tokenLen}. If no such
* strategy exists, an IllegalArgumentException will be thrown.
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/org/sqlite/date/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@
*/
/**
* <p>Provides classes and methods to work with dates and durations.
* These classes are immutable (and therefore thread-safe) apart from {@link org.apache.commons.lang3.time.StopWatch}.</p>
* These classes are immutable (and therefore thread-safe) apart from org.apache.commons.lang3.time.StopWatch.</p>
*
* <p>The time package contains some basic utilities for manipulating time (a delorean, police box and grandfather clock?).
* These include a {@link org.apache.commons.lang3.time.StopWatch} for simple performance measurements and an optimised {@link org.sqlite.date.FastDateFormat} class.</p>
* These include a org.apache.commons.lang3.time.StopWatch for simple performance measurements and an optimised {@link org.sqlite.date.FastDateFormat} class.</p>
*
* <p>New in Lang 2.1 is the {@link org.apache.commons.lang3.time.DurationFormatUtils} class, which provides various methods for formatting durations.</p>
* <p>New in Lang 2.1 is the org.apache.commons.lang3.time.DurationFormatUtils class, which provides various methods for formatting durations.</p>
*
* @since 2.0
*/
Expand Down

0 comments on commit c8122cc

Please sign in to comment.