001    /* PageRanges.java --
002       Copyright (C) 2004, 2005 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package javax.print.attribute.standard;
040    
041    import javax.print.attribute.Attribute;
042    import javax.print.attribute.DocAttribute;
043    import javax.print.attribute.PrintJobAttribute;
044    import javax.print.attribute.PrintRequestAttribute;
045    import javax.print.attribute.SetOfIntegerSyntax;
046    
047    /**
048     * The <code>PageRanges</code> printing attribute specifies the 
049     * range(s) of pages to be printed in a print job.
050     * <p>
051     * <b>Note:</b> The effect of this attribute on jobs with multiple 
052     * documents is controlled by the job attribute 
053     * {@link javax.print.attribute.standard.MultipleDocumentHandling}.
054     * </p>
055     * <p>
056     * <b>IPP Compatibility:</b> PageRanges is an IPP 1.1 attribute.
057     * </p>
058     * 
059     * @author Michael Koch (konqueror@gmx.de)
060     * @author Wolfgang Baer (WBaer@gmx.de)
061     */
062    public final class PageRanges extends SetOfIntegerSyntax
063      implements DocAttribute, PrintRequestAttribute, PrintJobAttribute
064    {
065      private static final long serialVersionUID = 8639895197656148392L;
066    
067      /**
068       * Constructs a <code>PageRanges</code> object with only one
069       * page to be printed.
070       *
071       * @param member the only page to be printed.
072       *
073       * @exception IllegalArgumentException if member is &lt; 1
074       */
075      public PageRanges(int member)
076      {
077        super(member);
078        
079        if (member < 1)
080          throw new IllegalArgumentException("member may not be less than 1");
081      }
082    
083      /**
084       * Constructs a <code>PageRanges</code> object with a set
085       * of ranges to be printed.
086       *
087       * @param members the page ranges to be printed.
088       *
089       * @exception IllegalArgumentException if any element is invalid
090       * @exception NullPointerException if members is <code>null</code> or any 
091       * element of members is <code>null</code>.
092       */
093      public PageRanges(int[][] members)
094      {
095        super(members);
096        
097        if (members == null)
098          throw new NullPointerException("members may not be null");
099      }
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    }