javax.print.attribute (GNU Classpath 0.94-pre Documentation)

Package javax.print.attribute

Provides classes and interfaces describing the roles and syntax of attribute objects in the Java Print Service API.

The package contains the base attribute interface and several subinterfaces describing the different attribute roles of printing attributes.

Interface Summary
Attribute	Base interface of every printing attribute of the Java Print Service API.
AttributeSet	`AttributeSet` is the top-level interface for sets of printing attributes in the Java Print Service API.
DocAttribute	Marker interface for all attribute classes describing attributes of a {@link javax.print.Doc} object.
DocAttributeSet	`DocAttributeSet` specifies an attribute set which only allows printing attributes of type {@link javax.print.attribute.DocAttribute}.
PrintJobAttribute	Marker interface for all attribute classes describing attributes or the status of a ({@link javax.print.DocPrintJob} object.
PrintJobAttributeSet	`PrintJobAttributeSet` specifies an attribute set which only allows printing attributes of type {@link javax.print.attribute.PrintJobAttribute}.
PrintRequestAttribute	Marker interface for all attribute classes which specify a requested attribute of {@link javax.print.DocPrintJob} object.
PrintRequestAttributeSet	`PrintRequestAttributeSet` specifies an attribute set which only allows printing attributes of type {@link javax.print.attribute.PrintRequestAttribute}.
PrintServiceAttribute	Marker interface for all attribute classes describing parameters or the status of a {@link javax.print.PrintService}.
PrintServiceAttributeSet	`PrintServiceAttributeSet` specifies an attribute set which only allows printing attributes of type {@link javax.print.attribute.PrintServiceAttribute}.
SupportedValuesAttribute	Marker interface for all attribute classes specifying the supported/allowed values for another printing attribute class.

Interface Summary

Attribute

Base interface of every printing attribute of the Java Print Service API.

AttributeSet

AttributeSet is the top-level interface for sets of printing attributes in the Java Print Service API.

DocAttribute

Marker interface for all attribute classes describing attributes of a {@link javax.print.Doc} object.

DocAttributeSet

DocAttributeSet specifies an attribute set which only allows printing attributes of type {@link javax.print.attribute.DocAttribute}.

PrintJobAttribute

Marker interface for all attribute classes describing attributes or the status of a ({@link javax.print.DocPrintJob} object.

PrintJobAttributeSet

PrintJobAttributeSet specifies an attribute set which only allows printing attributes of type {@link javax.print.attribute.PrintJobAttribute}.

PrintRequestAttribute

Marker interface for all attribute classes which specify a requested attribute of {@link javax.print.DocPrintJob} object.

PrintRequestAttributeSet

PrintRequestAttributeSet specifies an attribute set which only allows printing attributes of type {@link javax.print.attribute.PrintRequestAttribute}.

PrintServiceAttribute

Marker interface for all attribute classes describing parameters or the status of a {@link javax.print.PrintService}.

PrintServiceAttributeSet

PrintServiceAttributeSet specifies an attribute set which only allows printing attributes of type {@link javax.print.attribute.PrintServiceAttribute}.

SupportedValuesAttribute

Marker interface for all attribute classes specifying the supported/allowed values for another printing attribute class.

Class Summary
AttributeSetUtilities	`AttributeSetUtilities` provides static methods for working with `AttributeSet`s.
DateTimeSyntax	`DateTimeSyntax` is the abstract base class of all attribute classes having a date and a time as value.
EnumSyntax	`EnumSyntax` is the abstract base class of all enumeration classes in the Java Print Service API.
HashAttributeSet	`HashAttributeSet` provides an implementation of {@link javax.print.attribute.AttributeSet}.
HashDocAttributeSet	`HashDocAttributeSet` provides an implementation of {@link javax.print.attribute.DocAttributeSet}.
HashPrintJobAttributeSet	`HashPrintJobAttributeSet` provides an implementation of {@link javax.print.attribute.PrintJobAttributeSet}.
HashPrintRequestAttributeSet	`HashPrintRequestAttributeSet` provides an implementation of {@link javax.print.attribute.PrintRequestAttributeSet}.
HashPrintServiceAttributeSet	`HashPrintServiceAttributeSet` provides an implementation of {@link javax.print.attribute.PrintServiceAttributeSet}.
IntegerSyntax	`IntegerSyntax` is the abstract base class of all attribute classes having an integer as value.
ResolutionSyntax	`ResolutionSyntax` is the abstract base class of all attribute classes which provide a resolution as value (e.g. printer resolution).
SetOfIntegerSyntax	`SetOfIntegerSyntax` is the abstract base class of all attribute classes which provide a set of non-negative integers as value (e.g. the page ranges to print) represented as single values or ranges of values.
Size2DSyntax	`Size2DSyntax` is the abstract base class of all attribute classes which provide a two dimensional size as value (e.g. the size of a media like Letter or A4).
TextSyntax	`TextSyntax` is the abstract base class of all attribute classes which provide a string as value (e.g. the location of the printer).
URISyntax	`URISyntax` is the abstract base class of all attribute classes having an Uniform Resource Identifier URI as value.

Class Summary

AttributeSetUtilities

AttributeSetUtilities provides static methods for working with AttributeSets.

DateTimeSyntax

DateTimeSyntax is the abstract base class of all attribute classes having a date and a time as value.

EnumSyntax

EnumSyntax is the abstract base class of all enumeration classes in the Java Print Service API.

HashAttributeSet

HashAttributeSet provides an implementation of {@link javax.print.attribute.AttributeSet}.

HashDocAttributeSet

HashDocAttributeSet provides an implementation of {@link javax.print.attribute.DocAttributeSet}.

HashPrintJobAttributeSet

HashPrintJobAttributeSet provides an implementation of {@link javax.print.attribute.PrintJobAttributeSet}.

HashPrintRequestAttributeSet

HashPrintRequestAttributeSet provides an implementation of {@link javax.print.attribute.PrintRequestAttributeSet}.

HashPrintServiceAttributeSet

HashPrintServiceAttributeSet provides an implementation of {@link javax.print.attribute.PrintServiceAttributeSet}.

IntegerSyntax

IntegerSyntax is the abstract base class of all attribute classes having an integer as value.

ResolutionSyntax

ResolutionSyntax is the abstract base class of all attribute classes which provide a resolution as value (e.g. printer resolution).

SetOfIntegerSyntax

SetOfIntegerSyntax is the abstract base class of all attribute classes which provide a set of non-negative integers as value (e.g. the page ranges to print) represented as single values or ranges of values.

Size2DSyntax

Size2DSyntax is the abstract base class of all attribute classes which provide a two dimensional size as value (e.g. the size of a media like Letter or A4).

TextSyntax

TextSyntax is the abstract base class of all attribute classes which provide a string as value (e.g. the location of the printer).

URISyntax

URISyntax is the abstract base class of all attribute classes having an Uniform Resource Identifier URI as value.

Exception Summary
UnmodifiableSetException	Exception which is thrown if an operation on an unmodifiable set is invoked.

Exception Summary

UnmodifiableSetException

Exception which is thrown if an operation on an unmodifiable set is invoked.

Package javax.print.attribute Description:

Provides classes and interfaces describing the roles and syntax of attribute objects in the Java Print Service API.

The package contains the base attribute interface and several subinterfaces describing the different attribute roles of printing attributes. Furthermore, abstract classes defining the syntax of attributes are provided. For collections of attributes based on their roles different set interfaces and implementing classes are available.

Existing attribute roles are:

PrintServiceAttributes describing the state and other informations of a PrintService.
PrintJobAttributes describing the state of the print job.
PrintRequestAttributes specifying how a print job should be printed and are applied to a complete print job.
PrintJobAttribute s specifying how a single document in the print job should be printed.

Every attribute is of a certain syntax which defines its type and the representation of its value. The different syntax types are provided as abstract syntax classes (e.g. IntegerSyntax). Concrete attribute implementations are subclasses of these abstract syntax classes.

Attributes may be collected as sets of attributes. Different interfaces for attribute collections per role and implementations based on a HashMap are provided (for example HashPrintJobAttributeSet for the print job attributes).

Since: 1.4