Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public final class

PrintJob

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

Class Overview

This class represents a print job from the perspective of a print service. It provides APIs for observing the print job state and performing operations on the print job.

Note: All methods of this class must be invoked on the main application thread.

Summary

Public Methods
boolean block ( String reason)
Blocks the print job.
boolean cancel ()
Cancels the print job.
boolean complete ()
Completes the print job.
boolean equals ( Object obj)
Compares this instance with the specified object and indicates if they are equal.
boolean fail ( String error)
Fails the print job.
int getAdvancedIntOption ( String key)
Gets the value of an advanced (printer specific) print option.
String getAdvancedStringOption ( String key)
Gets the value of an advanced (printer specific) print option.
PrintDocument getDocument ()
Gets the printed document.
PrintJobId getId ()
Gets the unique print job id.
PrintJobInfo getInfo ()
Gets the PrintJobInfo that describes this job.
String getTag ()
Gets the print job tag.
boolean hasAdvancedOption ( String key)
Gets whether this job has a given advanced (printer specific) print option.
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.
boolean setTag ( String tag)
Sets a tag that is valid in the context of a PrintService and is not interpreted by the system.
boolean start ()
Starts the print job.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public boolean block ( String reason)

Blocks the print job. You should call this method if isStarted() or isBlocked() returns true and you need to block the print job. For example, the user has to add some paper to continue printing. To resume the print job call start() .

Returns
  • Whether the job was blocked.
See Also

public boolean cancel ()

Cancels the print job. You should call this method if isQueued() or or #isBlocked() returns true and you canceled the print job as a response to a call to onRequestCancelPrintJob(PrintJob) .

Returns
  • Whether the job is canceled.
See Also

public boolean complete ()

Completes the print job. You should call this method if isStarted() returns true and you are done printing.

Returns
  • Whether the job as completed.
See Also

public boolean equals ( Object obj)

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 the object to compare this instance with.
Returns
  • true if the specified object is equal to this Object ; false otherwise.

public boolean fail ( String error)

Fails the print job. You should call this method if isQueued() or isStarted() or isBlocked() returns true you failed while printing.

Parameters
error The human readable, short, and translated reason for the failure.
Returns
  • Whether the job was failed.
See Also

public int getAdvancedIntOption ( String key)

Gets the value of an advanced (printer specific) print option.

Parameters
key The option key.
Returns
  • The option value.

public String getAdvancedStringOption ( String key)

Gets the value of an advanced (printer specific) print option.

Parameters
key The option key.
Returns
  • The option value.

public PrintDocument getDocument ()

Gets the printed document.

Returns
  • The document.

public PrintJobId getId ()

Gets the unique print job id.

Returns
  • The id.

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
  • The print job info.

public String getTag ()

Gets the print job tag.

Returns
  • The tag or null.
See Also

public boolean hasAdvancedOption ( String key)

Gets whether this job has a given advanced (printer specific) print option.

Parameters
key The option key.
Returns
  • Whether the option is present.

public int hashCode ()

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
  • this object's hash code.

public boolean isBlocked ()

Gets whether this print job is blocked. Such a print job is halted due to an abnormal condition and can be started or canceled or failed.

Returns
  • Whether the print job is blocked.
See Also

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.

Returns
  • Whether the print job is cancelled.
See Also

public boolean isCompleted ()

Gets whether this print job is completed. Such a print job is successfully printed. This is a final state.

Returns
  • Whether the print job is completed.
See Also

public boolean isFailed ()

Gets whether this print job is failed. Such a print job is not successfully printed due to an error. This is a final state.

Returns
  • Whether the print job is failed.
See Also

public boolean isQueued ()

Gets whether this print job is queued. Such a print job is ready to be printed and can be started or cancelled.

Returns
  • Whether the print job is queued.
See Also

public boolean isStarted ()

Gets whether this print job is started. Such a print job is being printed and can be completed or canceled or failed.

Returns
  • Whether the print job is started.
See Also

public boolean setTag ( String tag)

Sets a tag that is valid in the context of a PrintService and is not interpreted by the system. For example, a print service may set as a tag the key of the print job returned by a remote print server, if the printing is off handed to a cloud based service.

Parameters
tag The tag.
Returns
  • True if the tag was set, false otherwise.

public boolean start ()

Starts the print job. You should call this method if isQueued() or isBlocked() returns true and you started resumed printing.

Returns
  • Whether the job was started.
See Also