javax.print.attribute.standard

Class PageRanges

Implemented Interfaces:
Attribute, Cloneable, DocAttribute, PrintJobAttribute, PrintRequestAttribute, Serializable

public final class PageRanges
extends SetOfIntegerSyntax
implements DocAttribute, PrintRequestAttribute, 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

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

Method Summary

Class<
? extends Attribute> getCategory()
Returns category of this class.
boolean
equals(Object obj)
Tests if the given object is equal to this object.
String
getName()
Returns the name of this attribute.

Methods inherited from class javax.print.attribute.SetOfIntegerSyntax

contains, contains, equals, getMembers, hashCode, next, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

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:
IllegalArgumentException - if member is < 1

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:
IllegalArgumentException - if lowerBound <= upperbound and lowerBound < 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:
IllegalArgumentException - if any element is invalid
NullPointerException - if members is null or any element of members is null.

PageRanges

public PageRanges(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:
IllegalArgumentException - if any element is invalid.
NullPointerException - if members is null or any element of members is null.

Method Details

? extends Attribute> getCategory

public Class< ? extends Attribute> getCategory()
Returns category of this class.
Specified by:
? extends Attribute> getCategory in interface Attribute
Returns:
The class PageRanges itself.

equals

public boolean equals(Object obj)
Tests if the given object is equal to this object.
Overrides:
equals in interface SetOfIntegerSyntax
Parameters:
obj - the object to test
Returns:
true if both objects are equal, false otherwise.

getName

public String getName()
Returns the name of this attribute.
Specified by:
getName in interface Attribute
Returns:
The name "page-ranges".

PageRanges.java -- Copyright (C) 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.