Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.
added in API level 19

PrintJob

public final class PrintJob
extends Object

java.lang.Object
   ↳ android.print.PrintJob


This class represents a print job from the perspective of an application. It contains behavior methods for performing operations on it as well as methods for querying its state. A snapshot of the print job state is represented by the PrintJobInfo class. The state of a print job may change over time. An application receives instances of this class when creating a print job or querying for its print jobs.

Summary

Public methods

void cancel()

Cancels this print job.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

PrintJobId getId()

Gets the unique print job id.

PrintJobInfo getInfo()

Gets the PrintJobInfo that describes this job.

int hashCode()

Returns a hash code value for the object.

boolean isBlocked()

Gets whether this print job is blocked.

boolean isCancelled()

Gets whether this print job is cancelled.

boolean isCompleted()

Gets whether this print job is completed.

boolean isFailed()

Gets whether this print job is failed.

boolean isQueued()

Gets whether this print job is queued.

boolean isStarted()

Gets whether this print job is started.

void restart()

Restarts this print job.

Inherited methods

Public methods

cancel

added in API level 19
public void cancel ()

Cancels this print job. You can request cancellation of a queued, started, blocked, or failed print job.

equals

added in API level 19
public boolean equals (Object obj)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
obj Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getId

added in API level 19
public PrintJobId getId ()

Gets the unique print job id.

Returns
PrintJobId The id.

This value may be null.

getInfo

added in API level 19
public PrintJobInfo getInfo ()

Gets the PrintJobInfo that describes this job.

Node:The returned info object is a snapshot of the current print job state. Every call to this method returns a fresh info object that reflects the current print job state.

Returns
PrintJobInfo The print job info.

This value will never be null.

hashCode

added in API level 19
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
int a hash code value for this object.

isBlocked

added in API level 19
public boolean isBlocked ()

Gets whether this print job is blocked. Such a print job is halted due to an abnormal condition. You can request a cancellation via cancel().

Returns
boolean Whether the print job is blocked.

See also:

isCancelled

added in API level 19
public boolean isCancelled ()

Gets whether this print job is cancelled. Such a print job was cancelled as a result of a user request. This is a final state. You cannot restart such a print job.

Returns
boolean Whether the print job is cancelled.

isCompleted

added in API level 19
public boolean isCompleted ()

Gets whether this print job is completed. Such a print job is successfully printed. You can neither cancel nor restart such a print job.

Returns
boolean Whether the print job is completed.

isFailed

added in API level 19
public boolean isFailed ()

Gets whether this print job is failed. Such a print job is not successfully printed due to an error. You can request a restart via restart() or cancel via cancel().

Returns
boolean Whether the print job is failed.

See also:

isQueued

added in API level 19
public boolean isQueued ()

Gets whether this print job is queued. Such a print job is ready to be printed. You can request a cancellation via cancel().

Returns
boolean Whether the print job is queued.

See also:

isStarted

added in API level 19
public boolean isStarted ()

Gets whether this print job is started. Such a print job is being printed. You can request a cancellation via cancel().

Returns
boolean Whether the print job is started.

See also:

restart

added in API level 19
public void restart ()

Restarts this print job. You can request restart of a failed print job.

See also: