/*
 * Copyright (c) 2000, 2021, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.print.attribute.standard;

import java.io.Serial;
import java.util.Locale;

import javax.print.attribute.Attribute;
import javax.print.attribute.PrintJobAttribute;
import javax.print.attribute.TextSyntax;

Class JobOriginatingUserName is a printing attribute class, a text attribute, that contains the name of the end user that submitted the print job. If possible, the printer sets this attribute to the most authenticated printable user name that it can obtain from the authentication service that authenticated the submitted Print Request. If such is not available, the printer uses the value of the RequestingUserName attribute supplied by the client in the Print Request's attribute set. If no authentication service is available, and the client did not supply a RequestingUserName attribute, the printer sets the JobOriginatingUserName attribute to an empty (zero-length) string. 

IPP Compatibility: The string value gives the IPP name value. The locale gives the IPP natural language. The category name returned by getName() gives the IPP attribute name. 
Author:
Alan Kaminsky/**
 * Class {@code JobOriginatingUserName} is a printing attribute class, a text
 * attribute, that contains the name of the end user that submitted the print
 * job. If possible, the printer sets this attribute to the most authenticated
 * printable user name that it can obtain from the authentication service that
 * authenticated the submitted Print Request. If such is not available, the
 * printer uses the value of the {@link RequestingUserName RequestingUserName}
 * attribute supplied by the client in the Print Request's attribute set. If no
 * authentication service is available, and the client did not supply a
 * {@link RequestingUserName RequestingUserName} attribute, the printer sets the
 * JobOriginatingUserName attribute to an empty (zero-length) string.
 * <p>
 * <b>IPP Compatibility:</b> The string value gives the IPP name value. The
 * locale gives the IPP natural language. The category name returned by
 * {@code getName()} gives the IPP attribute name.
 *
 * @author Alan Kaminsky
 */
public final class JobOriginatingUserName extends TextSyntax
        implements PrintJobAttribute {

    
Use serialVersionUID from JDK 1.4 for interoperability.
/**
     * Use serialVersionUID from JDK 1.4 for interoperability.
     */
    @Serial
    private static final long serialVersionUID = -8052537926362933477L;

    
Constructs a new job originating user name attribute with the given user
name and locale.
Params:
userName – user name
locale – natural language of the text string. null is interpreted to mean the default locale as returned by Locale.getDefault()
Throws:
NullPointerException – if userName is null/**
     * Constructs a new job originating user name attribute with the given user
     * name and locale.
     *
     * @param  userName user name
     * @param  locale natural language of the text string. {@code null} is
     *         interpreted to mean the default locale as returned by
     *         {@code Locale.getDefault()}
     * @throws NullPointerException if {@code userName} is {@code null}
     */
    public JobOriginatingUserName(String userName, Locale locale) {
        super (userName, locale);
    }

    
Returns whether this job originating user name attribute is equivalent to
the passed in object. To be equivalent, all of the following conditions
must be true:

  
object is not null. 
object is an instance of class JobOriginatingUserName. 
This job originating user name attribute's underlying string and object's underlying string are equal. 
This job originating user name attribute's locale and object's locale are equal. 
Params:
object – Object to compare to
Returns:
true if object is equivalent to this job originating user name attribute, false otherwise/**
     * Returns whether this job originating user name attribute is equivalent to
     * the passed in object. To be equivalent, all of the following conditions
     * must be true:
     * <ol type=1>
     *   <li>{@code object} is not {@code null}.
     *   <li>{@code object} is an instance of class
     *   {@code JobOriginatingUserName}.
     *   <li>This job originating user name attribute's underlying string and
     *   {@code object}'s underlying string are equal.
     *   <li>This job originating user name attribute's locale and
     *   {@code object}'s locale are equal.
     * </ol>
     *
     * @param  object {@code Object} to compare to
     * @return {@code true} if {@code object} is equivalent to this job
     *         originating user name attribute, {@code false} otherwise
     */
    public boolean equals(Object object) {
        return (super.equals (object) &&
                object instanceof JobOriginatingUserName);
    }

    
Get the printing attribute class which is to be used as the "category"
for this printing attribute value.
 For class JobOriginatingUserName, the category is class JobOriginatingUserName itself. 
Returns:
printing attribute class (category), an instance of class java.lang.Class/**
     * Get the printing attribute class which is to be used as the "category"
     * for this printing attribute value.
     * <p>
     * For class {@code JobOriginatingUserName}, the category is class
     * {@code JobOriginatingUserName} itself.
     *
     * @return printing attribute class (category), an instance of class
     *         {@link Class java.lang.Class}
     */
    public final Class<? extends Attribute> getCategory() {
        return JobOriginatingUserName.class;
    }

    
Get the name of the category of which this attribute value is an
instance.
 For class JobOriginatingUserName, the category name is "job-originating-user-name". 
Returns:
attribute category name/**
     * Get the name of the category of which this attribute value is an
     * instance.
     * <p>
     * For class {@code JobOriginatingUserName}, the category name is
     * {@code "job-originating-user-name"}.
     *
     * @return attribute category name
     */
    public final String getName() {
        return "job-originating-user-name";
    }
}