File Doc Category Size Date Package
IntegerSyntax.java API Doc Java SE 5 API 3427 Fri Aug 26 14:57:44 BST 2005 javax.print.attribute

IntegerSyntax

java.lang.Object

public abstract class IntegerSyntax extends Object implements Serializable, Cloneable

Class IntegerSyntax is an abstract base class providing the common implementation of all attributes with integer values.

Under the hood, an integer attribute is just an integer. You can get an integer attribute's integer value by calling {@link #getValue() getValue()}. An integer attribute's integer value is established when it is constructed (see {@link #IntegerSyntax(int) IntegerSyntax(int)}). Once constructed, an integer attribute's value is immutable.

author: David Mendenhall
author: Alan Kaminsky

Fields Summary
private static final long
serialVersionUID
private int
value
This integer attribute's integer value.
Constructors Summary
protected IntegerSyntax(int value)
Construct a new integer attribute with the given integer value.
param
value Integer value.
this.value = value;
protected IntegerSyntax(int value, int lowerBound, int upperBound)
Construct a new integer attribute with the given integer value, which must lie within the given range.
param
value Integer value.
param
lowerBound Lower bound.
param
upperBound Upper bound.
exception
IllegalArgumentException (Unchecked exception) Thrown if value is less than lowerBound or greater than upperBound.
if (lowerBound > value || value > upperBound) { throw new IllegalArgumentException("Value " + value + " not in range " + lowerBound + ".." + upperBound); } this.value = value;
Methods Summary
public boolean equals(java.lang.Object object)
Returns whether this integer attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true:

object is not null.
object is an instance of class IntegerSyntax.
This integer attribute's value and object's value are equal.
param
object Object to compare to.
return
True if object is equivalent to this integer attribute, false otherwise.
return (object != null && object instanceof IntegerSyntax && value == ((IntegerSyntax) object).value);
public int getValue()
Returns this integer attribute's integer value.
return
the integer value
return value;
public int hashCode()
Returns a hash code value for this integer attribute. The hash code is just this integer attribute's integer value.
return value;
public java.lang.String toString()
Returns a string value corresponding to this integer attribute. The string value is just this integer attribute's integer value converted to a string.
return "" + value;