PrinterInfo
public
final
class
PrinterInfo
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.print.PrinterInfo |
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.
Once built
the objects are immutable.
Summary
Nested classes | |
---|---|
class |
PrinterInfo.Builder
Builder for creating of a |
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. |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<PrinterInfo> |
CREATOR
|
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one. |
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 a hash code value for the object. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel parcel, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Constants
STATUS_BUSY
public static final int STATUS_BUSY
Printer status: the printer is busy printing.
Constant Value: 2 (0x00000002)
STATUS_IDLE
public static final int STATUS_IDLE
Printer status: the printer is idle and ready to print.
Constant Value: 1 (0x00000001)
STATUS_UNAVAILABLE
public static final int STATUS_UNAVAILABLE
Printer status: the printer is not available.
Constant Value: 3 (0x00000003)
Fields
Public methods
describeContents
public int describeContents ()
Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of writeToParcel(android.os.Parcel, int)
,
the return value of this method must include the
CONTENTS_FILE_DESCRIPTOR
bit.
Returns | |
---|---|
int |
a bitmask indicating the set of special object types marshaled
by this Parcelable object instance.
Value is either 0 or CONTENTS_FILE_DESCRIPTOR |
equals
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
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.
Parameters | |
---|---|
obj |
Object : This value may be null . |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getCapabilities
public PrinterCapabilitiesInfo getCapabilities ()
Gets the printer capabilities.
Returns | |
---|---|
PrinterCapabilitiesInfo |
The capabilities.
This value may be null . |
getDescription
public String getDescription ()
Gets the printer description.
Returns | |
---|---|
String |
The description.
This value may be null . |
getId
public PrinterId getId ()
Get the globally unique printer id.
Returns | |
---|---|
PrinterId |
The printer id.
This value cannot be null . |
getName
public String getName ()
Get the printer name.
Returns | |
---|---|
String |
The printer name.
This value cannot be null . |
getStatus
public int getStatus ()
Gets the printer status.
Returns | |
---|---|
int |
The status.
Value is STATUS_IDLE , STATUS_BUSY , or STATUS_UNAVAILABLE |
See also:
hashCode
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
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 inequals
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
equals
method, then calling thehashCode
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
equals
method, then calling thehashCode
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.
Returns | |
---|---|
int |
a hash code value for this object. |
toString
public String toString ()
Returns a string representation of the object.
Returns | |
---|---|
String |
a string representation of the object. |
writeToParcel
public void writeToParcel (Parcel parcel, int flags)
Flatten this object in to a Parcel.
Parameters | |
---|---|
parcel |
Parcel : The Parcel in which the object should be written.
This value cannot be null . |
flags |
int : Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-04-11 UTC.