Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Methods](https://developer.android.com/reference/android/print/PrintJob#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/print/PrintJob#inhmethods)

# PrintJob

*** ** * ** ***


`
public

final

class
PrintJob
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.print.PrintJob |

<br />

*** ** * ** ***

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 `https://developer.android.com/reference/android/print/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` | ` https://developer.android.com/reference/android/print/PrintJob#cancel()() ` Cancels this print job. |
| ` boolean` | ` https://developer.android.com/reference/android/print/PrintJob#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. |
| ` https://developer.android.com/reference/android/print/PrintJobId` | ` https://developer.android.com/reference/android/print/PrintJob#getId()() ` Gets the unique print job id. |
| ` https://developer.android.com/reference/android/print/PrintJobInfo` | ` https://developer.android.com/reference/android/print/PrintJob#getInfo()() ` Gets the `https://developer.android.com/reference/android/print/PrintJobInfo` that describes this job. |
| ` int` | ` https://developer.android.com/reference/android/print/PrintJob#hashCode()() ` Returns a hash code value for the object. |
| ` boolean` | ` https://developer.android.com/reference/android/print/PrintJob#isBlocked()() ` Gets whether this print job is blocked. |
| ` boolean` | ` https://developer.android.com/reference/android/print/PrintJob#isCancelled()() ` Gets whether this print job is cancelled. |
| ` boolean` | ` https://developer.android.com/reference/android/print/PrintJob#isCompleted()() ` Gets whether this print job is completed. |
| ` boolean` | ` https://developer.android.com/reference/android/print/PrintJob#isFailed()() ` Gets whether this print job is failed. |
| ` boolean` | ` https://developer.android.com/reference/android/print/PrintJob#isQueued()() ` Gets whether this print job is queued. |
| ` boolean` | ` https://developer.android.com/reference/android/print/PrintJob#isStarted()() ` Gets whether this print job is started. |
| ` void` | ` https://developer.android.com/reference/android/print/PrintJob#restart()() ` Restarts this print job. |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||

## Public methods

### cancel

Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void cancel ()
```

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

<br />

**See also:**

- `https://developer.android.com/reference/android/print/PrintJob#isQueued()`
- `https://developer.android.com/reference/android/print/PrintJob#isStarted()`
- `https://developer.android.com/reference/android/print/PrintJob#isBlocked()`
- `https://developer.android.com/reference/android/print/PrintJob#isFailed()`

### equals

Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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`.


An equivalence relation partitions the elements it operates on
into *equivalence classes*; all the members of an
equivalence class are equal to each other. Members of an
equivalence class are substitutable for each other, at least
for some purposes.

<br />

| Parameters ||
|---|---|
| `obj` | `Object`: This value may be `null`. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### getId

Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public PrintJobId getId ()
```

Gets the unique print job id.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/print/PrintJobId` | The id. This value may be `null`. <br /> |

### getInfo

Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public PrintJobInfo getInfo ()
```

Gets the `https://developer.android.com/reference/android/print/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.

<br />

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/print/PrintJobInfo` | The print job info. This value cannot be `null`. <br /> |

### hashCode

Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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
`https://developer.android.com/reference/java/util/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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.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 `https://developer.android.com/reference/java/lang/Object#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.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### isBlocked

Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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
`https://developer.android.com/reference/android/print/PrintJob#cancel()`.

<br />

| Returns ||
|---|---|
| `boolean` | Whether the print job is blocked. <br /> |

**See also:**

- `https://developer.android.com/reference/android/print/PrintJob#cancel()`

### isCancelled

Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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.

<br />

| Returns ||
|---|---|
| `boolean` | Whether the print job is cancelled. <br /> |

### isCompleted

Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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.

<br />

| Returns ||
|---|---|
| `boolean` | Whether the print job is completed. <br /> |

### isFailed

Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/print/PrintJob#restart()` or cancel via `https://developer.android.com/reference/android/print/PrintJob#cancel()`.

<br />

| Returns ||
|---|---|
| `boolean` | Whether the print job is failed. <br /> |

**See also:**

- `https://developer.android.com/reference/android/print/PrintJob#restart()`
- `https://developer.android.com/reference/android/print/PrintJob#cancel()`

### isQueued

Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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
`https://developer.android.com/reference/android/print/PrintJob#cancel()`.

<br />

| Returns ||
|---|---|
| `boolean` | Whether the print job is queued. <br /> |

**See also:**

- `https://developer.android.com/reference/android/print/PrintJob#cancel()`

### isStarted

Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isStarted ()
```

Gets whether this print job is started. Such a print job is
being printed. You can request a cancellation via
`https://developer.android.com/reference/android/print/PrintJob#cancel()`.

<br />

| Returns ||
|---|---|
| `boolean` | Whether the print job is started. <br /> |

**See also:**

- `https://developer.android.com/reference/android/print/PrintJob#cancel()`

### restart

Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void restart ()
```

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

<br />

**See also:**

- `https://developer.android.com/reference/android/print/PrintJob#isFailed()`