001 /*
002 * Copyright 2000-2004 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025 package javax.print.attribute.standard;
026
027 import java.util.Locale;
028
029 import javax.print.attribute.Attribute;
030 import javax.print.attribute.TextSyntax;
031 import javax.print.attribute.PrintRequestAttribute;
032
033 /**
034 * Class RequestingUserName is a printing attribute class, a text attribute,
035 * that specifies the name of the end user that submitted the print job. A
036 * requesting user name is an arbitrary string defined by the client. The
037 * printer does not put the client-specified RequestingUserName attribute into
038 * the Print Job's attribute set; rather, the printer puts in a {@link
039 * JobOriginatingUserName JobOriginatingUserName} attribute.
040 * This means that services which support specifying a username with this
041 * attribute should also report a JobOriginatingUserName in the job's
042 * attribute set. Note that many print services may have a way to independently
043 * authenticate the user name, and so may state support for a
044 * requesting user name, but in practice will then report the user name
045 * authenticated by the service rather than that specified via this
046 * attribute.
047 * <P>
048 * <B>IPP Compatibility:</B> The string value gives the IPP name value. The
049 * locale gives the IPP natural language. The category name returned by
050 * <CODE>getName()</CODE> gives the IPP attribute name.
051 * <P>
052 *
053 * @author Alan Kaminsky
054 */
055 public final class RequestingUserName extends TextSyntax implements
056 PrintRequestAttribute {
057
058 private static final long serialVersionUID = -2683049894310331454L;
059
060 /**
061 * Constructs a new requesting user name attribute with the given user
062 * name and locale.
063 *
064 * @param userName User name.
065 * @param locale Natural language of the text string. null
066 * is interpreted to mean the default locale as returned
067 * by <code>Locale.getDefault()</code>
068 *
069 * @exception NullPointerException
070 * (unchecked exception) Thrown if <CODE>userName</CODE> is null.
071 */
072 public RequestingUserName(String userName, Locale locale) {
073 super (userName, locale);
074 }
075
076 /**
077 * Returns whether this requesting user name attribute is equivalent to
078 * the passed in object. To be equivalent, all of the following
079 * conditions must be true:
080 * <OL TYPE=1>
081 * <LI>
082 * <CODE>object</CODE> is not null.
083 * <LI>
084 * <CODE>object</CODE> is an instance of class RequestingUserName.
085 * <LI>
086 * This requesting user name attribute's underlying string and
087 * <CODE>object</CODE>'s underlying string are equal.
088 * <LI>
089 * This requesting user name attribute's locale and
090 * <CODE>object</CODE>'s locale are equal.
091 * </OL>
092 *
093 * @param object Object to compare to.
094 *
095 * @return True if <CODE>object</CODE> is equivalent to this requesting
096 * user name attribute, false otherwise.
097 */
098 public boolean equals(Object object) {
099 return (super .equals(object) && object instanceof RequestingUserName);
100 }
101
102 /**
103 * Get the printing attribute class which is to be used as the "category"
104 * for this printing attribute value.
105 * <P>
106 * For class RequestingUserName, the
107 * category is class RequestingUserName itself.
108 *
109 * @return Printing attribute class (category), an instance of class
110 * {@link java.lang.Class java.lang.Class}.
111 */
112 public final Class<? extends Attribute> getCategory() {
113 return RequestingUserName.class;
114 }
115
116 /**
117 * Get the name of the category of which this attribute value is an
118 * instance.
119 * <P>
120 * For class RequestingUserName, the
121 * category name is <CODE>"requesting-user-name"</CODE>.
122 *
123 * @return Attribute category name.
124 */
125 public final String getName() {
126 return "requesting-user-name";
127 }
128
129 }
|