Class WindowsPrinter

java.lang.Object

oshi.hardware.common.AbstractPrinter

oshi.hardware.common.platform.windows.WindowsPrinter

All Implemented Interfaces:

Printer

@Immutable
public abstract class WindowsPrinter
extends AbstractPrinter

Common Windows printer logic shared between JNA and FFM implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface Printer

Printer.PrinterStatus

Modifier and Type	Interface	Description
static enum	Printer.PrinterStatus	Printer status enumeration.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WindowsPrinter(String name, String driverName, String description, Printer.PrinterStatus status, String statusReason, boolean isDefault, boolean isLocal, String portName)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected static String	parseErrorState(int errorState)	Converts a DetectedErrorState code to a human-readable string.
protected static Printer.PrinterStatus	parseStatus(int statusCode, int errorState)	Parses Win32_Printer PrinterStatus and DetectedErrorState codes.

Methods inherited from class AbstractPrinter

getDescription, getDriverName, getName, getPortName, getStatus, getStatusReason, isDefault, isLocal, toString

Modifier and Type	Method	Description
String	getDescription()	Retrieves the user-friendly description of the printer.
String	getDriverName()	Retrieves the driver name or make/model of the printer.
String	getName()	Retrieves the name of the printer.
String	getPortName()	Retrieves the port name or device URI of the printer.
Printer.PrinterStatus	getStatus()	Retrieves the current status of the printer.
String	getStatusReason()	Retrieves the reason for the current printer status, if available.
boolean	isDefault()	Indicates whether this is the default printer.
boolean	isLocal()	Indicates whether this is a local printer (as opposed to a network printer).
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

WindowsPrinter

protected WindowsPrinter(String name,
 String driverName,
 String description,
 Printer.PrinterStatus status,
 String statusReason,
 boolean isDefault,
 boolean isLocal,
 String portName)

Constructor.

Parameters:

name - the name

driverName - the driverName

description - the description

status - the status

statusReason - the statusReason

isDefault - the isDefault

isLocal - the isLocal

portName - the portName

Method Details

parseStatus

protected static Printer.PrinterStatus parseStatus(int statusCode,
 int errorState)

Parses Win32_Printer PrinterStatus and DetectedErrorState codes.

Parameters:

statusCode - The PrinterStatus code from WMI.

errorState - The DetectedErrorState code from WMI.

Returns:

The corresponding PrinterStatus enum value.

parseErrorState

protected static String parseErrorState(int errorState)

Converts a DetectedErrorState code to a human-readable string.

Parameters:

errorState - The DetectedErrorState code from WMI.

Returns:

A string describing the error state.