01: /******************************************************************************
02: * JBoss, a division of Red Hat *
03: * Copyright 2006, Red Hat Middleware, LLC, and individual *
04: * contributors as indicated by the @authors tag. See the *
05: * copyright.txt in the distribution for a full listing of *
06: * individual contributors. *
07: * *
08: * This is free software; you can redistribute it and/or modify it *
09: * under the terms of the GNU Lesser General Public License as *
10: * published by the Free Software Foundation; either version 2.1 of *
11: * the License, or (at your option) any later version. *
12: * *
13: * This software is distributed in the hope that it will be useful, *
14: * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
16: * Lesser General Public License for more details. *
17: * *
18: * You should have received a copy of the GNU Lesser General Public *
19: * License along with this software; if not, write to the Free *
20: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA *
21: * 02110-1301 USA, or see the FSF site: http://www.fsf.org. *
22: ******************************************************************************/package org.jboss.portal.theme;
23:
24: /**
25: * Type safe enumeration of allowed orientations.
26: *
27: * @author <a href="mailto:mholzner@novell.com>Martin Holzner</a>
28: * @version $LastChangedRevision: 8784 $, $LastChangedDate: 2007-10-27 19:01:46 -0400 (Sat, 27 Oct 2007) $
29: */
30: public final class Orientation {
31:
32: /** Vertical. */
33: public static final Orientation VERTICAL = new Orientation(
34: "vertical");
35:
36: /** Horizontal. */
37: public static final Orientation HORIZONTAL = new Orientation(
38: "horizontal");
39:
40: /** The default value which is vertical. */
41: public static final Orientation DEFAULT = VERTICAL;
42:
43: /** The literal value. */
44: private final String value;
45:
46: private Orientation(String value) {
47: if (value == null) {
48: throw new IllegalArgumentException();
49: }
50: this .value = value;
51: }
52:
53: public String toString() {
54: return value;
55: }
56:
57: public boolean equals(Object o) {
58: if (this == o) {
59: return true;
60: }
61: if (o instanceof Orientation) {
62: Orientation that = (Orientation) o;
63: return this .value.equals(that.value);
64: }
65: return false;
66: }
67:
68: public int hashCode() {
69: return value.hashCode();
70: }
71:
72: /**
73: * Parse a string representation of an orientation into a defined type.
74: *
75: * @param orientation the string representation of the orientation
76: * @return the defined type for the string
77: * @throws IllegalArgumentException if the provided orientation String is invalid
78: */
79: public static Orientation parse(String orientation) {
80: if (orientation != null) {
81: if (orientation.equalsIgnoreCase(VERTICAL.toString())) {
82: return VERTICAL;
83: }
84: if (orientation.equalsIgnoreCase(HORIZONTAL.toString())) {
85: return HORIZONTAL;
86: }
87: }
88:
89: //
90: throw new IllegalArgumentException("Invalid orientation: "
91: + orientation);
92: }
93: }
|