40 * <P> 41 * The JobKOctetsProcessed attribute describes the progress of the job. This 42 * attribute is intended to be a counter. That is, the JobKOctetsProcessed value 43 * for a job that has not started processing must be 0. When the job's {@link 44 * JobState JobState} is PROCESSING or PROCESSING_STOPPED, the 45 * JobKOctetsProcessed value is intended to increase as the job is processed; it 46 * indicates the amount of the job that has been processed at the time the Print 47 * Job's attribute set is queried or at the time a print job event is reported. 48 * When the job enters the COMPLETED, CANCELED, or ABORTED states, the 49 * JobKOctetsProcessed value is the final value for the job. 50 * <P> 51 * For implementations where multiple copies are produced by the interpreter 52 * with only a single pass over the data, the final value of the 53 * JobKOctetsProcessed attribute must be equal to the value of the {@link 54 * JobKOctets JobKOctets} attribute. For implementations where multiple copies 55 * are produced by the interpreter by processing the data for each copy, the 56 * final value must be a multiple of the value of the {@link JobKOctets 57 * JobKOctets} attribute. 58 * <P> 59 * <B>IPP Compatibility:</B> The integer value gives the IPP integer value. The 60 * category name returned by <CODE>getName()</CODE> gives the IPP attribute 61 * name. 62 * 63 * @see JobKOctets 64 * @see JobKOctetsSupported 65 * @see JobImpressionsCompleted 66 * @see JobMediaSheetsCompleted 67 * 68 * @author Alan Kaminsky 69 */ 70 public final class JobKOctetsProcessed extends IntegerSyntax 71 implements PrintJobAttribute { 72 73 private static final long serialVersionUID = -6265238509657881806L; 74 75 /** 76 * Construct a new job K octets processed attribute with the given integer 77 * value. 78 * 79 * @param value Integer value. 80 * 81 * @exception IllegalArgumentException 82 * (Unchecked exception) Thrown if <CODE>value</CODE> is less than 0. 83 */ 84 public JobKOctetsProcessed(int value) { 85 super (value, 0, Integer.MAX_VALUE); 86 } 87 88 /** 89 * Returns whether this job K octets processed attribute is equivalent to 90 * the passed in object. To be equivalent, all of the following conditions 91 * must be true: 92 * <OL TYPE=1> 93 * <LI> 94 * <CODE>object</CODE> is not null. 95 * <LI> 96 * <CODE>object</CODE> is an instance of class JobKOctetsProcessed. 97 * <LI> 98 * This job K octets processed attribute's value and 99 * <CODE>object</CODE>'s value are equal. 100 * </OL> 101 * 102 * @param object Object to compare to. 103 * 104 * @return True if <CODE>object</CODE> is equivalent to this job K 105 * octets processed attribute, false otherwise. 106 */ 107 public boolean equals(Object object) { 108 return(super.equals (object) && 109 object instanceof JobKOctetsProcessed); 110 } 111 112 /** 113 * Get the printing attribute class which is to be used as the "category" 114 * for this printing attribute value. 115 * <P> 116 * For class JobKOctetsProcessed, the category is class 117 * JobKOctetsProcessed itself. 118 * 119 * @return Printing attribute class (category), an instance of class 120 * {@link java.lang.Class java.lang.Class}. 121 */ 122 public final Class<? extends Attribute> getCategory() { 123 return JobKOctetsProcessed.class; 124 } 125 126 /** 127 * Get the name of the category of which this attribute value is an 128 * instance. 129 * <P> 130 * For class JobKOctetsProcessed, the category name is 131 * <CODE>"job-k-octets-processed"</CODE>. 132 * 133 * @return Attribute category name. 134 */ 135 public final String getName() { 136 return "job-k-octets-processed"; 137 } 138 139 } | 40 * <P> 41 * The JobKOctetsProcessed attribute describes the progress of the job. This 42 * attribute is intended to be a counter. That is, the JobKOctetsProcessed value 43 * for a job that has not started processing must be 0. When the job's {@link 44 * JobState JobState} is PROCESSING or PROCESSING_STOPPED, the 45 * JobKOctetsProcessed value is intended to increase as the job is processed; it 46 * indicates the amount of the job that has been processed at the time the Print 47 * Job's attribute set is queried or at the time a print job event is reported. 48 * When the job enters the COMPLETED, CANCELED, or ABORTED states, the 49 * JobKOctetsProcessed value is the final value for the job. 50 * <P> 51 * For implementations where multiple copies are produced by the interpreter 52 * with only a single pass over the data, the final value of the 53 * JobKOctetsProcessed attribute must be equal to the value of the {@link 54 * JobKOctets JobKOctets} attribute. For implementations where multiple copies 55 * are produced by the interpreter by processing the data for each copy, the 56 * final value must be a multiple of the value of the {@link JobKOctets 57 * JobKOctets} attribute. 58 * <P> 59 * <B>IPP Compatibility:</B> The integer value gives the IPP integer value. The 60 * category name returned by {@code getName()} gives the IPP attribute 61 * name. 62 * 63 * @see JobKOctets 64 * @see JobKOctetsSupported 65 * @see JobImpressionsCompleted 66 * @see JobMediaSheetsCompleted 67 * 68 * @author Alan Kaminsky 69 */ 70 public final class JobKOctetsProcessed extends IntegerSyntax 71 implements PrintJobAttribute { 72 73 private static final long serialVersionUID = -6265238509657881806L; 74 75 /** 76 * Construct a new job K octets processed attribute with the given integer 77 * value. 78 * 79 * @param value Integer value. 80 * 81 * @exception IllegalArgumentException 82 * (Unchecked exception) Thrown if {@code value} is less than 0. 83 */ 84 public JobKOctetsProcessed(int value) { 85 super (value, 0, Integer.MAX_VALUE); 86 } 87 88 /** 89 * Returns whether this job K octets processed attribute is equivalent to 90 * the passed in object. To be equivalent, all of the following conditions 91 * must be true: 92 * <OL TYPE=1> 93 * <LI> 94 * {@code object} is not null. 95 * <LI> 96 * {@code object} is an instance of class JobKOctetsProcessed. 97 * <LI> 98 * This job K octets processed attribute's value and 99 * {@code object}'s value are equal. 100 * </OL> 101 * 102 * @param object Object to compare to. 103 * 104 * @return True if {@code object} is equivalent to this job K 105 * octets processed attribute, false otherwise. 106 */ 107 public boolean equals(Object object) { 108 return(super.equals (object) && 109 object instanceof JobKOctetsProcessed); 110 } 111 112 /** 113 * Get the printing attribute class which is to be used as the "category" 114 * for this printing attribute value. 115 * <P> 116 * For class JobKOctetsProcessed, the category is class 117 * JobKOctetsProcessed itself. 118 * 119 * @return Printing attribute class (category), an instance of class 120 * {@link java.lang.Class java.lang.Class}. 121 */ 122 public final Class<? extends Attribute> getCategory() { 123 return JobKOctetsProcessed.class; 124 } 125 126 /** 127 * Get the name of the category of which this attribute value is an 128 * instance. 129 * <P> 130 * For class JobKOctetsProcessed, the category name is 131 * {@code "job-k-octets-processed"}. 132 * 133 * @return Attribute category name. 134 */ 135 public final String getName() { 136 return "job-k-octets-processed"; 137 } 138 139 } |