Source for javax.print.attribute.standard.Destination

   1: /* Destination.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 java.net.URI;
  42: 
  43: import javax.print.attribute.Attribute;
  44: import javax.print.attribute.PrintJobAttribute;
  45: import javax.print.attribute.PrintRequestAttribute;
  46: import javax.print.attribute.URISyntax;
  47: 
  48: /**
  49:  * The <code>Destination</code> attribute provides a URI for an alternate
  50:  * destination of the printing output.
  51:  * <p>
  52:  * As not an IPP attribute many print services will not support this
  53:  * attribute and only provide the printer device as a destination.
  54:  * An alternate output destination would be a file on the local harddisk
  55:  * given as a file scheme URI.
  56:  * </p>
  57:  * <p>
  58:  * If a print service does not support the destination attributes URI it
  59:  * will throw a PrintException. This exception may further implement the
  60:  * interface {@link javax.print.URIException}.
  61:  * </p>
  62:  * <p>
  63:  * <b>IPP Compatibility:</b> Destination is not an IPP 1.1 attribute.
  64:  * </p>
  65:  * @see javax.print.PrintException
  66:  * @see javax.print.URIException
  67:  *
  68:  * @author Michael Koch (konqueror@gmx.de)
  69:  * @author Wolfgang Baer (WBaer@gmx.de)
  70:  */
  71: public final class Destination extends URISyntax
  72:   implements PrintJobAttribute, PrintRequestAttribute
  73: {
  74:   private static final long serialVersionUID = 6776739171700415321L;
  75: 
  76:   /**
  77:    * Constructs a <code>Destination</code> object.
  78:    *
  79:    * @param uri the URI of the output destination.
  80:    * @throws NullPointerException if the given uri is null.
  81:    */
  82:   public Destination(URI uri)
  83:   {
  84:     super(uri);
  85:   }
  86: 
  87:   /**
  88:    * Tests if the given object is equal to this object.
  89:    *
  90:    * @param obj the object to test
  91:    *
  92:    * @return <code>true</code> if both objects are equal,
  93:    * <code>false</code> otherwise.
  94:    */
  95:   public boolean equals(Object obj)
  96:   {
  97:     if(! (obj instanceof Destination))
  98:       return false;
  99: 
 100:     return super.equals(obj);
 101:   }
 102: 
 103:   /**
 104:    * Returns category of this class.
 105:    *
 106:    * @return The class <code>Destination</code> itself.
 107:    */
 108:   public Class< ? extends Attribute> getCategory()
 109:   {
 110:     return Destination.class;
 111:   }
 112: 
 113:   /**
 114:    * Returns the name of this attribute.
 115:    *
 116:    * @return The name "spool-data-destination"
 117:    */
 118:   public String getName()
 119:   {
 120:     return "spool-data-destination";
 121:   }
 122: }