Source for gnu.javax.print.ipp.attribute.DocumentAccessError

   1: /* DocumentAccessError.java --
   2:    Copyright (C) 2006 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 gnu.javax.print.ipp.attribute;
  40: 
  41: import java.util.Locale;
  42: 
  43: import javax.print.attribute.Attribute;
  44: import javax.print.attribute.TextSyntax;
  45: 
  46: /**
  47:  * DocumentAccessError attribute as described in RFC 2911 section
  48:  * 3.1.6  Operation Response Status Codes and Status Message
  49:  * provides additional information for document access errors.
  50:  *
  51:  * @author Wolfgang Baer (WBaer@gmx.de)
  52:  */
  53: public final class DocumentAccessError extends TextSyntax
  54:   implements Attribute
  55: {
  56: 
  57:   /**
  58:    * Creates a <code>DocumentAccessError</code> object with the given value
  59:    * and locale.
  60:    *
  61:    * @param value the value for this syntax
  62:    * @param locale the locale to use, if <code>null</code> the default
  63:    * locale is used.
  64:    *
  65:    * @exception NullPointerException if value is null
  66:    */
  67:   public DocumentAccessError(String value, Locale locale)
  68:   {
  69:     super(value, locale);
  70:   }
  71: 
  72:   /**
  73:    * Returns category of this class.
  74:    *
  75:    * @return The class <code>DocumentAccessError</code> itself.
  76:    */
  77:   public Class<? extends Attribute> getCategory()
  78:   {
  79:     return DocumentAccessError.class;
  80:   }
  81: 
  82: 
  83:   /**
  84:    * Returns the name of this attribute.
  85:    *
  86:    * @return The name "document-access-error".
  87:    */
  88:   public String getName()
  89:   {
  90:     return "document-access-error";
  91:   }
  92: 
  93: }