Move character encoding logic out to common, try again to improve its handling of...

[zxing.git] / core / src / com / google / zxing / Writer.java

diff --git a/core/src/com/google/zxing/Writer.java b/core/src/com/google/zxing/Writer.java
index 21fcc3f..6474ca7 100644 (file)
--- a/core/src/com/google/zxing/Writer.java
+++ b/core/src/com/google/zxing/Writer.java
@@ -16,33 +16,39 @@
 
 package com.google.zxing;
 
-import com.google.zxing.common.ByteMatrix;
+import com.google.zxing.common.BitMatrix;
 
 import java.util.Hashtable;
 
+/**
+ * The base class for all objects which encode/generate a barcode image.
+ *
+ * @author dswitkin@google.com (Daniel Switkin)
+ */
 public interface Writer {
 
   /**
    * Encode a barcode using the default settings.
    *
-   * @param contents The raw contents to encode in the barcode
+   * @param contents The contents to encode in the barcode
    * @param format The barcode format to generate
    * @param width The preferred width in pixels
    * @param height The preferred height in pixels
    * @return The generated barcode as a Matrix of unsigned bytes (0 == black, 255 == white)
    */
-  ByteMatrix encode(byte[] contents, BarcodeFormat format, int width, int height) throws Exception;
+  BitMatrix encode(String contents, BarcodeFormat format, int width, int height)
+      throws WriterException;
 
   /**
    *
-   * @param contents The raw contents to encode in the barcode
+   * @param contents The contents to encode in the barcode
    * @param format The barcode format to generate
    * @param width The preferred width in pixels
    * @param height The preferred height in pixels
    * @param hints Additional parameters to supply to the encoder
    * @return The generated barcode as a Matrix of unsigned bytes (0 == black, 255 == white)
    */
-  ByteMatrix encode(byte[] contents, BarcodeFormat format, int width, int height, Hashtable hints)
-      throws Exception;
+  BitMatrix encode(String contents, BarcodeFormat format, int width, int height, Hashtable hints)
+      throws WriterException;
 
 }