Add to result the raw, but parsed, bytes of byte segments in 2D barcodes

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

diff --git a/core/src/com/google/zxing/ResultMetadataType.java b/core/src/com/google/zxing/ResultMetadataType.java
index ca39b81..fd8c29f 100644 (file)
--- a/core/src/com/google/zxing/ResultMetadataType.java
+++ b/core/src/com/google/zxing/ResultMetadataType.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2008 Google Inc.
+ * Copyright 2008 ZXing authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,7 +20,7 @@ package com.google.zxing;
  * Represents some type of metadata about the result of the decoding that the decoder
  * wishes to communicate back to the caller.
  *
- * @author srowen@google.com (Sean Owen)
+ * @author Sean Owen
  */
 public final class ResultMetadataType {
 
@@ -40,6 +40,17 @@ public final class ResultMetadataType {
    */
   public static final ResultMetadataType ORIENTATION = new ResultMetadataType();
 
+  /**
+   * <p>2D barcode formats typically encode text, but allow for a sort of 'byte mode'
+   * which is sometimes used to encode binary data. While {@link Result} makes available
+   * the complete raw bytes in the barcode for these formats, it does not offer the bytes
+   * from the byte segments alone.</p>
+   *
+   * <p>This maps to a {@link java.util.Vector} of {@link byte[]}s corresponding to the
+   * raw bytes in the byte segments in the barcode, in order.</p>
+   */
+  public static final ResultMetadataType BYTE_SEGMENTS = new ResultMetadataType();
+
   private ResultMetadataType() {
   }