core/src/com/google/zxing/Writer.java

   1 /*
   2  * Copyright 2008 ZXing authors
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package com.google.zxing;
  18
  19 import com.google.zxing.common.ByteMatrix;
  20
  21 import java.util.Hashtable;
  22
  23 public interface Writer {
  24
  25   /**
  26    * Encode a barcode using the default settings.
  27    *
  28    * @param contents The raw contents to encode in the barcode
  29    * @param format The barcode format to generate
  30    * @param width The preferred width in pixels
  31    * @param height The preferred height in pixels
  32    * @return The generated barcode as a Matrix of unsigned bytes (0 == black, 255 == white)
  33    */
  34   ByteMatrix encode(byte[] contents, BarcodeFormat format, int width, int height) throws Exception;
  35
  36   /**
  37    *
  38    * @param contents The raw contents to encode in the barcode
  39    * @param format The barcode format to generate
  40    * @param width The preferred width in pixels
  41    * @param height The preferred height in pixels
  42    * @param hints Additional parameters to supply to the encoder
  43    * @return The generated barcode as a Matrix of unsigned bytes (0 == black, 255 == white)
  44    */
  45   ByteMatrix encode(byte[] contents, BarcodeFormat format, int width, int height, Hashtable hints)
  46       throws Exception;
  47
  48 }