PrinterInfo
class PrinterInfo : Parcelable
| kotlin.Any | |
| ↳ | 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 | |
|---|---|
|
Builder for creating of a |
|
| Constants | |
|---|---|
| static Int |
Printer status: the printer is busy printing. |
| static Int |
Printer status: the printer is idle and ready to print. |
| static Int |
Printer status: the printer is not available. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| PrinterCapabilitiesInfo? |
Gets the printer capabilities. |
| String? |
Gets the printer description. |
| PrinterId |
getId()Get the globally unique printer id. |
| String |
getName()Get the printer name. |
| Int |
Gets the printer status. |
| Int |
hashCode()Returns a hash code value for the object. |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(parcel: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<PrinterInfo!> | |
Constants
STATUS_BUSY
static val STATUS_BUSY: Int
Printer status: the printer is busy printing.
Value: 2STATUS_IDLE
static val STATUS_IDLE: Int
Printer status: the printer is idle and ready to print.
Value: 1STATUS_UNAVAILABLE
static val STATUS_UNAVAILABLE: Int
Printer status: the printer is not available.
Value: 3Public methods
describeContents
fun describeContents(): Int
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.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
fun equals(other: Any?): Boolean
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
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons 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 |
This value may be null. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getCapabilities
fun getCapabilities(): PrinterCapabilitiesInfo?
Gets the printer capabilities.
| Return | |
|---|---|
PrinterCapabilitiesInfo? |
The capabilities. This value may be null. |
getDescription
fun getDescription(): String?
Gets the printer description.
| Return | |
|---|---|
String? |
The description. This value may be null. |
getId
fun getId(): PrinterId
Get the globally unique printer id.
| Return | |
|---|---|
PrinterId |
The printer id. This value cannot be null. |
getName
fun getName(): String
Get the printer name.
| Return | |
|---|---|
String |
The printer name. This value cannot be null. |
getStatus
fun getStatus(): Int
Gets the printer status.
| Return | |
|---|---|
Int |
The status. Value is one of the following: |
See Also
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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.
| Return | |
|---|---|
Int |
a hash code value for this object. |
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
fun writeToParcel(
parcel: Parcel,
flags: Int
): Unit
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
dest |
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_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following:
|