PrinterCapabilitiesInfo

public final class PrinterCapabilitiesInfo
extends Object implements Parcelable

java.lang.Object
   ↳ android.print.PrinterCapabilitiesInfo


This class represents the capabilities of a printer. Instances of this class are created by a print service to report the capabilities of a printer it manages. The capabilities of a printer specify how it can print content. For example, what are the media sizes supported by the printer, what are the minimal margins of the printer based on its technical design, etc.

Summary

Nested classes

class PrinterCapabilitiesInfo.Builder

Builder for creating of a PrinterCapabilitiesInfo

Inherited constants

Fields

public static final Creator<PrinterCapabilitiesInfo> 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.

int getColorModes()

Gets the bit mask of supported color modes.

PrintAttributes getDefaults()

Gets the default print attributes.

int getDuplexModes()

Gets the bit mask of supported duplex modes.

List<PrintAttributes.MediaSize> getMediaSizes()

Gets the supported media sizes.

PrintAttributes.Margins getMinMargins()

Gets the minimal margins.

List<PrintAttributes.Resolution> getResolutions()

Gets the supported resolutions.

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

Fields

CREATOR

Added in API level 19
public static final Creator<PrinterCapabilitiesInfo> CREATOR

Public methods

describeContents

Added in API level 19
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

Added in API level 19
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.

Parameters
obj Object: This value may be null.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getColorModes

Added in API level 19
public int getColorModes ()

Gets the bit mask of supported color modes.

Returns
int The bit mask of supported color modes. Value is either 0 or a combination of PrintAttributes.COLOR_MODE_MONOCHROME, and PrintAttributes.COLOR_MODE_COLOR

getDefaults

Added in API level 19
public PrintAttributes getDefaults ()

Gets the default print attributes.

Returns
PrintAttributes The default attributes. This value cannot be null.

getDuplexModes

Added in API level 23
public int getDuplexModes ()

Gets the bit mask of supported duplex modes.

Returns
int The bit mask of supported duplex modes. Value is either 0 or a combination of PrintAttributes.DUPLEX_MODE_NONE, PrintAttributes.DUPLEX_MODE_LONG_EDGE, and PrintAttributes.DUPLEX_MODE_SHORT_EDGE

getMediaSizes

Added in API level 19
public List<PrintAttributes.MediaSize> getMediaSizes ()

Gets the supported media sizes.

Returns
List<PrintAttributes.MediaSize> The media sizes. This value cannot be null.

getMinMargins

Added in API level 19
public PrintAttributes.Margins getMinMargins ()

Gets the minimal margins. These are the minimal margins the printer physically supports.

Returns
PrintAttributes.Margins The minimal margins. This value cannot be null.

getResolutions

Added in API level 19
public List<PrintAttributes.Resolution> getResolutions ()

Gets the supported resolutions.

Returns
List<PrintAttributes.Resolution> The resolutions. This value cannot be null.

hashCode

Added in API level 19
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 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 equals 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 equals 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.

Returns
int a hash code value for this object.

toString

Added in API level 19
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 19
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