org.joda.money.format.MoneyParser Maven / Gradle / Ivy
/*
* Copyright 2009-present, 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.money.format;
/**
* Parses part of a textual input string of monetary information.
*
* The parser is expected to start parsing at the specified text position
* and match against whatever it represents.
* The parsed result must be stored in the context.
* The context also provides the current parse position which must be updated.
*
* This interface must be implemented with care to ensure other classes operate correctly.
* All instantiable implementations must be thread-safe, and should generally
* be final and immutable.
*/
public interface MoneyParser {
/**
* Parses monetary information using a textual representation.
*
* The text and parse index are stored in the context.
* The parsed data and updated index is also stored in the context.
*
* Implementations should avoid throwing exceptions and use the error index
* in the context instead to record the problem.
* The context can be assumed to not be in error on entry to this method.
*
* The context is not a thread-safe object and a new instance will be created
* for each parse. The context must not be stored in an instance variable
* or shared with any other threads.
*
* @param context the context to use and parse into, not null
*/
void parse(MoneyParseContext context);
}