|
Java example source code file (PeriodParser.java)
The PeriodParser.java Java example source code/* * 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; import java.util.Locale; import org.joda.time.ReadWritablePeriod; /** * Internal interface for parsing textual representations of time periods. * <p> * Application users will rarely use this class directly. Instead, you * will use one of the factory classes to create a {@link PeriodFormatter}. * <p> * The factory classes are:<br /> * - {@link PeriodFormatterBuilder}<br /> * - {@link PeriodFormat}<br /> * - {@link ISOPeriodFormat}<br /> * * @author Brian S O'Neill * @author Stephen Colebourne * @since 1.0 * @see PeriodFormatter * @see PeriodFormatterBuilder * @see 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. * <p> * 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. * * @param period a period that will be modified * @param periodStr text to parse * @param position position to start parsing from * @param locale the locale to use for parsing * @return new position, if negative, parse failed. Apply complement * operator (~) to get position of failure * @throws IllegalArgumentException if any field is out of range */ int parseInto(ReadWritablePeriod period, String periodStr, int position, Locale locale); } Other Java examples (source code examples)Here is a short list of links related to this Java PeriodParser.java source code file: |
... this post is sponsored by my books ... | |
#1 New Release! |
FP Best Seller |
Copyright 1998-2024 Alvin Alexander, alvinalexander.com
All Rights Reserved.
A percentage of advertising revenue from
pages under the /java/jwarehouse
URI on this website is
paid back to open source projects.