OpenJDK 27 · javax.print.PrintService · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public void	addPrintServiceAttributeListener(PrintServiceAttributeListener a PrintServiceAttributeListener, which monitors the status of a print service listener) Registers a listener for events on this `PrintService`.
public DocPrintJob	Returns: a `DocPrintJob` object createPrintJob() Creates and returns a `PrintJob` capable of handling data from any of the supported document flavors.
public boolean	Returns: `true` if this service is the same as the obj argument, `false` otherwise equals(Object the reference object with which to compare obj) Determines if two services are referring to the same underlying service.
public < the type of the specified service attribute T extends PrintServiceAttribute> T	Returns: the value of the supported attribute or `null` if the attribute is not supported by this service getAttribute(Class<T> the category of a `PrintServiceAttribute` supported by this service - may not be `null` category) Gets the value of the single specified service attribute.
public PrintServiceAttributeSet	Returns: unmodifiable snapshot of this Print Service's attribute set. May be empty, but not `null`. getAttributes() Obtains this print service's set of printer description attributes giving this Print Service's status.
public Object	Returns: default attribute value for `category`, or `null` if this Print Service does not support specifying a doc-level or job-level attribute in `category` in a Print Request, or the service does not have a default value for this attribute getDefaultAttributeValue(Class<? extends Attribute> printing attribute category for which the default attribute value is requested. It must be a `Class` that implements interface `Attribute`. category) Determines this print service's default printing attribute value in the given category.
public String	Returns: name of the service getName() Returns a string name for this print service which may be used by applications to request a particular print service.
public ServiceUIFactory	Returns: `null` or a factory for UI components getServiceUIFactory() Returns a factory for UI components which allow users to interact with the service in various roles.
public Class<?>[]	Returns: array of printing attribute categories that the client can specify as a doc-level or job-level attribute in a Print Request. Each element in the array is a `Class` that implements interface `Attribute`. The array is empty if no categories are supported. getSupportedAttributeCategories() Determines the printing attribute categories a client can specify when setting up a job for this print service.
public Object	Returns: object indicating supported values for `category`, or `null` if this Print Service does not support specifying a doc-level or job-level attribute in `category` in a Print Request getSupportedAttributeValues(Class<? extends Attribute> printing attribute category to test. It must be a `Class` that implements interface `Attribute`. category, DocFlavor doc flavor for a supposed job, or `null` flavor, AttributeSet set of printing attributes for a supposed job (both job-level attributes and document-level attributes), or `null` attributes) Determines the printing attribute values a client can specify in the given category when setting up a job for this print service.
public DocFlavor[]	Returns: array of supported doc flavors, should have at least one element getSupportedDocFlavors() Determines the print data formats a client can specify when setting up a job for this `PrintService`.
public AttributeSet	Returns: `null` if this Print Service supports the print request specification, else the unsupported attributes getUnsupportedAttributes(DocFlavor doc flavor to test, or `null` flavor, AttributeSet set of printing attributes for a supposed job (both job-level attributes and document-level attributes), or `null` attributes) Identifies the attributes that are unsupported for a print request in the context of a particular `DocFlavor`.
public int	Returns: hash code of this object hashCode() This method should be implemented consistently with `equals(Object)`.
public boolean	Returns: `true` if this print service supports specifying a doc-level or job-level attribute in `category` in a Print Request; `false` if it doesn't isAttributeCategorySupported(Class<? extends Attribute> printing attribute category to test. It must be a `Class` that implements interface `Attribute`. category) Determines whether a client can specify the given printing attribute category when setting up a job for this print service.
public boolean	Returns: `true` if this Print Service supports specifying `attrval` as a doc-level or job-level attribute in a Print Request, `false` if it doesn't isAttributeValueSupported(Attribute printing attribute value to test attrval, DocFlavor doc flavor for a supposed job, or `null` flavor, AttributeSet set of printing attributes for a supposed job (both job-level attributes and document-level attributes), or `null` attributes) Determines whether a client can specify the given printing attribute value when setting up a job for this Print Service.
public boolean	Returns: `true` if this print service supports the specified `DocFlavor`; `false` otherwise isDocFlavorSupported(DocFlavor the `DocFlavor` to query for support flavor) Determines if this print service supports a specific `DocFlavor`.
public void	removePrintServiceAttributeListener(PrintServiceAttributeListener a `PrintServiceAttributeListener` object listener) Removes the print-service listener from this print service.

Method Detail

addPrintServiceAttributeListener back to summary

addPrintServiceAttributeListener	back to summary
public void addPrintServiceAttributeListener(PrintServiceAttributeListener listener) Registers a listener for events on this `PrintService`. Parameters listener:PrintServiceAttributeListener a PrintServiceAttributeListener, which monitors the status of a print service See Also `removePrintServiceAttributeListener`

public void addPrintServiceAttributeListener(PrintServiceAttributeListener listener)

Registers a listener for events on this PrintService.

Parameters

listener:PrintServiceAttributeListener: a PrintServiceAttributeListener, which monitors the status of a print service

See Also

removePrintServiceAttributeListener

createPrintJob back to summary

createPrintJob	back to summary
public DocPrintJob createPrintJob() Creates and returns a `PrintJob` capable of handling data from any of the supported document flavors. Returns:DocPrintJob a `DocPrintJob` object

public DocPrintJob createPrintJob()

Creates and returns a PrintJob capable of handling data from any of the supported document flavors.

Returns:DocPrintJob: a DocPrintJob object

equals back to summary

equals	back to summary
public boolean equals(Object obj) Determines if two services are referring to the same underlying service. Objects encapsulating a print service may not exhibit equality of reference even though they refer to the same underlying service. Clients should call this method to determine if two services are referring to the same underlying service. Services must implement this method and return `true` only if the service objects being compared may be used interchangeably by the client. Services are free to return the same object reference to an underlying service if that, but clients must not depend on equality of reference. Parameters obj:Object the reference object with which to compare Returns:boolean `true` if this service is the same as the obj argument, `false` otherwise

public boolean equals(Object obj)

Determines if two services are referring to the same underlying service. Objects encapsulating a print service may not exhibit equality of reference even though they refer to the same underlying service.

Clients should call this method to determine if two services are referring to the same underlying service.

Services must implement this method and return true only if the service objects being compared may be used interchangeably by the client. Services are free to return the same object reference to an underlying service if that, but clients must not depend on equality of reference.

Parameters

obj:Object: the reference object with which to compare

Returns:boolean

true if this service is the same as the obj argument, false otherwise

getAttribute back to summary

getAttribute	back to summary
public <T extends PrintServiceAttribute> T getAttribute(Class<T> category) Gets the value of the single specified service attribute. This may be useful to clients which only need the value of one attribute and want to minimize overhead. Parameters <T> the type of the specified service attribute category:Class<T> the category of a `PrintServiceAttribute` supported by this service - may not be `null` Returns:T the value of the supported attribute or `null` if the attribute is not supported by this service Exceptions NullPointerException: if the category is `null` IllegalArgumentException: if `category` is not a `Class` that implements interface `PrintServiceAttribute`

public <T extends PrintServiceAttribute> T getAttribute(Class<T> category)

Gets the value of the single specified service attribute. This may be useful to clients which only need the value of one attribute and want to minimize overhead.

Parameters

<T>: the type of the specified service attribute
category:Class<T>: the category of a PrintServiceAttribute supported by this service - may not be null

Returns:T

the value of the supported attribute or null if the attribute is not supported by this service

Exceptions

NullPointerException:: if the category is null
IllegalArgumentException:: if category is not a Class that implements interface PrintServiceAttribute

getAttributes back to summary

getAttributes	back to summary
public PrintServiceAttributeSet getAttributes() Obtains this print service's set of printer description attributes giving this Print Service's status. The returned attribute set object is unmodifiable. The returned attribute set object is a "snapshot" of this Print Service's attribute set at the time of the `getAttributes()` method call: that is, the returned attribute set's contents will not be updated if this print service's attribute set's contents change in the future. To detect changes in attribute values, call `getAttributes()` again and compare the new attribute set to the previous attribute set; alternatively, register a listener for print service events. Returns:PrintServiceAttributeSet unmodifiable snapshot of this Print Service's attribute set. May be empty, but not `null`.

public PrintServiceAttributeSet getAttributes()

Obtains this print service's set of printer description attributes giving this Print Service's status. The returned attribute set object is unmodifiable. The returned attribute set object is a "snapshot" of this Print Service's attribute set at the time of the getAttributes() method call: that is, the returned attribute set's contents will not be updated if this print service's attribute set's contents change in the future. To detect changes in attribute values, call getAttributes() again and compare the new attribute set to the previous attribute set; alternatively, register a listener for print service events.

Returns:PrintServiceAttributeSet: unmodifiable snapshot of this Print Service's attribute set. May be empty, but not null.

getDefaultAttributeValue back to summary

getDefaultAttributeValue	back to summary
public Object getDefaultAttributeValue(Class<? extends Attribute> category) Determines this print service's default printing attribute value in the given category. A printing attribute value is an instance of a class that implements interface `Attribute`. If a client sets up a print job and does not specify any attribute value in the given category, this Print Service will use the default attribute value instead. Some attributes may not be supported in a particular context (ie for a particular `DocFlavor`). Use one of the methods that include a `DocFlavor` to validate the request before submitting it, such as `getSupportedAttributeValues(..)`. Not all attributes have a default value. For example the service will not have a default value for `RequestingUser` i.e. a `null` return for a supported category means there is no service default value for that category. Use the `isAttributeCategorySupported(Class)` method to distinguish these cases. Parameters category:Class<? extends Attribute> printing attribute category for which the default attribute value is requested. It must be a `Class` that implements interface `Attribute`. Returns:Object default attribute value for `category`, or `null` if this Print Service does not support specifying a doc-level or job-level attribute in `category` in a Print Request, or the service does not have a default value for this attribute Exceptions NullPointerException: if `category` is `null` IllegalArgumentException: if `category` is not a `Class` that implements interface `Attribute`

public Object getDefaultAttributeValue(Class<? extends Attribute> category)

Determines this print service's default printing attribute value in the given category. A printing attribute value is an instance of a class that implements interface Attribute. If a client sets up a print job and does not specify any attribute value in the given category, this Print Service will use the default attribute value instead.

Some attributes may not be supported in a particular context (ie for a particular DocFlavor). Use one of the methods that include a DocFlavor to validate the request before submitting it, such as getSupportedAttributeValues(..).

Not all attributes have a default value. For example the service will not have a default value for RequestingUser i.e. a null return for a supported category means there is no service default value for that category. Use the isAttributeCategorySupported(Class) method to distinguish these cases.

Parameters

category:Class<? extends Attribute>: printing attribute category for which the default attribute value is requested. It must be a Class that implements interface Attribute.

Returns:Object

default attribute value for category, or null if this Print Service does not support specifying a doc-level or job-level attribute in category in a Print Request, or the service does not have a default value for this attribute

Exceptions

NullPointerException:: if category is null
IllegalArgumentException:: if category is not a Class that implements interface Attribute

getName back to summary

getName	back to summary
public String getName() Returns a string name for this print service which may be used by applications to request a particular print service. In a suitable context, such as a name service, this name must be unique. In some environments this unique name may be the same as the user friendly printer name defined as the `PrinterName` attribute. Returns:String name of the service

public String getName()

Returns a string name for this print service which may be used by applications to request a particular print service. In a suitable context, such as a name service, this name must be unique. In some environments this unique name may be the same as the user friendly printer name defined as the PrinterName attribute.

Returns:String: name of the service

getServiceUIFactory back to summary

getServiceUIFactory	back to summary
public ServiceUIFactory getServiceUIFactory() Returns a factory for UI components which allow users to interact with the service in various roles. Services which do not provide any UI should return `null`. Print Services which do provide UI but want to be supported in an environment with no UI support should ensure that the factory is not initialised unless the application calls this method to obtain the factory. See `ServiceUIFactory` for more information. Returns:ServiceUIFactory `null` or a factory for UI components

public ServiceUIFactory getServiceUIFactory()

Returns a factory for UI components which allow users to interact with the service in various roles. Services which do not provide any UI should return null. Print Services which do provide UI but want to be supported in an environment with no UI support should ensure that the factory is not initialised unless the application calls this method to obtain the factory. See ServiceUIFactory for more information.

Returns:ServiceUIFactory: null or a factory for UI components

getSupportedAttributeCategories back to summary

getSupportedAttributeCategories	back to summary
public Class<?>[] getSupportedAttributeCategories() Determines the printing attribute categories a client can specify when setting up a job for this print service. A printing attribute category is designated by a `Class` that implements interface `Attribute`. This method returns just the attribute categories that are supported; it does not return the particular attribute values that are supported. This method returns all the printing attribute categories this print service supports for any possible job. Some categories may not be supported in a particular context (ie for a particular `DocFlavor`). Use one of the methods that include a `DocFlavor` to validate the request before submitting it, such as `getSupportedAttributeValues(..)`. Returns:Class<?>[] array of printing attribute categories that the client can specify as a doc-level or job-level attribute in a Print Request. Each element in the array is a `Class` that implements interface `Attribute`. The array is empty if no categories are supported.

public Class<?>[] getSupportedAttributeCategories()

Determines the printing attribute categories a client can specify when setting up a job for this print service. A printing attribute category is designated by a Class that implements interface Attribute. This method returns just the attribute categories that are supported; it does not return the particular attribute values that are supported.

This method returns all the printing attribute categories this print service supports for any possible job. Some categories may not be supported in a particular context (ie for a particular DocFlavor). Use one of the methods that include a DocFlavor to validate the request before submitting it, such as getSupportedAttributeValues(..).

Returns:Class<?>[]: array of printing attribute categories that the client can specify as a doc-level or job-level attribute in a Print Request. Each element in the array is a Class that implements interface Attribute. The array is empty if no categories are supported.

getSupportedAttributeValues back to summary

getSupportedAttributeValues	back to summary
public Object getSupportedAttributeValues(Class<? extends Attribute> category, DocFlavor flavor, AttributeSet attributes) Determines the printing attribute values a client can specify in the given category when setting up a job for this print service. A printing attribute value is an instance of a class that implements interface `Attribute`. If `flavor` is `null` and `attributes` is `null` or is an empty set, this method returns all the printing attribute values this Print Service supports for any possible job. If `flavor` is not `null` or `attributes` is not an empty set, this method returns just the printing attribute values that are compatible with the given doc flavor and/or set of attributes. That is, a `null` return value may indicate that specifying this attribute is incompatible with the specified DocFlavor. Also if `DocFlavor` is not `null` it must be a flavor supported by this `PrintService`, else `IllegalArgumentException` will be thrown. If the `attributes` parameter contains an `Attribute` whose category is the same as the `category` parameter, the service must ignore this attribute in the `AttributeSet`. `DocAttribute`s which are to be specified on the `Doc` must be included in this set to accurately represent the context. This method returns an `Object` because different printing attribute categories indicate the supported attribute values in different ways. The documentation for each printing attribute in package `javax.print.attribute.standard` describes how each attribute indicates its supported values. Possible ways of indicating support include: Return a single instance of the attribute category to indicate that any value is legal -- used, for example, by an attribute whose value is an arbitrary text string. (The value of the returned attribute object is irrelevant.) Return an array of one or more instances of the attribute category, containing the legal values -- used, for example, by an attribute with a list of enumerated values. The type of the array is an array of the specified attribute category type as returned by its `getCategory(Class)`. Return a single object (of some class other than the attribute category) that indicates bounds on the legal values -- used, for example, by an integer-valued attribute that must lie within a certain range. Parameters category:Class<? extends Attribute> printing attribute category to test. It must be a `Class` that implements interface `Attribute`. flavor:DocFlavor doc flavor for a supposed job, or `null` attributes:AttributeSet set of printing attributes for a supposed job (both job-level attributes and document-level attributes), or `null` Returns:Object object indicating supported values for `category`, or `null` if this Print Service does not support specifying a doc-level or job-level attribute in `category` in a Print Request Exceptions NullPointerException: if `category` is `null` IllegalArgumentException: if `category` is not a `Class` that implements interface `Attribute`, or `DocFlavor` is not supported by this service

public Object getSupportedAttributeValues(Class<? extends Attribute> category, DocFlavor flavor, AttributeSet attributes)

Determines the printing attribute values a client can specify in the given category when setting up a job for this print service. A printing attribute value is an instance of a class that implements interface Attribute.

If flavor is null and attributes is null or is an empty set, this method returns all the printing attribute values this Print Service supports for any possible job. If flavor is not null or attributes is not an empty set, this method returns just the printing attribute values that are compatible with the given doc flavor and/or set of attributes. That is, a null return value may indicate that specifying this attribute is incompatible with the specified DocFlavor. Also if DocFlavor is not null it must be a flavor supported by this PrintService, else IllegalArgumentException will be thrown.

If the attributes parameter contains an Attribute whose category is the same as the category parameter, the service must ignore this attribute in the AttributeSet.

DocAttributes which are to be specified on the Doc must be included in this set to accurately represent the context.

This method returns an Object because different printing attribute categories indicate the supported attribute values in different ways. The documentation for each printing attribute in package javax.print.attribute.standard describes how each attribute indicates its supported values. Possible ways of indicating support include:

Return a single instance of the attribute category to indicate that any value is legal -- used, for example, by an attribute whose value is an arbitrary text string. (The value of the returned attribute object is irrelevant.)
Return an array of one or more instances of the attribute category, containing the legal values -- used, for example, by an attribute with a list of enumerated values. The type of the array is an array of the specified attribute category type as returned by its getCategory(Class).
Return a single object (of some class other than the attribute category) that indicates bounds on the legal values -- used, for example, by an integer-valued attribute that must lie within a certain range.

Parameters

category:Class<? extends Attribute>: printing attribute category to test. It must be a Class that implements interface Attribute.
flavor:DocFlavor: doc flavor for a supposed job, or null
attributes:AttributeSet: set of printing attributes for a supposed job (both job-level attributes and document-level attributes), or null

Returns:Object

object indicating supported values for category, or null if this Print Service does not support specifying a doc-level or job-level attribute in category in a Print Request

Exceptions

NullPointerException:: if category is null
IllegalArgumentException:: if category is not a Class that implements interface Attribute, or DocFlavor is not supported by this service

getSupportedDocFlavors back to summary

getSupportedDocFlavors	back to summary
public DocFlavor[] getSupportedDocFlavors() Determines the print data formats a client can specify when setting up a job for this `PrintService`. A print data format is designated by a "doc flavor" (class `DocFlavor`) consisting of a MIME type plus a print data representation class. Note that some doc flavors may not be supported in combination with all attributes. Use `getUnsupportedAttributes(..)` to validate specific combinations. Returns:DocFlavor[] array of supported doc flavors, should have at least one element

public DocFlavor[] getSupportedDocFlavors()

Determines the print data formats a client can specify when setting up a job for this PrintService. A print data format is designated by a "doc flavor" (class DocFlavor) consisting of a MIME type plus a print data representation class.

Note that some doc flavors may not be supported in combination with all attributes. Use getUnsupportedAttributes(..) to validate specific combinations.

Returns:DocFlavor[]: array of supported doc flavors, should have at least one element

getUnsupportedAttributes back to summary

getUnsupportedAttributes	back to summary
public AttributeSet getUnsupportedAttributes(DocFlavor flavor, AttributeSet attributes) Identifies the attributes that are unsupported for a print request in the context of a particular `DocFlavor`. This method is useful for validating a potential print job and identifying the specific attributes which cannot be supported. It is important to supply only a supported `DocFlavor` or an `IllegalArgumentException` will be thrown. If the return value from this method is `null`, all attributes are supported. `DocAttribute`s which are to be specified on the `Doc` must be included in this set to accurately represent the context. If the return value is `non-null`, all attributes in the returned set are unsupported with this `DocFlavor`. The returned set does not distinguish attribute categories that are unsupported from unsupported attribute values. A supported print request can then be created by removing all unsupported attributes from the original attribute set, except in the case that the `DocFlavor` is unsupported. If any attributes are unsupported only because they are in conflict with other attributes then it is at the discretion of the service to select the attribute(s) to be identified as the cause of the conflict. Use `isDocFlavorSupported()` to verify that a `DocFlavor` is supported before calling this method. Parameters flavor:DocFlavor doc flavor to test, or `null` attributes:AttributeSet set of printing attributes for a supposed job (both job-level attributes and document-level attributes), or `null` Returns:AttributeSet `null` if this Print Service supports the print request specification, else the unsupported attributes Exceptions IllegalArgumentException: if `flavor` is not supported by this `PrintService`

public AttributeSet getUnsupportedAttributes(DocFlavor flavor, AttributeSet attributes)

Identifies the attributes that are unsupported for a print request in the context of a particular DocFlavor. This method is useful for validating a potential print job and identifying the specific attributes which cannot be supported. It is important to supply only a supported DocFlavor or an IllegalArgumentException will be thrown. If the return value from this method is null, all attributes are supported.

DocAttributes which are to be specified on the Doc must be included in this set to accurately represent the context.

If the return value is non-null, all attributes in the returned set are unsupported with this DocFlavor. The returned set does not distinguish attribute categories that are unsupported from unsupported attribute values.

A supported print request can then be created by removing all unsupported attributes from the original attribute set, except in the case that the DocFlavor is unsupported.

If any attributes are unsupported only because they are in conflict with other attributes then it is at the discretion of the service to select the attribute(s) to be identified as the cause of the conflict.

Use isDocFlavorSupported() to verify that a DocFlavor is supported before calling this method.

Parameters

flavor:DocFlavor: doc flavor to test, or null
attributes:AttributeSet: set of printing attributes for a supposed job (both job-level attributes and document-level attributes), or null

Returns:AttributeSet

null if this Print Service supports the print request specification, else the unsupported attributes

Exceptions

IllegalArgumentException:: if flavor is not supported by this PrintService

hashCode back to summary

hashCode	back to summary
public int hashCode() This method should be implemented consistently with `equals(Object)`. Returns:int hash code of this object

public int hashCode()

This method should be implemented consistently with equals(Object).

Returns:int: hash code of this object

isAttributeCategorySupported back to summary

isAttributeCategorySupported	back to summary
public boolean isAttributeCategorySupported(Class<? extends Attribute> category) Determines whether a client can specify the given printing attribute category when setting up a job for this print service. A printing attribute category is designated by a `Class` that implements interface `Attribute`. This method tells whether the attribute category is supported; it does not tell whether a particular attribute value is supported. Some categories may not be supported in a particular context (ie for a particular `DocFlavor`). Use one of the methods which include a `DocFlavor` to validate the request before submitting it, such as `getSupportedAttributeValues(..)`. This is a convenience method to determine if the category would be a member of the result of `getSupportedAttributeCategories()`. Parameters category:Class<? extends Attribute> printing attribute category to test. It must be a `Class` that implements interface `Attribute`. Returns:boolean `true` if this print service supports specifying a doc-level or job-level attribute in `category` in a Print Request; `false` if it doesn't Exceptions NullPointerException: if `category` is `null` IllegalArgumentException: if `category` is not a `Class` that implements interface `Attribute`

public boolean isAttributeCategorySupported(Class<? extends Attribute> category)

Determines whether a client can specify the given printing attribute category when setting up a job for this print service. A printing attribute category is designated by a Class that implements interface Attribute. This method tells whether the attribute category is supported; it does not tell whether a particular attribute value is supported.

Some categories may not be supported in a particular context (ie for a particular DocFlavor). Use one of the methods which include a DocFlavor to validate the request before submitting it, such as getSupportedAttributeValues(..).

This is a convenience method to determine if the category would be a member of the result of getSupportedAttributeCategories().

Parameters

category:Class<? extends Attribute>: printing attribute category to test. It must be a Class that implements interface Attribute.

Returns:boolean

true if this print service supports specifying a doc-level or job-level attribute in category in a Print Request; false if it doesn't

Exceptions

NullPointerException:: if category is null
IllegalArgumentException:: if category is not a Class that implements interface Attribute

isAttributeValueSupported back to summary

isAttributeValueSupported	back to summary
public boolean isAttributeValueSupported(Attribute attrval, DocFlavor flavor, AttributeSet attributes) Determines whether a client can specify the given printing attribute value when setting up a job for this Print Service. A printing attribute value is an instance of a class that implements interface `Attribute`. If `flavor` is `null` and `attributes` is `null` or is an empty set, this method tells whether this Print Service supports the given printing attribute value for some possible combination of doc flavor and set of attributes. If `flavor` is not `null` or `attributes` is not an empty set, this method tells whether this Print Service supports the given printing attribute value in combination with the given doc flavor and/or set of attributes. Also if `DocFlavor` is not `null` it must be a flavor supported by this `PrintService`, else `IllegalArgumentException` will be thrown. `DocAttribute`s which are to be specified on the `Doc` must be included in this set to accurately represent the context. This is a convenience method to determine if the value would be a member of the result of `getSupportedAttributeValues(...)`. Parameters attrval:Attribute printing attribute value to test flavor:DocFlavor doc flavor for a supposed job, or `null` attributes:AttributeSet set of printing attributes for a supposed job (both job-level attributes and document-level attributes), or `null` Returns:boolean `true` if this Print Service supports specifying `attrval` as a doc-level or job-level attribute in a Print Request, `false` if it doesn't Exceptions NullPointerException: if `attrval` is `null` IllegalArgumentException: if flavor is not supported by this `PrintService`

public boolean isAttributeValueSupported(Attribute attrval, DocFlavor flavor, AttributeSet attributes)

Determines whether a client can specify the given printing attribute value when setting up a job for this Print Service. A printing attribute value is an instance of a class that implements interface Attribute.

If flavor is null and attributes is null or is an empty set, this method tells whether this Print Service supports the given printing attribute value for some possible combination of doc flavor and set of attributes. If flavor is not null or attributes is not an empty set, this method tells whether this Print Service supports the given printing attribute value in combination with the given doc flavor and/or set of attributes.

Also if DocFlavor is not null it must be a flavor supported by this PrintService, else IllegalArgumentException will be thrown.

DocAttributes which are to be specified on the Doc must be included in this set to accurately represent the context.

This is a convenience method to determine if the value would be a member of the result of getSupportedAttributeValues(...).

Parameters

attrval:Attribute: printing attribute value to test
flavor:DocFlavor: doc flavor for a supposed job, or null
attributes:AttributeSet: set of printing attributes for a supposed job (both job-level attributes and document-level attributes), or null

Returns:boolean

true if this Print Service supports specifying attrval as a doc-level or job-level attribute in a Print Request, false if it doesn't

Exceptions

NullPointerException:: if attrval is null
IllegalArgumentException:: if flavor is not supported by this PrintService

isDocFlavorSupported back to summary

isDocFlavorSupported	back to summary
public boolean isDocFlavorSupported(DocFlavor flavor) Determines if this print service supports a specific `DocFlavor`. This is a convenience method to determine if the `DocFlavor` would be a member of the result of `getSupportedDocFlavors()`. Note that some doc flavors may not be supported in combination with all attributes. Use `getUnsupportedAttributes(..)` to validate specific combinations. Parameters flavor:DocFlavor the `DocFlavor` to query for support Returns:boolean `true` if this print service supports the specified `DocFlavor`; `false` otherwise Exceptions NullPointerException: if `flavor` is `null`

public boolean isDocFlavorSupported(DocFlavor flavor)

Determines if this print service supports a specific DocFlavor. This is a convenience method to determine if the DocFlavor would be a member of the result of getSupportedDocFlavors().

Note that some doc flavors may not be supported in combination with all attributes. Use getUnsupportedAttributes(..) to validate specific combinations.

Parameters

flavor:DocFlavor: the DocFlavor to query for support

Returns:boolean

true if this print service supports the specified DocFlavor; false otherwise

Exceptions

NullPointerException:: if flavor is null

removePrintServiceAttributeListener back to summary

removePrintServiceAttributeListener	back to summary
public void removePrintServiceAttributeListener(PrintServiceAttributeListener listener) Removes the print-service listener from this print service. This means the listener is no longer interested in `PrintService` events. Parameters listener:PrintServiceAttributeListener a `PrintServiceAttributeListener` object See Also `addPrintServiceAttributeListener`

public void removePrintServiceAttributeListener(PrintServiceAttributeListener listener)

Removes the print-service listener from this print service. This means the listener is no longer interested in PrintService events.

Parameters

listener:PrintServiceAttributeListener: a PrintServiceAttributeListener object

See Also

addPrintServiceAttributeListener

public Interface PrintService

Method Summary

Method Detail