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

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

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

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

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

Gets the printer capabilities.

Returns
  • The capabilities.

public String getDescription ()

Gets the printer description.

Returns
  • The description.

public PrinterId getId ()

Get the globally unique printer id.

Returns
  • The printer id.

public String getName ()

Get the printer name.

Returns
  • The printer name.

public int getStatus ()

Gets the printer status.

Returns
  • The status.
See Also

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

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
  • a printable representation of this object.

public void writeToParcel ( Parcel parcel, int flags)

Flatten this object in to a Parcel.

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