Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
 /*
  *  Copyright 2001-2005 Stephen Colebourne
  *
  *  Licensed 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.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.joda.time.format;
Internal interface for parsing textual representations of time periods.

Application users will rarely use this class directly. Instead, you will use one of the factory classes to create a PeriodFormatter.

The factory classes are:
- PeriodFormatterBuilder
- PeriodFormat
- ISOPeriodFormat

Author(s):
Brian S O'Neill
Stephen Colebourne
Since:
1.0
See also:
PeriodFormatter
PeriodFormatterBuilder
PeriodFormat
public interface PeriodParser {

    
Parses a period from the given text, at the given position, saving the result into the fields of the given ReadWritablePeriod. If the parse succeeds, the return value is the new text position. Note that the parse may succeed without fully reading the text.

If it fails, the return value is negative, but the period may still be modified. To determine the position where the parse failed, apply the one's complement operator (~) on the return value.

Parameters:
period a period that will be modified
periodStr text to parse
position position to start parsing from
locale the locale to use for parsing
Returns:
new position, if negative, parse failed. Apply complement operator (~) to get position of failure
Throws:
java.lang.IllegalArgumentException if any field is out of range
    int parseInto(ReadWritablePeriod periodString periodStrint positionLocale locale);
New to GrepCode? Check out our FAQ X