javax.print.attribute.standard

Class PageRanges

java.lang.Object

javax.print.attribute.SetOfIntegerSyntax

javax.print.attribute.standard.PageRanges

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.print.attribute.Attribute, javax.print.attribute.DocAttribute, javax.print.attribute.PrintJobAttribute, javax.print.attribute.PrintRequestAttribute

public final class PageRanges
extends javax.print.attribute.SetOfIntegerSyntax
implements javax.print.attribute.DocAttribute, javax.print.attribute.PrintRequestAttribute, javax.print.attribute.PrintJobAttribute

The PageRanges printing attribute specifies the range(s) of pages to be printed in a print job.

Note: The effect of this attribute on jobs with multiple documents is controlled by the job attribute MultipleDocumentHandling.

IPP Compatibility: PageRanges is an IPP 1.1 attribute.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PageRanges(int member) Constructs a PageRanges object with only one page to be printed.
PageRanges(int[][] members) Constructs a PageRanges object with a set of ranges to be printed.
PageRanges(int lowerBound, int upperBound) Constructs a PageRanges object with the given single range of pages to be printed.
PageRanges(java.lang.String members) Constructs a PageRanges object with a set of ranges to be printed in string array form.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Tests if the given object is equal to this object.
java.lang.Class<? extends javax.print.attribute.Attribute>	getCategory() Returns category of this class.
java.lang.String	getName() Returns the name of this attribute.

Methods inherited from class javax.print.attribute.SetOfIntegerSyntax

contains, contains, getMembers, hashCode, next, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PageRanges

public PageRanges(int member)

Constructs a PageRanges object with only one page to be printed.

Parameters:

member - the only page to be printed.

Throws:

java.lang.IllegalArgumentException - if member is < 1

PageRanges

public PageRanges(int[][] members)

Constructs a PageRanges object with a set of ranges to be printed.

Parameters:

members - the page ranges to be printed.

Throws:

java.lang.IllegalArgumentException - if any element is invalid

java.lang.NullPointerException - if members is null or any element of members is null.

PageRanges

public PageRanges(int lowerBound,
          int upperBound)

Constructs a PageRanges object with the given single range of pages to be printed.

Parameters:

lowerBound - the lower bound value

upperBound - the upper bound value

Throws:

java.lang.IllegalArgumentException - if lowerBound <= upperbound and lowerBound < 1

PageRanges

public PageRanges(java.lang.String members)

Constructs a PageRanges object with a set of ranges to be printed in string array form.

Parameters:

members - the page ranges to be printed in string form.

Throws:

java.lang.IllegalArgumentException - if any element is invalid.

java.lang.NullPointerException - if members is null or any element of members is null.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Tests if the given object is equal to this object.

Overrides:

equals in class javax.print.attribute.SetOfIntegerSyntax

Parameters:

obj - the object to test

Returns:

true if both objects are equal, false otherwise.

See Also:

Object.hashCode()

getCategory

public java.lang.Class<? extends javax.print.attribute.Attribute> getCategory()

Returns category of this class.

Specified by:

getCategory in interface javax.print.attribute.Attribute

Returns:

The class PageRanges itself.

getName

public java.lang.String getName()

Returns the name of this attribute.

Specified by:

getName in interface javax.print.attribute.Attribute

Returns:

The name "page-ranges".