/*
* 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 javax.print.attribute.Attribute;
import javax.print.attribute.IntegerSyntax;
import javax.print.attribute.PrintJobAttribute;
import javax.print.attribute.PrintRequestAttribute;
Class JobImpressions is an integer valued printing attribute class that specifies the total size in number of impressions of the document(s) being submitted. An "impression" is the image (possibly many print-stream pages in different configurations) imposed onto a single media page. The JobImpressions attribute describes the size of the job. This attribute is not intended to be a counter; it is intended to be useful routing and scheduling information if known. The printer may try to compute the JobImpressions attribute's value if it is not supplied in the Print Request. Even if the client does supply a value for the JobImpressions attribute in the Print Request, the printer may choose to change the value if the printer is able to compute a value which is more accurate than the client supplied value. The printer may be able to determine the correct value for the JobImpressions attribute either right at job submission time or at any later point in time.
As with JobKOctets, the JobImpressions value must not include the multiplicative factors contributed by the number of copies specified by the Copies attribute, independent of whether the device can process multiple copies without making multiple passes over the job or document data and independent of whether the output is collated or not. Thus the value is independent of the implementation and reflects the size of the document(s) measured in impressions independent of the number of copies.
As with JobKOctets, the JobImpressions value must also not include the multiplicative factor due to a copies instruction embedded in the document data. If the document data actually includes replications of the document data, this value will include such replication. In other words, this value is always the number of impressions in the source document data, rather than a measure of the number of impressions to be produced by the job.
IPP Compatibility: The integer value gives the IPP integer value. The category name returned by getName() gives the IPP attribute name.
Author: Alan Kaminsky See Also:
/**
* Class {@code JobImpressions} is an integer valued printing attribute class
* that specifies the total size in number of impressions of the document(s)
* being submitted. An "impression" is the image (possibly many print-stream
* pages in different configurations) imposed onto a single media page.
* <p>
* The {@code JobImpressions} attribute describes the size of the job. This
* attribute is not intended to be a counter; it is intended to be useful
* routing and scheduling information if known. The printer may try to compute
* the {@code JobImpressions} attribute's value if it is not supplied in the
* Print Request. Even if the client does supply a value for the
* {@code JobImpressions} attribute in the Print Request, the printer may choose
* to change the value if the printer is able to compute a value which is more
* accurate than the client supplied value. The printer may be able to determine
* the correct value for the {@code JobImpressions} attribute either right at
* job submission time or at any later point in time.
* <p>
* As with {@link JobKOctets JobKOctets}, the {@code JobImpressions} value must
* not include the multiplicative factors contributed by the number of copies
* specified by the {@link Copies Copies} attribute, independent of whether the
* device can process multiple copies without making multiple passes over the
* job or document data and independent of whether the output is collated or
* not. Thus the value is independent of the implementation and reflects the
* size of the document(s) measured in impressions independent of the number of
* copies.
* <p>
* As with {@link JobKOctets JobKOctets}, the {@code JobImpressions} value must
* also not include the multiplicative factor due to a copies instruction
* embedded in the document data. If the document data actually includes
* replications of the document data, this value will include such replication.
* In other words, this value is always the number of impressions in the source
* document data, rather than a measure of the number of impressions to be
* produced by the job.
* <p>
* <b>IPP Compatibility:</b> The integer value gives the IPP integer value. The
* category name returned by {@code getName()} gives the IPP attribute name.
*
* @author Alan Kaminsky
* @see JobImpressionsSupported
* @see JobImpressionsCompleted
* @see JobKOctets
* @see JobMediaSheets
*/
public final class JobImpressions extends IntegerSyntax
implements PrintRequestAttribute, PrintJobAttribute {
Use serialVersionUID from JDK 1.4 for interoperability.
/**
* Use serialVersionUID from JDK 1.4 for interoperability.
*/
@Serial
private static final long serialVersionUID = 8225537206784322464L;
Construct a new job impressions attribute with the given integer value.
Params: - value – Integer value
Throws: - IllegalArgumentException – if
value is negative
/**
* Construct a new job impressions attribute with the given integer value.
*
* @param value Integer value
* @throws IllegalArgumentException if {@code value} is negative
*
*/
public JobImpressions(int value) {
super(value, 0, Integer.MAX_VALUE);
}
Returns whether this job impressions 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 JobImpressions. - This job impressions attribute's value and
object's value are equal.
Params: - object –
Object to compare to
Returns: true if object is equivalent to this job impressions attribute, false otherwise
/**
* Returns whether this job impressions 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 JobImpressions}.
* <li>This job impressions attribute's value and {@code object}'s value
* are equal.
* </ol>
*
* @param object {@code Object} to compare to
* @return {@code true} if {@code object} is equivalent to this job
* impressions attribute, {@code false} otherwise
*/
public boolean equals(Object object) {
return super.equals (object) && object instanceof JobImpressions;
}
Get the printing attribute class which is to be used as the "category"
for this printing attribute value.
For class JobImpressions, the category is class JobImpressions 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 JobImpressions}, the category is class
* {@code JobImpressions} itself.
*
* @return printing attribute class (category), an instance of class
* {@link Class java.lang.Class}
*/
public final Class<? extends Attribute> getCategory() {
return JobImpressions.class;
}
Get the name of the category of which this attribute value is an
instance.
For class JobImpressions, the category name is "job-impressions".
Returns: attribute category name
/**
* Get the name of the category of which this attribute value is an
* instance.
* <p>
* For class {@code JobImpressions}, the category name is
* {@code "job-impressions"}.
*
* @return attribute category name
*/
public final String getName() {
return "job-impressions";
}
}