Source for javax.print.attribute.standard.PageRanges

   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.Attribute;
  42: import javax.print.attribute.DocAttribute;
  43: import javax.print.attribute.PrintJobAttribute;
  44: import javax.print.attribute.PrintRequestAttribute;
  45: import javax.print.attribute.SetOfIntegerSyntax;
  46: 
  47: /**
  48:  * The <code>PageRanges</code> printing attribute specifies the 
  49:  * range(s) of pages to be printed in a print job.
  50:  * <p>
  51:  * <b>Note:</b> The effect of this attribute on jobs with multiple 
  52:  * documents is controlled by the job attribute 
  53:  * {@link javax.print.attribute.standard.MultipleDocumentHandling}.
  54:  * </p>
  55:  * <p>
  56:  * <b>IPP Compatibility:</b> PageRanges is an IPP 1.1 attribute.
  57:  * </p>
  58:  * 
  59:  * @author Michael Koch (konqueror@gmx.de)
  60:  * @author Wolfgang Baer (WBaer@gmx.de)
  61:  */
  62: public final class PageRanges extends SetOfIntegerSyntax
  63:   implements DocAttribute, PrintRequestAttribute, PrintJobAttribute
  64: {
  65:   private static final long serialVersionUID = 8639895197656148392L;
  66: 
  67:   /**
  68:    * Constructs a <code>PageRanges</code> object with only one
  69:    * page to be printed.
  70:    *
  71:    * @param member the only page to be printed.
  72:    *
  73:    * @exception IllegalArgumentException if member is &lt; 1
  74:    */
  75:   public PageRanges(int member)
  76:   {
  77:     super(member);
  78:     
  79:     if (member < 1)
  80:       throw new IllegalArgumentException("member may not be less than 1");
  81:   }
  82: 
  83:   /**
  84:    * Constructs a <code>PageRanges</code> object with a set
  85:    * of ranges to be printed.
  86:    *
  87:    * @param members the page ranges to be printed.
  88:    *
  89:    * @exception IllegalArgumentException if any element is invalid
  90:    * @exception NullPointerException if members is <code>null</code> or any 
  91:    * element of members is <code>null</code>.
  92:    */
  93:   public PageRanges(int[][] members)
  94:   {
  95:     super(members);
  96:     
  97:     if (members == null)
  98:       throw new NullPointerException("members may not be null");
  99:   }
 100: 
 101:   /**
 102:    * Constructs a <code>PageRanges</code> object with the
 103:    * given single range of pages to be printed.
 104:    *
 105:    * @param lowerBound the lower bound value
 106:    * @param upperBound the upper bound value
 107:    *
 108:    * @exception IllegalArgumentException if lowerBound &lt;= upperbound
 109:    * and lowerBound &lt; 1
 110:    */
 111:   public PageRanges(int lowerBound, int upperBound)
 112:   {
 113:     super(lowerBound, upperBound);
 114:     
 115:     if (lowerBound < 1)
 116:       throw new IllegalArgumentException("lowerbound may not be less than 1");
 117:   }
 118:   
 119:   /**
 120:    * Constructs a <code>PageRanges</code> object with a set
 121:    * of ranges to be printed in string array form.
 122:    *
 123:    * @param members the page ranges to be printed in string form.
 124:    *
 125:    * @exception IllegalArgumentException if any element is invalid.
 126:    * @exception NullPointerException if members is <code>null</code> or any 
 127:    * element of members is <code>null</code>.
 128:    */
 129:   public PageRanges(String members)
 130:   {
 131:     super(members);
 132:     
 133:     if (members == null)
 134:       throw new NullPointerException("members may not be null");
 135:   }
 136:   
 137:   /**
 138:    * Tests if the given object is equal to this object.
 139:    *
 140:    * @param obj the object to test
 141:    *
 142:    * @return <code>true</code> if both objects are equal, 
 143:    * <code>false</code> otherwise.
 144:    */
 145:   public boolean equals(Object obj)
 146:   {
 147:     if (! (obj instanceof PageRanges))
 148:       return false;
 149:    
 150:     return super.equals(obj);
 151:   }
 152: 
 153:   /**
 154:    * Returns category of this class.
 155:    *
 156:    * @return The class <code>PageRanges</code> itself.
 157:    */
 158:   public Class< ? extends Attribute> getCategory()
 159:   {
 160:     return PageRanges.class;
 161:   }
 162: 
 163:   /**
 164:    * Returns the name of this attribute.
 165:    *
 166:    * @return The name "page-ranges".
 167:    */
 168:   public String getName()
 169:   {
 170:     return "page-ranges";
 171:   }
 172: }