KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > krysalis > barcode > BarGroup


1 /*
2  * $Id: BarGroup.java,v 1.6 2003/04/17 12:21:51 jmaerki Exp $
3  * ============================================================================
4  * The Krysalis Patchy Software License, Version 1.1_01
5  * Copyright (c) 2002-2003 Nicola Ken Barozzi. All rights reserved.
6  *
7  * This Licence is compatible with the BSD licence as described and
8  * approved by http://www.opensource.org/, and is based on the
9  * Apache Software Licence Version 1.1.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  *
15  * 1. Redistributions of source code must retain the above copyright
16  * notice, this list of conditions and the following disclaimer.
17  *
18  * 2. Redistributions in binary form must reproduce the above copyright
19  * notice, this list of conditions and the following disclaimer in
20  * the documentation and/or other materials provided with the
21  * distribution.
22  *
23  * 3. The end-user documentation included with the redistribution,
24  * if any, must include the following acknowledgment:
25  * "This product includes software developed for project
26  * Krysalis (http://www.krysalis.org/)."
27  * Alternately, this acknowledgment may appear in the software itself,
28  * if and wherever such third-party acknowledgments normally appear.
29  *
30  * 4. The names "Krysalis" and "Nicola Ken Barozzi" and
31  * "Krysalis Barcode" must not be used to endorse or promote products
32  * derived from this software without prior written permission. For
33  * written permission, please contact nicolaken@krysalis.org.
34  *
35  * 5. Products derived from this software may not be called "Krysalis",
36  * "Krysalis Barcode", nor may "Krysalis" appear in their name,
37  * without prior written permission of Nicola Ken Barozzi.
38  *
39  * 6. This software may contain voluntary contributions made by many
40  * individuals, who decided to donate the code to this project in
41  * respect of this licence, and was originally created by
42  * Jeremias Maerki <jeremias@maerki.org>.
43  *
44  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
45  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
46  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
47  * DISCLAIMED. IN NO EVENT SHALL THE KRYSALIS PROJECT OR
48  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
49  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
50  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
51  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
52  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
53  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
54  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
55  * SUCH DAMAGE.
56  * ====================================================================
57  */
58 package org.krysalis.barcode;
59
60 import java.util.Map JavaDoc;
61
62 import org.apache.avalon.framework.Enum;
63
64 /**
65  * Enumeration type for bar groups.
66  *
67  * @author Jeremias Maerki
68  */
69 public class BarGroup extends Enum JavaDoc {
70
71     private static final Map JavaDoc MAP = new java.util.HashMap JavaDoc();
72
73     /** Bar group is represents a start character */
74     public static final BarGroup START_CHARACTER = new BarGroup("start-char", MAP);
75     /** Bar group is represents a stop character */
76     public static final BarGroup STOP_CHARACTER = new BarGroup("stop-char", MAP);
77     /** Bar group is represents a message character or a part of the message */
78     public static final BarGroup MSG_CHARACTER = new BarGroup("msg-char", MAP);
79     /** Bar group is represents a UPC/EAN guard */
80     public static final BarGroup UPC_EAN_GUARD = new BarGroup("upc-ean-guard", MAP);
81     /** Bar group is represents a UPC/EAN lead */
82     public static final BarGroup UPC_EAN_LEAD = new BarGroup("upc-ean-lead", MAP);
83     /** Bar group is represents a UPC/EAN character group */
84     public static final BarGroup UPC_EAN_GROUP = new BarGroup("upc-ean-group", MAP);
85     /** Bar group is represents a UPC/EAN check character */
86     public static final BarGroup UPC_EAN_CHECK = new BarGroup("upc-ean-check", MAP);
87     /** Bar group is represents a UPC/EAN supplemental */
88     public static final BarGroup UPC_EAN_SUPP = new BarGroup("upc-ean-supp", MAP);
89
90     /**
91      * Creates a new BarGroup instance.
92      * @param name name of the BarGroup
93      * @param map Map to register the instance in.
94      */
95     protected BarGroup(String JavaDoc name, final Map JavaDoc map) {
96         super(name, map);
97     }
98     
99     /**
100      * Returns a BarGroup instance by name.
101      * @param name the name of the desired BarGroup
102      * @return the requested BarGroup instance
103      */
104     public static BarGroup byName(String JavaDoc name) {
105         final BarGroup bg = (BarGroup)MAP.get(name);
106         if (bg == null) {
107             throw new IllegalArgumentException JavaDoc("Invalid BarGroup: " + name);
108         }
109         return bg;
110     }
111     
112 }
113
Popular Tags