Committed C# port from Mohamad
[zxing.git] / csharp / ResultMetadataType.cs
1 /*\r
2 * Licensed under the Apache License, Version 2.0 (the "License");\r
3 * you may not use this file except in compliance with the License.\r
4 * You may obtain a copy of the License at\r
5 *\r
6 *      http://www.apache.org/licenses/LICENSE-2.0\r
7 *\r
8 * Unless required by applicable law or agreed to in writing, software\r
9 * distributed under the License is distributed on an "AS IS" BASIS,\r
10 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
11 * See the License for the specific language governing permissions and\r
12 * limitations under the License.\r
13 */\r
14 \r
15 using System;\r
16 using System.Collections;\r
17 \r
18 namespace com.google.zxing\r
19 {\r
20 \r
21     /// <summary> The general exception class throw when something goes wrong during decoding of a barcode.\r
22     /// This includes, but is not limited to, failing checksums / error correction algorithms, being\r
23     /// unable to locate finder timing patterns, and so on.\r
24     /// \r
25     /// </summary>\r
26     /// <author>  srowen@google.com (Sean Owen)\r
27     /// </author>\r
28     //[Serializable]\r
29     public sealed class ResultMetadataType\r
30     {\r
31           // No, we can't use an enum here. J2ME doesn't support it.\r
32 \r
33           /**\r
34            * Unspecified, application-specific metadata. Maps to an unspecified {@link Object}.\r
35            */\r
36           public static ResultMetadataType OTHER = new ResultMetadataType();\r
37 \r
38           /**\r
39            * Denotes the likely approximate orientation of the barcode in the image. This value\r
40            * is given as degrees rotated clockwise from the normal, upright orientation.\r
41            * For example a 1D barcode which was found by reading top-to-bottom would be\r
42            * said to have orientation "90". This key maps to an {@link Integer} whose\r
43            * value is in the range [0,360).\r
44            */\r
45           public static ResultMetadataType ORIENTATION = new ResultMetadataType();\r
46 \r
47           /**\r
48            * <p>2D barcode formats typically encode text, but allow for a sort of 'byte mode'\r
49            * which is sometimes used to encode binary data. While {@link Result} makes available\r
50            * the complete raw bytes in the barcode for these formats, it does not offer the bytes\r
51            * from the byte segments alone.</p>\r
52            *\r
53            * <p>This maps to a {@link java.util.Vector} of byte arrays corresponding to the\r
54            * raw bytes in the byte segments in the barcode, in order.</p>\r
55            */\r
56           public static ResultMetadataType BYTE_SEGMENTS = new ResultMetadataType();\r
57 \r
58           private ResultMetadataType() {\r
59           }\r
60     \r
61     \r
62     }\r
63 }