All Implemented Interfaces:


public class IppPrinter

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`IppPrinter.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private File`	`printerDirectory`
`private Boolean`	`throwIfSupportedAttributeIsNotAvailable`
`private final IppConfig`	`ippConfig`
`private List<String>`	`getJobsRequestedAttributes`
`private final IppString`	`name`
`private final IppString`	`makeAndModel`
`private final IppString`	`info`
`private final IppString`	`location`
`private final Boolean`	`isAcceptingJobs`
`private final PrinterState`	`state`
`private final List<String>`	`stateReasons`
`private final IppString`	`stateMessage`
`private final List<String>`	`documentFormatSupported`
`private final List<IppOperation>`	`operationsSupported`
`private final Boolean`	`colorSupported`
`private final List<String>`	`sidesSupported`
`private final List<String>`	`notifyEventsSupported`
`private final List<String>`	`mediaSupported`
`private final List<String>`	`mediaReady`
`private final String`	`mediaDefault`
`private final List<String>`	`mediaSourceSupported`
`private final List<String>`	`mediaTypeSupported`
`private final List<String>`	`versionsSupported`
`private final List<CommunicationChannel>`	`communicationChannelsSupported`
`private final Pair<Double, Double>`	`geoLocation`
`private final List<String>`	`alert`
`private final List<IppString>`	`alertDescription`
`private final List<String>`	`identifyActionsSupported`
`private final List<String>`	`outputBinSupported`
`private final MediaSize`	`mediaSizeDefault`
`private final MediaSizeSupported`	`mediaSizeSupported`
`private final MediaCollection`	`mediaColDefault`
`private final List<MediaCollection>`	`mediaColReady`
`private final Collection<Marker>`	`markers`
`private final URI`	`deviceUri`
`private final PrinterType`	`printerType`
`private final String`	`cupsVersion`
`private final Collection<IppAttribute<?>>`	`supportedAttributes`
`private final URI`	`printerUri`
`private final IppAttributesGroup`	`attributes`
`private final IppClient`	`ippClient`

Constructor Summary

Constructors
Constructor	Description
`IppPrinter(IppAttributesGroup printerAttributes, IppClient ippClient)`
`IppPrinter(String printerUri, IppConfig ippConfig)`
`IppPrinter(String printerUri, Boolean getPrinterAttributesOnInit)`
`IppPrinter(URI printerUri, IppAttributesGroup attributes, IppConfig ippConfig, IppClient ippClient, Boolean getPrinterAttributesOnInit, List<String> requestedAttributesOnInit)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final File`	`getPrinterDirectory()`
`final Unit`	`setPrinterDirectory(File printerDirectory)`
`final Boolean`	`getThrowIfSupportedAttributeIsNotAvailable()`
`final Unit`	`setThrowIfSupportedAttributeIsNotAvailable(Boolean throwIfSupportedAttributeIsNotAvailable)`
`final IppConfig`	`getIppConfig()`
`final List<String>`	`getGetJobsRequestedAttributes()`
`final Unit`	`setGetJobsRequestedAttributes(List<String> getJobsRequestedAttributes)`
`final IppString`	`getName()`
`final IppString`	`getMakeAndModel()`
`final IppString`	`getInfo()`
`final IppString`	`getLocation()`
`final Boolean`	`isAcceptingJobs()`
`final PrinterState`	`getState()`
`final List<String>`	`getStateReasons()`
`final IppString`	`getStateMessage()`
`final List<String>`	`getDocumentFormatSupported()`
`final List<IppOperation>`	`getOperationsSupported()`
`final Boolean`	`getColorSupported()`
`final List<String>`	`getSidesSupported()`
`final List<String>`	`getNotifyEventsSupported()`
`final List<String>`	`getMediaSupported()`
`final List<String>`	`getMediaReady()`
`final String`	`getMediaDefault()`
`final List<String>`	`getMediaSourceSupported()`
`final List<String>`	`getMediaTypeSupported()`
`final List<String>`	`getVersionsSupported()`
`final List<CommunicationChannel>`	`getCommunicationChannelsSupported()`
`final Pair<Double, Double>`	`getGeoLocation()`
`final List<String>`	`getAlert()`
`final List<IppString>`	`getAlertDescription()`
`final List<String>`	`getIdentifyActionsSupported()`
`final List<String>`	`getOutputBinSupported()`
`final MediaSize`	`getMediaSizeDefault()`
`final MediaSizeSupported`	`getMediaSizeSupported()`
`final MediaCollection`	`getMediaColDefault()`
`final List<MediaCollection>`	`getMediaColReady()`
`final Collection<Marker>`	`getMarkers()`
`final URI`	`getDeviceUri()`
`final PrinterType`	`getPrinterType()`
`final String`	`getCupsVersion()`
`final Collection<IppAttribute<?>>`	`getSupportedAttributes()`
`final URI`	`getPrinterUri()`
`final IppAttributesGroup`	`getAttributes()`
`final IppClient`	`getIppClient()`
`final Unit`	`basicAuth(String user, String password)`
`final MediaColDatabase`	`getMediaColDatabase()`
`final Marker`	`marker(Marker.Color color)`
`final Boolean`	`hasCapability(PrinterType.Capability capability)`
`final Boolean`	`isIdle(Boolean updateStateAttributes)`
`final Boolean`	`isStopped(Boolean updateStateAttributes)`
`final Boolean`	`isProcessing(Boolean updateStateAttributes)`
`final Boolean`	`isPaused()`
`final Boolean`	`isOffline()`
`final Boolean`	`isTonerLow()`
`final Boolean`	`isTonerEmpty()`
`final Boolean`	`isMediaJam()`
`final Boolean`	`isMediaLow()`
`final Boolean`	`isMediaEmpty()`
`final Boolean`	`isMediaNeeded()`
`final Boolean`	`isSpoolAreaFull()`
`final Boolean`	`supportsOperations(IppOperation operations)`
`final Boolean`	`isDuplexSupported()`
`final Boolean`	`supportsVersion(String version)`
`final Boolean`	`isCups()`
`final Boolean`	`isMediaSizeSupported(MediaSize size)`
`final Boolean`	`isMediaSizeReady(MediaSize size)`
`final List<MediaSource>`	`sourcesOfMediaSizeReady(MediaSize size)`
`final IppResponse`	`identify(String actions)`
`final IppResponse`	`identify(List<String> actions, String message)`
`final IppResponse`	`flash()`
`final IppResponse`	`sound()`
`final IppResponse`	`display(String message)`
`final IppResponse`	`pause()`
`final IppResponse`	`resume()`
`final IppResponse`	`purgeJobs()`
`final IppResponse`	`enable()`
`final IppResponse`	`disable()`
`final IppResponse`	`holdNewJobs()`
`final IppResponse`	`releaseHeldNewJobs()`
`final IppResponse`	`cancelJobs()`
`final Unit`	`cancelJobs(WhichJobs whichJobs)`
`final IppResponse`	`cancelMyJobs()`
`final IppResponse`	`acceptJobs()`
`final IppResponse`	`rejectJobs()`
`final IppResponse`	`cupsGetPPD(OutputStream copyTo)`
`final File`	`savePPD(File directory, String filename)`
`final IppAttributesGroup`	`getPrinterAttributesOrNull(Collection<String> requestedAttributes)`
`final IppAttributesGroup`	`getPrinterAttributesOrNull(String requestedAttributes)`
`final Unit`	`updateAttributes(List<String> requestedAttributes)`
`final Unit`	`updateAttributes(String requestedAttributes)`
`final Unit`	`updateStateAttributes()`
`final Duration`	`getAgeOfStateAttributes()`
`final Boolean`	`stateAttributesAreOlderThan(Duration duration)`
`final IppResponse`	`validateJob(Collection<IppAttributeBuilder> attributeBuilders)`
`final IppResponse`	`validateJob(IppAttributeBuilder attributeBuilders)`
`final IppJob`	`printJob(InputStream inputStream, Collection<IppAttributeBuilder> attributeBuilders, List<String> notifyEvents)`
`final IppJob`	`printJob(InputStream inputStream, Collection<IppAttributeBuilder> attributeBuilders)`
`final IppJob`	`printJob(ByteArray byteArray, Collection<IppAttributeBuilder> attributeBuilders, List<String> notifyEvents)`
`final IppJob`	`printJob(ByteArray byteArray, Collection<IppAttributeBuilder> attributeBuilders)`
`final IppJob`	`printJob(File file, Collection<IppAttributeBuilder> attributeBuilders, List<String> notifyEvents)`
`final IppJob`	`printJob(File file, Collection<IppAttributeBuilder> attributeBuilders)`
`final IppJob`	`printJob(InputStream inputStream, IppAttributeBuilder attributeBuilders, List<String> notifyEvents)`
`final IppJob`	`printJob(InputStream inputStream, IppAttributeBuilder attributeBuilders)`
`final IppJob`	`printJob(ByteArray byteArray, IppAttributeBuilder attributeBuilders, List<String> notifyEvents)`
`final IppJob`	`printJob(ByteArray byteArray, IppAttributeBuilder attributeBuilders)`
`final IppJob`	`printJob(File file, IppAttributeBuilder attributeBuilders, List<String> notifyEvents)`
`final IppJob`	`printJob(File file, IppAttributeBuilder attributeBuilders)`
`final IppJob`	`printUri(URI documentUri, IppAttributeBuilder attributeBuilders)`
`final IppJob`	`createJob(IppAttributeBuilder attributeBuilders)`
`final IppAttribute<?>`	`buildIppAttribute(IppAttributeBuilder attributeBuilder)`
`final IppJob`	`getJob(Integer jobId)`
`final Collection<IppJob>`	`getJobs(WhichJobs whichJobs, Boolean myJobs, Integer limit, List<String> requestedAttributes)`
`final Collection<IppJob>`	`getJobs(WhichJobs whichJobs, Boolean myJobs, Integer limit)`
`final Collection<IppJob>`	`getJobs(WhichJobs whichJobs, Boolean myJobs)`
`final Collection<IppJob>`	`getJobs(WhichJobs whichJobs)`
`final Collection<IppJob>`	`getJobs()`
`final Collection<IppJob>`	`getJobs(WhichJobs whichJobs, String requestedAttributes)`
`final IppSubscription`	`createPrinterSubscription(Collection<String> notifyEvents, Duration notifyLeaseDuration, Duration notifyTimeInterval)`
`final Unit`	`checkNotifyEvents(Collection<String> notifyEvents)`
`final IppSubscription`	`getSubscription(Integer id)`
`final List<IppSubscription>`	`getSubscriptions(Integer notifyJobId, Boolean mySubscriptions, Integer limit, Collection<String> requestedAttributes)`
`final IppRequest`	`ippRequest(IppOperation operation, Collection<String> requestedAttributes, String userName, URI printerUri, String naturalLanguage)`
`final IppResponse`	`exchange(IppRequest request)`
`String`	`toString()`
`final Unit`	`log(Logger logger, Level level)`
`final Unit`	`log(Logger logger)`
`final File`	`savePrinterAttributes()`
`final Collection<File>`	`savePrinterIcons()`
`final URI`	`getPrinterStringsUri(String language)`
`final File`	`savePrinterStrings(String language)`
`final Collection<File>`	`saveAllPrinterStrings()`
`final File`	`createDirectoryIfNotExists(File $self, Boolean throwOnFailure)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IppPrinter

IppPrinter(IppAttributesGroup printerAttributes, IppClient ippClient)

IppPrinter

IppPrinter(String printerUri, IppConfig ippConfig)

IppPrinter

IppPrinter(String printerUri, Boolean getPrinterAttributesOnInit)

IppPrinter

IppPrinter(URI printerUri, IppAttributesGroup attributes, IppConfig ippConfig, IppClient ippClient, Boolean getPrinterAttributesOnInit, List<String> requestedAttributesOnInit)

Method Detail

getPrinterDirectory
```
 final File getPrinterDirectory()
```

setPrinterDirectory

 final Unit setPrinterDirectory(File printerDirectory)

getThrowIfSupportedAttributeIsNotAvailable

 final Boolean getThrowIfSupportedAttributeIsNotAvailable()

setThrowIfSupportedAttributeIsNotAvailable

 final Unit setThrowIfSupportedAttributeIsNotAvailable(Boolean throwIfSupportedAttributeIsNotAvailable)

getIppConfig
```
 final IppConfig getIppConfig()
```

getGetJobsRequestedAttributes

 final List<String> getGetJobsRequestedAttributes()

setGetJobsRequestedAttributes

 final Unit setGetJobsRequestedAttributes(List<String> getJobsRequestedAttributes)

getName
```
 final IppString getName()
```

getMakeAndModel
```
 final IppString getMakeAndModel()
```

getInfo
```
 final IppString getInfo()
```

getLocation
```
 final IppString getLocation()
```

isAcceptingJobs
```
 final Boolean isAcceptingJobs()
```

getState
```
 final PrinterState getState()
```

getStateReasons
```
 final List<String> getStateReasons()
```

getStateMessage
```
 final IppString getStateMessage()
```

getDocumentFormatSupported

 final List<String> getDocumentFormatSupported()

getOperationsSupported

 final List<IppOperation> getOperationsSupported()

getColorSupported
```
 final Boolean getColorSupported()
```

getSidesSupported
```
 final List<String> getSidesSupported()
```

getNotifyEventsSupported

 final List<String> getNotifyEventsSupported()

getMediaSupported
```
 final List<String> getMediaSupported()
```

getMediaReady
```
 final List<String> getMediaReady()
```

getMediaDefault
```
 final String getMediaDefault()
```

getMediaSourceSupported

 final List<String> getMediaSourceSupported()

getMediaTypeSupported

 final List<String> getMediaTypeSupported()

getVersionsSupported

 final List<String> getVersionsSupported()

getCommunicationChannelsSupported

 final List<CommunicationChannel> getCommunicationChannelsSupported()

getGeoLocation

 final Pair<Double, Double> getGeoLocation()

getAlert
```
 final List<String> getAlert()
```

getAlertDescription

 final List<IppString> getAlertDescription()

getIdentifyActionsSupported

 final List<String> getIdentifyActionsSupported()

getOutputBinSupported

 final List<String> getOutputBinSupported()

getMediaSizeDefault
```
 final MediaSize getMediaSizeDefault()
```

getMediaSizeSupported

 final MediaSizeSupported getMediaSizeSupported()

getMediaColDefault

 final MediaCollection getMediaColDefault()

getMediaColReady

 final List<MediaCollection> getMediaColReady()

getMarkers
```
 final Collection<Marker> getMarkers()
```

getDeviceUri
```
 final URI getDeviceUri()
```

getPrinterType
```
 final PrinterType getPrinterType()
```

getCupsVersion
```
 final String getCupsVersion()
```

getSupportedAttributes

 final Collection<IppAttribute<?>> getSupportedAttributes()

getPrinterUri
```
 final URI getPrinterUri()
```

getAttributes

 final IppAttributesGroup getAttributes()

getIppClient
```
 final IppClient getIppClient()
```

basicAuth

 final Unit basicAuth(String user, String password)

getMediaColDatabase

 final MediaColDatabase getMediaColDatabase()

marker

 final Marker marker(Marker.Color color)

hasCapability

 final Boolean hasCapability(PrinterType.Capability capability)

isIdle

 final Boolean isIdle(Boolean updateStateAttributes)

isStopped

 final Boolean isStopped(Boolean updateStateAttributes)

isProcessing

 final Boolean isProcessing(Boolean updateStateAttributes)

isPaused
```
 final Boolean isPaused()
```

isOffline
```
 final Boolean isOffline()
```

isTonerLow
```
 final Boolean isTonerLow()
```

isTonerEmpty
```
 final Boolean isTonerEmpty()
```

isMediaJam
```
 final Boolean isMediaJam()
```

isMediaLow
```
 final Boolean isMediaLow()
```

isMediaEmpty
```
 final Boolean isMediaEmpty()
```

isMediaNeeded
```
 final Boolean isMediaNeeded()
```

isSpoolAreaFull
```
 final Boolean isSpoolAreaFull()
```

supportsOperations

 final Boolean supportsOperations(IppOperation operations)

isDuplexSupported
```
 final Boolean isDuplexSupported()
```

supportsVersion

 final Boolean supportsVersion(String version)

isCups
```
 final Boolean isCups()
```

isMediaSizeSupported

 final Boolean isMediaSizeSupported(MediaSize size)

isMediaSizeReady

 final Boolean isMediaSizeReady(MediaSize size)

sourcesOfMediaSizeReady

 final List<MediaSource> sourcesOfMediaSizeReady(MediaSize size)

identify

 final IppResponse identify(String actions)

identify

 final IppResponse identify(List<String> actions, String message)

flash
```
 final IppResponse flash()
```

sound
```
 final IppResponse sound()
```

display

 final IppResponse display(String message)

pause
```
 final IppResponse pause()
```

resume
```
 final IppResponse resume()
```

purgeJobs
```
 final IppResponse purgeJobs()
```

enable
```
 final IppResponse enable()
```

disable
```
 final IppResponse disable()
```

holdNewJobs
```
 final IppResponse holdNewJobs()
```

releaseHeldNewJobs
```
 final IppResponse releaseHeldNewJobs()
```

cancelJobs
```
 final IppResponse cancelJobs()
```

cancelJobs

 final Unit cancelJobs(WhichJobs whichJobs)

cancelMyJobs
```
 final IppResponse cancelMyJobs()
```

acceptJobs
```
 final IppResponse acceptJobs()
```

rejectJobs
```
 final IppResponse rejectJobs()
```

cupsGetPPD

 final IppResponse cupsGetPPD(OutputStream copyTo)

savePPD

 final File savePPD(File directory, String filename)

getPrinterAttributesOrNull

 final IppAttributesGroup getPrinterAttributesOrNull(Collection<String> requestedAttributes)

getPrinterAttributesOrNull

 final IppAttributesGroup getPrinterAttributesOrNull(String requestedAttributes)

updateAttributes

 final Unit updateAttributes(List<String> requestedAttributes)

updateAttributes

 final Unit updateAttributes(String requestedAttributes)

updateStateAttributes
```
 final Unit updateStateAttributes()
```

getAgeOfStateAttributes

 final Duration getAgeOfStateAttributes()

stateAttributesAreOlderThan

 final Boolean stateAttributesAreOlderThan(Duration duration)

validateJob

 final IppResponse validateJob(Collection<IppAttributeBuilder> attributeBuilders)

validateJob

 final IppResponse validateJob(IppAttributeBuilder attributeBuilders)

printJob

@JvmOverloads() final IppJob printJob(InputStream inputStream, Collection<IppAttributeBuilder> attributeBuilders, List<String> notifyEvents)

printJob

@JvmOverloads() final IppJob printJob(InputStream inputStream, Collection<IppAttributeBuilder> attributeBuilders)

printJob

@JvmOverloads() final IppJob printJob(ByteArray byteArray, Collection<IppAttributeBuilder> attributeBuilders, List<String> notifyEvents)

printJob

@JvmOverloads() final IppJob printJob(ByteArray byteArray, Collection<IppAttributeBuilder> attributeBuilders)

printJob

@JvmOverloads() final IppJob printJob(File file, Collection<IppAttributeBuilder> attributeBuilders, List<String> notifyEvents)

printJob

@JvmOverloads() final IppJob printJob(File file, Collection<IppAttributeBuilder> attributeBuilders)

printJob

@JvmOverloads() final IppJob printJob(InputStream inputStream, IppAttributeBuilder attributeBuilders, List<String> notifyEvents)

printJob

@JvmOverloads() final IppJob printJob(InputStream inputStream, IppAttributeBuilder attributeBuilders)

printJob

@JvmOverloads() final IppJob printJob(ByteArray byteArray, IppAttributeBuilder attributeBuilders, List<String> notifyEvents)

printJob

@JvmOverloads() final IppJob printJob(ByteArray byteArray, IppAttributeBuilder attributeBuilders)

printJob

@JvmOverloads() final IppJob printJob(File file, IppAttributeBuilder attributeBuilders, List<String> notifyEvents)

printJob

@JvmOverloads() final IppJob printJob(File file, IppAttributeBuilder attributeBuilders)

printUri

 final IppJob printUri(URI documentUri, IppAttributeBuilder attributeBuilders)

createJob

 final IppJob createJob(IppAttributeBuilder attributeBuilders)

buildIppAttribute

 final IppAttribute<?> buildIppAttribute(IppAttributeBuilder attributeBuilder)

getJob
```
 final IppJob getJob(Integer jobId)
```

getJobs

@JvmOverloads() final Collection<IppJob> getJobs(WhichJobs whichJobs, Boolean myJobs, Integer limit, List<String> requestedAttributes)

getJobs

@JvmOverloads() final Collection<IppJob> getJobs(WhichJobs whichJobs, Boolean myJobs, Integer limit)

getJobs

@JvmOverloads() final Collection<IppJob> getJobs(WhichJobs whichJobs, Boolean myJobs)

getJobs

@JvmOverloads() final Collection<IppJob> getJobs(WhichJobs whichJobs)

getJobs

@JvmOverloads() final Collection<IppJob> getJobs()

getJobs

 final Collection<IppJob> getJobs(WhichJobs whichJobs, String requestedAttributes)

createPrinterSubscription

 final IppSubscription createPrinterSubscription(Collection<String> notifyEvents, Duration notifyLeaseDuration, Duration notifyTimeInterval)

checkNotifyEvents

 final Unit checkNotifyEvents(Collection<String> notifyEvents)

getSubscription

 final IppSubscription getSubscription(Integer id)

getSubscriptions

 final List<IppSubscription> getSubscriptions(Integer notifyJobId, Boolean mySubscriptions, Integer limit, Collection<String> requestedAttributes)

ippRequest

 final IppRequest ippRequest(IppOperation operation, Collection<String> requestedAttributes, String userName, URI printerUri, String naturalLanguage)

exchange

 final IppResponse exchange(IppRequest request)

toString
```
 String toString()
```

log

@JvmOverloads() final Unit log(Logger logger, Level level)

log

@JvmOverloads() final Unit log(Logger logger)

savePrinterAttributes
```
 final File savePrinterAttributes()
```

savePrinterIcons

 final Collection<File> savePrinterIcons()

getPrinterStringsUri

 final URI getPrinterStringsUri(String language)

savePrinterStrings

 final File savePrinterStrings(String language)

saveAllPrinterStrings

 final Collection<File> saveAllPrinterStrings()

createDirectoryIfNotExists

 final File createDirectoryIfNotExists(File $self, Boolean throwOnFailure)

Class IppPrinter

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IppPrinter

IppPrinter

IppPrinter

IppPrinter

Method Detail

getPrinterDirectory

setPrinterDirectory

getThrowIfSupportedAttributeIsNotAvailable

setThrowIfSupportedAttributeIsNotAvailable

getIppConfig

getGetJobsRequestedAttributes

setGetJobsRequestedAttributes

getName

getMakeAndModel

getInfo

getLocation

isAcceptingJobs

getState

getStateReasons

getStateMessage

getDocumentFormatSupported

getOperationsSupported

getColorSupported

getSidesSupported

getNotifyEventsSupported

getMediaSupported

getMediaReady

getMediaDefault

getMediaSourceSupported

getMediaTypeSupported

getVersionsSupported

getCommunicationChannelsSupported

getGeoLocation

getAlert

getAlertDescription

getIdentifyActionsSupported

getOutputBinSupported

getMediaSizeDefault

getMediaSizeSupported

getMediaColDefault

getMediaColReady

getMarkers

getDeviceUri

getPrinterType

getCupsVersion

getSupportedAttributes

getPrinterUri

getAttributes

getIppClient

basicAuth

getMediaColDatabase

marker

hasCapability

isIdle

isStopped

isProcessing

isPaused

isOffline

isTonerLow

isTonerEmpty

isMediaJam

isMediaLow

isMediaEmpty

isMediaNeeded

isSpoolAreaFull

supportsOperations

isDuplexSupported

supportsVersion

isCups

isMediaSizeSupported

isMediaSizeReady

sourcesOfMediaSizeReady