IntegerSyntax (Java 2 Platform SE v1.4.1_"07")

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

JavaTM 2 Platform
Std. Ed. v1.4.1_"07"

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javax.print.attribute
Class IntegerSyntax

    java.lang.Object
      |
      +--javax.print.attribute.IntegerSyntax

All Implemented Interfaces:
  Cloneable, Serializable

Direct Known Subclasses:
  Copies, JobImpressions, JobImpressionsCompleted, JobKOctets, JobKOctetsProcessed, JobMediaSheets, JobMediaSheetsCompleted, JobPriority, JobPrioritySupported, NumberOfDocuments, NumberOfInterveningJobs, NumberUp, PagesPerMinute, PagesPerMinuteColor, QueuedJobCount

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 ``getValue()``. An integer attribute's integer value is established when it is constructed (see ``IntegerSyntax(int)``). Once constructed, an integer attribute's value is immutable.

See Also:
  Serialized Form

Constructor Summary
`protected` | `IntegerSyntax(int value)` Construct a new integer attribute with the given integer 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.

Method Summary
`boolean` | `equals(Object object)` Returns whether this integer attribute is equivalent to the passed in object.
`int` | `getValue()` Returns this integer attribute's integer value.
`int` | `hashCode()` Returns a hash code value for this integer attribute.
`String` | `toString()` Returns a string value corresponding to this integer attribute.

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

### IntegerSyntax

    protected IntegerSyntax(int value)

  Construct a new integer attribute with the given integer value.

Parameters:
  `value` - Integer value.

### IntegerSyntax

    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.

Parameters:
  `value` - Integer value.
  `lowerBound` - Lower bound.
  `upperBound` - Upper bound.
Throws:
  `IllegalArgumentException` - (Unchecked exception) Thrown if `value` is less than `lowerBound` or greater than `upperBound`.

Method Detail

### getValue

    public int getValue()

  Returns this integer attribute's integer value.

  Returns:
    the integer value

### equals

    public boolean equals(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:
  1. `object` is not null.
  2. `object` is an instance of class IntegerSyntax.
  3. This integer attribute's value and `object`'s value are equal.

  Overrides:
    `equals` in class `Object`
  Parameters:
    `object` - Object to compare to.
  Returns:
    True if `object` is equivalent to this integer attribute, false otherwise.
  See Also:
    `Object.hashCode()`, `Hashtable`

### hashCode

    public int hashCode()

  Returns a hash code value for this integer attribute. The hash code is just this integer attribute's integer value.

  Overrides:
    `hashCode` in class `Object`
  Returns:
    a hash code value for this object.
  See Also:
    `Object.equals(java.lang.Object)`, `Hashtable`

### toString

    public 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.

  Overrides:
    `toString` in class `Object`
  Returns:
    a string representation of the object.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

JavaTM 2 Platform
Std. Ed. v1.4.1_"07"

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.