KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: HumanReadablePlacement.java,v 1.2 2003/02/28 11:23:48 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 org.apache.avalon.framework.Enum;
61
62 /**
63  * Enumeration for placement of the human readable part of a barcode.
64  *
65  * @author Jeremias Maerki
66  */
67 public class HumanReadablePlacement extends Enum JavaDoc {
68
69     /** The human-readable part is suppressed. */
70     public static final HumanReadablePlacement HRP_NONE
71                                     = new HumanReadablePlacement("none");
72     /** The human-readable part is placed at the top of the barcode. */
73     public static final HumanReadablePlacement HRP_TOP
74                                     = new HumanReadablePlacement("top");
75     /** The human-readable part is placed at the bottom of the barcode. */
76     public static final HumanReadablePlacement HRP_BOTTOM
77                                     = new HumanReadablePlacement("bottom");
78
79     /**
80      * Creates a new HumanReadablePlacement instance.
81      * @param name the name for the instance
82      */
83     protected HumanReadablePlacement(String JavaDoc name) {
84         super(name);
85     }
86     
87     /**
88      * Returns a HumanReadablePlacement instance by name.
89      * @param name the name of the instance
90      * @return the requested instance
91      */
92     public static HumanReadablePlacement byName(String JavaDoc name) {
93         if (name.equalsIgnoreCase(HumanReadablePlacement.HRP_NONE.getName())) {
94             return HumanReadablePlacement.HRP_NONE;
95         } else if (name.equalsIgnoreCase(HumanReadablePlacement.HRP_TOP.getName())) {
96             return HumanReadablePlacement.HRP_TOP;
97         } else if (name.equalsIgnoreCase(HumanReadablePlacement.HRP_BOTTOM.getName())) {
98             return HumanReadablePlacement.HRP_BOTTOM;
99         } else {
100             throw new IllegalArgumentException JavaDoc(
101                 "Invalid HumanReadablePlacement: " + name);
102         }
103     }
104     
105
106 }
Popular Tags