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

   1: /* JobSheetsDefault.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: 
  43: import java.util.Locale;
  44: 
  45: import javax.print.attribute.Attribute;
  46: import javax.print.attribute.TextSyntax;
  47: import javax.print.attribute.standard.JobSheets;
  48: 
  49: /**
  50:  * JobSheetsDefault attribute provides the default value of
  51:  * the printer object for the job-sheets attribute.
  52:  *
  53:  * @author Wolfgang Baer (WBaer@gmx.de)
  54:  */
  55: public final class JobSheetsDefault extends TextSyntax
  56:   implements DefaultValueAttribute
  57: {
  58:   //a keyword/name based attribute in IPP
  59:   // can be extended by administrators
  60:   // standard values are predefined
  61: 
  62:   /** No job sheet is the default */
  63:   public static final JobSheetsDefault NONE =
  64:     new JobSheetsDefault("none", Locale.getDefault());
  65: 
  66:   /** A job sheet is the default */
  67:   public static final JobSheetsDefault STANDARD =
  68:     new JobSheetsDefault("standard", Locale.getDefault());
  69: 
  70:   /**
  71:    * Creates a <code>JobSheetsDefault</code> object with the
  72:    * given value and locale.
  73:    *
  74:    * @param value the value for this syntax
  75:    * @param locale the locale to use, if <code>null</code> the default
  76:    * locale is used.
  77:    *
  78:    * @throws NullPointerException if value is null
  79:    */
  80:   public JobSheetsDefault(String value, Locale locale)
  81:   {
  82:     super(value, locale);
  83:   }
  84: 
  85:   /**
  86:    * Returns category of this class.
  87:    *
  88:    * @return The class <code>JobSheetsDefault</code> itself.
  89:    */
  90:   public Class<? extends Attribute> getCategory()
  91:   {
  92:     return JobSheetsDefault.class;
  93:   }
  94: 
  95:   /**
  96:    * Returns the name of this attribute.
  97:    *
  98:    * @return The name "job-sheets-default".
  99:    */
 100:   public String getName()
 101:   {
 102:     return "job-sheets-default";
 103:   }
 104: 
 105:   /**
 106:    * Returns the equally enum of the standard attribute class
 107:    * of this DefaultValuesAttribute enum.
 108:    * <p>May return null if no value exists in JPS API.</p>
 109:    *
 110:    * @return The enum of the standard attribute class.
 111:    */
 112:   public Attribute getAssociatedAttribute()
 113:   {
 114:     if (this.equals(JobSheetsDefault.NONE))
 115:       return JobSheets.NONE;
 116:     if (this.equals(JobSheetsDefault.STANDARD))
 117:       return JobSheets.STANDARD;
 118: 
 119:     return null;
 120:   }
 121: 
 122: }