zxing/csharp/Reader.cs

using System.Collections.Generic;

/*
 * Copyright 2007 ZXing authors
 *
 * 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.
 */

namespace com.google.zxing
{


	/// <summary>
	/// Implementations of this interface can decode an image of a barcode in some format into
	/// the String it encodes. For example, <seealso cref="com.google.zxing.qrcode.QRCodeReader"/> can
	/// decode a QR code. The decoder may optionally receive hints from the caller which may help
	/// it decode more quickly or accurately.
	/// 
	/// See <seealso cref="com.google.zxing.MultiFormatReader"/>, which attempts to determine what barcode
	/// format is present within the image as well, and then decodes it accordingly.
	/// 
	/// @author Sean Owen
	/// @author dswitkin@google.com (Daniel Switkin)
	/// </summary>
	public interface Reader
	{

	  /// <summary>
	  /// Locates and decodes a barcode in some format within an image.
	  /// </summary>
	  /// <param name="image"> image of barcode to decode </param>
	  /// <returns> String which the barcode encodes </returns>
	  /// <exception cref="NotFoundException"> if the barcode cannot be located or decoded for any reason </exception>
//JAVA TO C# CONVERTER WARNING: Method 'throws' clauses are not available in .NET:
//ORIGINAL LINE: Result decode(BinaryBitmap image) throws NotFoundException, ChecksumException, FormatException;
	  Result decode(BinaryBitmap image);

	  /// <summary>
	  /// Locates and decodes a barcode in some format within an image. This method also accepts
	  /// hints, each possibly associated to some data, which may help the implementation decode.
	  /// </summary>
	  /// <param name="image"> image of barcode to decode </param>
	  /// <param name="hints"> passed as a <seealso cref="java.util.Map"/> from <seealso cref="com.google.zxing.DecodeHintType"/>
	  /// to arbitrary data. The
	  /// meaning of the data depends upon the hint type. The implementation may or may not do
	  /// anything with these hints. </param>
	  /// <returns> String which the barcode encodes </returns>
	  /// <exception cref="NotFoundException"> if the barcode cannot be located or decoded for any reason </exception>
//JAVA TO C# CONVERTER WARNING: Method 'throws' clauses are not available in .NET:
//ORIGINAL LINE: Result decode(BinaryBitmap image, java.util.Map<DecodeHintType,?> hints) throws NotFoundException, ChecksumException, FormatException;
      Result decode(BinaryBitmap image, IDictionary<DecodeHintType,object> hints);

	  /// <summary>
	  /// Resets any internal state the implementation has after a decode, to prepare it
	  /// for reuse.
	  /// </summary>
	  void reset();

	}
}