javax.print.attribute: abstract public class: IntegerSyntax

javax.print.attribute
abstract public class: IntegerSyntax [javadoc | source]

java.lang.Object
   javax.print.attribute.IntegerSyntax

All Implemented Interfaces:
Cloneable, Serializable

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

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.

author: David - Mendenhall

author: Alan - Kaminsky

Constructor:

Constructor:
protected IntegerSyntax(int value) { this.value = value; } Construct a new integer attribute with the given integer value. Parameters: `value` - Integer value.
protected IntegerSyntax(int value, int lowerBound, int upperBound) { if (lowerBound > value \|\| value > upperBound) { throw new IllegalArgumentException("Value " + value + " not in range " + lowerBound + ".." + upperBound); } this.value = value; } 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`. exception: `IllegalArgumentException` - (Unchecked exception) Thrown if `value` is less than `lowerBound` or greater than `upperBound`.

 protected IntegerSyntax(int value) {
        this.value = value;
}

Construct a new integer attribute with the given integer value.

Parameters:

value - Integer value.

 protected IntegerSyntax(int value,
    int lowerBound,
    int upperBound) {
        if (lowerBound  > value || value  > upperBound) {
            throw new IllegalArgumentException("Value " + value +
                                               " not in range " + lowerBound +
                                               ".." + upperBound);
        }
        this.value = value;
}

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.

exception: IllegalArgumentException - (Unchecked exception) Thrown if value is less than lowerBound or greater than upperBound.

Method from javax.print.attribute.IntegerSyntax Summary:
equals, getValue, hashCode, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.print.attribute.IntegerSyntax Detail:
public boolean equals(Object object) { return (object != null && object instanceof IntegerSyntax && value == ((IntegerSyntax) object).value); } 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.
public int getValue() { return value; } Returns this integer attribute's integer value.
public int hashCode() { return value; } Returns a hash code value for this integer attribute. The hash code is just this integer attribute's integer value.
public String toString() { return "" + value; } Returns a string value corresponding to this integer attribute. The string value is just this integer attribute's integer value converted to a string.

Method from javax.print.attribute.IntegerSyntax Detail:

 public boolean equals(Object object) {
        return (object != null && object instanceof IntegerSyntax &&
                value == ((IntegerSyntax) object).value);
}

object is not null.
object is an instance of class IntegerSyntax.
This integer attribute's value and object's value are equal.

 public int getValue() {
        return value;
}

Returns this integer attribute's integer value.

 public int hashCode() {
        return value;
}

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

 public String toString() {
        return "" + value;
}

Returns a string value corresponding to this integer attribute. The string value is just this integer attribute's integer value converted to a string.