Source for gnu.javax.print.ipp.attribute.defaults.DocumentFormatDefault

   1: /* DocumentFormatDefault.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.defaults;
  40: 
  41: import gnu.javax.print.ipp.attribute.DefaultValueAttribute;
  42: import gnu.javax.print.ipp.attribute.printer.DocumentFormat;
  43: 
  44: import java.util.Locale;
  45: 
  46: import javax.print.attribute.Attribute;
  47: import javax.print.attribute.TextSyntax;
  48: 
  49: /**
  50:  * <code>DocumentFormatDefault</code> specifies the default document
  51:  * format of a printer.
  52:  *
  53:  * @author Wolfgang Baer (WBaer@gmx.de)
  54:  *
  55:  */
  56: public final class DocumentFormatDefault extends TextSyntax
  57:   implements DefaultValueAttribute
  58: {
  59: 
  60:   /**
  61:    * Creates a <code>DocumentFormatDefault</code> object with the
  62:    * given value and locale.
  63:    *
  64:    * @param value the value for this syntax
  65:    * @param locale the locale to use, if <code>null</code> the default
  66:    * locale is used.
  67:    *
  68:    * @exception NullPointerException if value is null
  69:    */
  70:   public DocumentFormatDefault(String value, Locale locale)
  71:   {
  72:     super(value, locale);
  73:   }
  74: 
  75:   /**
  76:    * Returns category of this class.
  77:    *
  78:    * @return The class <code>DocumentFormatDefault</code> itself.
  79:    */
  80:   public Class<? extends Attribute> getCategory()
  81:   {
  82:     return DocumentFormatDefault.class;
  83:   }
  84: 
  85:   /**
  86:    * Returns the name of this attribute.
  87:    *
  88:    * @return The name "document-format-default".
  89:    */
  90:   public String getName()
  91:   {
  92:     return "document-format-default";
  93:   }
  94: 
  95:   /**
  96:    * Returns the equally enum of the standard attribute class
  97:    * of this DefaultValuesAttribute enum.
  98:    *
  99:    * @return The enum of the standard attribute class.
 100:    */
 101:   public Attribute getAssociatedAttribute()
 102:   {
 103:     return new DocumentFormat(getValue(), getLocale());
 104:   }
 105: 
 106: }