Android APIs
public final class

PrintJob

extends Object
java.lang.Object
   ↳ android.print.PrintJob

Class Overview

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)
Compares this instance with the specified object and indicates if they are equal.
PrintJobId getId()
Gets the unique print job id.
PrintJobInfo getInfo()
Gets the PrintJobInfo that describes this job.
int hashCode()
Returns an integer hash code for this 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.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public void cancel ()

Added in API level 19

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

public boolean equals (Object obj)

Added in API level 19

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Parameters
obj Object: the object to compare this instance with.
Returns
boolean true if the specified object is equal to this Object; false otherwise.

public PrintJobId getId ()

Added in API level 19

Gets the unique print job id.

Returns
PrintJobId The id.

public PrintJobInfo getInfo ()

Added in API level 19

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.

public int hashCode ()

Added in API level 19

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
int this object's hash code.

public boolean isBlocked ()

Added in API level 19

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:

public boolean isCancelled ()

Added in API level 19

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.

public boolean isCompleted ()

Added in API level 19

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.

public boolean isFailed ()

Added in API level 19

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:

public boolean isQueued ()

Added in API level 19

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:

public boolean isStarted ()

Added in API level 19

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:

public void restart ()

Added in API level 19

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

See also: