Apache
/
commons-lang
mirror of https://github.com/apache/commons-lang.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Minor Javadoc (style.) 

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/lang/trunk@329277 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Gary D. Gregory 2005-10-28 19:49:47 +00:00
parent 01d50f2e00
commit d85ab0c576
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
src/java/org/apache/commons/lang/time/DurationFormatUtils.java
View File

@ -67,7 +67,7 @@ public DurationFormatUtils() {
//----------------------------------------------------------------------- //-----------------------------------------------------------------------
/** /**
* <p>Get the time gap as a string.</p> * <p>Formats the time gap as a string.</p>
* *
* <p>The format used is ISO8601-like: * <p>The format used is ISO8601-like:
* <i>H</i>:<i>m</i>:<i>s</i>.<i>S</i>.</p> * <i>H</i>:<i>m</i>:<i>s</i>.<i>S</i>.</p>
@ -80,7 +80,7 @@ public static String formatDurationHMS(long durationMillis) {
} }
/** /**
* <p>Get the time gap as a string.</p> * <p>Formats the time gap as a string.</p>
* *
* <p>The format used is the ISO8601 period format.</p> * <p>The format used is the ISO8601 period format.</p>
* *
@ -95,7 +95,7 @@ public static String formatDurationISO(long durationMillis) {
} }
/** /**
* <p>Get the time gap as a string, using the specified format, and padding with zeros and * <p>Formats the time gap as a string, using the specified format, and padding with zeros and
* using the default timezone.</p> * using the default timezone.</p>
* *
* <p>This method formats durations using the days and lower fields of the * <p>This method formats durations using the days and lower fields of the
@ -110,7 +110,7 @@ public static String formatDuration(long durationMillis, String format) {
} }
/** /**
* <p>Get the time gap as a string, using the specified format. * <p>Formats the time gap as a string, using the specified format.
* Padding the left hand side of numbers with zeroes is optional and * Padding the left hand side of numbers with zeroes is optional and
* the timezone may be specified.</p> * the timezone may be specified.</p>
* *
@ -156,7 +156,7 @@ public static String formatDuration(long durationMillis, String format, boolean
} }
/** /**
* <p>Format an elapsed time into a plurialization correct string.</p> * <p>Formats an elapsed time into a plurialization correct string.</p>
* *
* <p>This method formats durations using the days and lower fields of the * <p>This method formats durations using the days and lower fields of the
* format pattern. Months and larger are not used.</p> * format pattern. Months and larger are not used.</p>
@ -220,7 +220,7 @@ public static String formatDurationWords(
//----------------------------------------------------------------------- //-----------------------------------------------------------------------
/** /**
* <p>Get the time gap as a string.</p> * <p>Formats the time gap as a string.</p>
* *
* <p>The format used is the ISO8601 period format.</p> * <p>The format used is the ISO8601 period format.</p>
* *
@ -233,7 +233,7 @@ public static String formatPeriodISO(long startMillis, long endMillis) {
} }
/** /**
* <p>Get the time gap as a string, using the specified format. * <p>Formats the time gap as a string, using the specified format.
* Padding the left hand side of numbers with zeroes is optional. * Padding the left hand side of numbers with zeroes is optional.
* *
* @param startMillis the start of the duration * @param startMillis the start of the duration
@ -246,7 +246,7 @@ public static String formatPeriod(long startMillis, long endMillis, String forma
} }
/** /**
* <p>Get the time gap as a string, using the specified format. * <p>Formats the time gap as a string, using the specified format.
* Padding the left hand side of numbers with zeroes is optional and * Padding the left hand side of numbers with zeroes is optional and
* the timezone may be specified. * the timezone may be specified.
* *
@ -456,7 +456,7 @@ static int reduceAndCorrect(Calendar start, Calendar end, int field, int differe
static final Object S = "S"; static final Object S = "S";
/** /**
* Parse a classic date format string into Tokens * Parses a classic date format string into Tokens
* *
* @param format to parse * @param format to parse
* @return Token[] of tokens * @return Token[] of tokens
@ -543,7 +543,7 @@ static boolean containsTokenWithValue(Token[] tokens, Object value) {
private int count; private int count;
/** /**
* Wrap a token around a value. A value would be something like a 'Y'. * Wraps a token around a value. A value would be something like a 'Y'.
* *
* @param value to wrap * @param value to wrap
*/ */
@ -553,7 +553,7 @@ static boolean containsTokenWithValue(Token[] tokens, Object value) {
} }
/** /**
* Wrap a token around a repeated number of a value, for example it would * Wraps a token around a repeated number of a value, for example it would
* store 'yyyy' as a value for y and a count of 4. * store 'yyyy' as a value for y and a count of 4.
* *
* @param value to wrap * @param value to wrap
@ -565,14 +565,14 @@ static boolean containsTokenWithValue(Token[] tokens, Object value) {
} }
/** /**
* Add another one of the value * Adds another one of the value
*/ */
void increment() { void increment() {
count++; count++;
} }
/** /**
* Get the current number of values represented * Gets the current number of values represented
* *
* @return int number of values represented * @return int number of values represented
*/ */
@ -581,7 +581,7 @@ int getCount() {
} }
/** /**
* Get the particular value this token represents. * Gets the particular value this token represents.
* *
* @return Object value * @return Object value
*/ */
@ -617,7 +617,7 @@ public boolean equals(Object obj2) {
} }
/** /**
* Represent this token as a String. * Represents this token as a String.
* *
* @return String representation of the token * @return String representation of the token
*/ */