Android APIs
public final class

PrinterInfo

extends Object
implements Parcelable
java.lang.Object
   ↳ android.print.PrinterInfo

Class Overview

This class represents the description of a printer. Instances of this class are created by print services to report to the system the printers they manage. The information of this class has two major components, printer properties such as name, id, status, description and printer capabilities which describe the various print modes a printer supports such as media sizes, margins, etc.

Summary

Nested Classes
class PrinterInfo.Builder Builder for creating of a PrinterInfo
Constants
int STATUS_BUSY Printer status: the printer is busy printing.
int STATUS_IDLE Printer status: the printer is idle and ready to print.
int STATUS_UNAVAILABLE Printer status: the printer is not available.
[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<PrinterInfo> CREATOR
Public Methods
int describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
boolean equals(Object obj)
Compares this instance with the specified object and indicates if they are equal.
PrinterCapabilitiesInfo getCapabilities()
Gets the printer capabilities.
String getDescription()
Gets the printer description.
PrinterId getId()
Get the globally unique printer id.
String getName()
Get the printer name.
int getStatus()
Gets the printer status.
int hashCode()
Returns an integer hash code for this object.
String toString()
Returns a string containing a concise, human-readable description of this object.
void writeToParcel(Parcel parcel, int flags)
Flatten this object in to a Parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Constants

public static final int STATUS_BUSY

Added in API level 19

Printer status: the printer is busy printing.

Constant Value: 2 (0x00000002)

public static final int STATUS_IDLE

Added in API level 19

Printer status: the printer is idle and ready to print.

Constant Value: 1 (0x00000001)

public static final int STATUS_UNAVAILABLE

Added in API level 19

Printer status: the printer is not available.

Constant Value: 3 (0x00000003)

Fields

public static final Creator<PrinterInfo> CREATOR

Added in API level 19

Public Methods

public int describeContents ()

Added in API level 19

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Returns
int a bitmask indicating the set of special object types marshalled by the Parcelable.

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 PrinterCapabilitiesInfo getCapabilities ()

Added in API level 19

Gets the printer capabilities.

Returns
PrinterCapabilitiesInfo The capabilities.

public String getDescription ()

Added in API level 19

Gets the printer description.

Returns
String The description.

public PrinterId getId ()

Added in API level 19

Get the globally unique printer id.

Returns
PrinterId The printer id.

public String getName ()

Added in API level 19

Get the printer name.

Returns
String The printer name.

public int getStatus ()

Added in API level 19

Gets the printer status.

Returns
int The status.

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 String toString ()

Added in API level 19

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
String a printable representation of this object.

public void writeToParcel (Parcel parcel, int flags)

Added in API level 19

Flatten this object in to a Parcel.

Parameters
parcel Parcel: The Parcel in which the object should be written.
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.