libjava/classpath/javax/print/attribute/standard/PageRanges.java

   1 /* PageRanges.java --
   2    Copyright (C) 2004, 2005 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package javax.print.attribute.standard;
  40
  41 import javax.print.attribute.DocAttribute;
  42 import javax.print.attribute.PrintJobAttribute;
  43 import javax.print.attribute.PrintRequestAttribute;
  44 import javax.print.attribute.SetOfIntegerSyntax;
  45
  46 /**
  47  * The <code>PageRanges</code> printing attribute specifies the
  48  * range(s) of pages to be printed in a print job.
  49  * <p>
  50  * <b>Note:</b> The effect of this attribute on jobs with multiple
  51  * documents is controlled by the job attribute
  52  * {@link javax.print.attribute.standard.MultipleDocumentHandling}.
  53  * </p>
  54  * <p>
  55  * <b>IPP Compatibility:</b> PageRanges is an IPP 1.1 attribute.
  56  * </p>
  57  *
  58  * @author Michael Koch (konqueror@gmx.de)
  59  * @author Wolfgang Baer (WBaer@gmx.de)
  60  */
  61 public final class PageRanges extends SetOfIntegerSyntax
  62   implements DocAttribute, PrintRequestAttribute, PrintJobAttribute
  63 {
  64   private static final long serialVersionUID = 8639895197656148392L;
  65
  66   /**
  67    * Constructs a <code>PageRanges</code> object with only one
  68    * page to be printed.
  69    *
  70    * @param member the only page to be printed.
  71    *
  72    * @exception IllegalArgumentException if member is &lt; 1
  73    */
  74   public PageRanges(int member)
  75   {
  76     super(member);
  77
  78     if (member < 1)
  79       throw new IllegalArgumentException("member may not be less than 1");
  80   }
  81
  82   /**
  83    * Constructs a <code>PageRanges</code> object with a set
  84    * of ranges to be printed.
  85    *
  86    * @param members the page ranges to be printed.
  87    *
  88    * @exception IllegalArgumentException if any element is invalid
  89    * @exception NullPointerException if members is <code>null</code> or any
  90    * element of members is <code>null</code>.
  91    */
  92   public PageRanges(int[][] members)
  93   {
  94     super(members);
  95
  96     if (members == null)
  97       throw new NullPointerException("members may not be null");
  98   }
  99
 100   /**
 101    * Constructs a <code>PageRanges</code> object with the
 102    * given single range of pages to be printed.
 103    *
 104    * @param lowerBound the lower bound value
 105    * @param upperBound the upper bound value
 106    *
 107    * @exception IllegalArgumentException if lowerBound &lt;= upperbound
 108    * and lowerBound &lt; 1
 109    */
 110   public PageRanges(int lowerBound, int upperBound)
 111   {
 112     super(lowerBound, upperBound);
 113
 114     if (lowerBound < 1)
 115       throw new IllegalArgumentException("lowerbound may not be less than 1");
 116   }
 117
 118   /**
 119    * Constructs a <code>PageRanges</code> object with a set
 120    * of ranges to be printed in string array form.
 121    *
 122    * @param members the page ranges to be printed in string form.
 123    *
 124    * @exception IllegalArgumentException if any element is invalid.
 125    * @exception NullPointerException if members is <code>null</code> or any
 126    * element of members is <code>null</code>.
 127    */
 128   public PageRanges(String members)
 129   {
 130     super(members);
 131
 132     if (members == null)
 133       throw new NullPointerException("members may not be null");
 134   }
 135
 136   /**
 137    * Tests if the given object is equal to this object.
 138    *
 139    * @param obj the object to test
 140    *
 141    * @return <code>true</code> if both objects are equal,
 142    * <code>false</code> otherwise.
 143    */
 144   public boolean equals(Object obj)
 145   {
 146     if (! (obj instanceof PageRanges))
 147       return false;
 148
 149     return super.equals(obj);
 150   }
 151
 152   /**
 153    * Returns category of this class.
 154    *
 155    * @return The class <code>PageRanges</code> itself.
 156    */
 157   public Class getCategory()
 158   {
 159     return PageRanges.class;
 160   }
 161
 162   /**
 163    * Returns the name of this attribute.
 164    *
 165    * @return The name "page-ranges".
 166    */
 167   public String getName()
 168   {
 169     return "page-ranges";
 170   }
 171 }