001 /* IntegerSyntax.java --
002 Copyright (C) 2003, 2004, 2005 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038 package javax.print.attribute;
039
040 import java.io.Serializable;
041
042 /**
043 * <code>IntegerSyntax</code> is the abstract base class of all attribute
044 * classes having an integer as value.
045 *
046 * @author Michael Koch (konqueror@gmx.de)
047 */
048 public abstract class IntegerSyntax implements Cloneable, Serializable
049 {
050 private int value;
051
052 /**
053 * Creates a <code>IntegerSyntax</code> with the given value.
054 *
055 * @param value the integer to set
056 */
057 protected IntegerSyntax(int value)
058 {
059 this.value = value;
060 }
061
062 /**
063 * Creates a <code>IntegerSyntax</code> with the given integer value
064 * and checks if the value lies inside the given bounds..
065 *
066 * @param value the integer to set
067 * @param lowerBound the lower bound for the value
068 * @param upperBound the upper bound for the value
069 *
070 * @exception IllegalArgumentException if value < lowerBound
071 * or value > upperBound
072 */
073 protected IntegerSyntax(int value, int lowerBound, int upperBound)
074 {
075 if (value < lowerBound
076 || value > upperBound)
077 throw new IllegalArgumentException("value not in range");
078
079 this.value = value;
080 }
081
082 /**
083 * Returns the value of this object.
084 *
085 * @return The integer value.
086 */
087 public int getValue()
088 {
089 return value;
090 }
091
092 /**
093 * Tests if the given object is equal to this object.
094 *
095 * @param obj the object to test
096 *
097 * @return <code>true</code> if both objects are equal,
098 * <code>false</code> otherwise.
099 */
100 public boolean equals(Object obj)
101 {
102 if(! (obj instanceof IntegerSyntax))
103 return false;
104
105 return value == ((IntegerSyntax) obj).getValue();
106 }
107
108 /**
109 * Returns the hashcode for this object.
110 *
111 * @return The hashcode.
112 */
113 public int hashCode()
114 {
115 return value;
116 }
117
118 /**
119 * Returns the string representation for this object.
120 *
121 * @return The string representation.
122 */
123 public String toString()
124 {
125 return "" + value;
126 }
127 }