- java.lang.Object
-
- javax.print.attribute.AttributeSetUtilities
-
public final class AttributeSetUtilities extends Object
Class AttributeSetUtilities provides static methods for manipulating AttributeSets.- Methods for creating unmodifiable and synchronized views of attribute sets.
- operations useful for building
implementations of interface
AttributeSet
An unmodifiable view U of an AttributeSet S provides a client with "read-only" access to S. Query operations on U "read through" to S; thus, changes in S are reflected in U. However, any attempt to modify U, results in an UnmodifiableSetException. The unmodifiable view object U will be serializable if the attribute set object S is serializable.
A synchronized view V of an attribute set S provides a client with synchronized (multiple thread safe) access to S. Each operation of V is synchronized using V itself as the lock object and then merely invokes the corresponding operation of S. In order to guarantee mutually exclusive access, it is critical that all access to S is accomplished through V. The synchronized view object V will be serializable if the attribute set object S is serializable.
As mentioned in the package description of javax.print, a null reference parameter to methods is incorrect unless explicitly documented on the method as having a meaningful interpretation. Usage to the contrary is incorrect coding and may result in a run time exception either immediately or at some later time. IllegalArgumentException and NullPointerException are examples of typical and acceptable run time exceptions for such cases.
-
-
Method Summary
Methods Modifier and Type Method and Description static AttributeSet
synchronizedView(AttributeSet attributeSet)
Creates a synchronized view of the given attribute set.static DocAttributeSet
synchronizedView(DocAttributeSet attributeSet)
Creates a synchronized view of the given doc attribute set.static PrintJobAttributeSet
synchronizedView(PrintJobAttributeSet attributeSet)
Creates a synchronized view of the given print job attribute set.static PrintRequestAttributeSet
synchronizedView(PrintRequestAttributeSet attributeSet)
Creates a synchronized view of the given print request attribute set.static PrintServiceAttributeSet
synchronizedView(PrintServiceAttributeSet attributeSet)
Creates a synchronized view of the given print service attribute set.static AttributeSet
unmodifiableView(AttributeSet attributeSet)
Creates an unmodifiable view of the given attribute set.static DocAttributeSet
unmodifiableView(DocAttributeSet attributeSet)
Creates an unmodifiable view of the given doc attribute set.static PrintJobAttributeSet
unmodifiableView(PrintJobAttributeSet attributeSet)
Creates an unmodifiable view of the given print job attribute set.static PrintRequestAttributeSet
unmodifiableView(PrintRequestAttributeSet attributeSet)
Creates an unmodifiable view of the given print request attribute set.static PrintServiceAttributeSet
unmodifiableView(PrintServiceAttributeSet attributeSet)
Creates an unmodifiable view of the given print service attribute set.static Class<?>
verifyAttributeCategory(Object object, Class<?> interfaceName)
static Attribute
verifyAttributeValue(Object object, Class<?> interfaceName)
Verify that the given object is an instance of the given interface, which is assumed to be interfaceAttribute
or a subinterface thereof.static void
verifyCategoryForValue(Class<?> category, Attribute attribute)
Verify that the given attribute category object is equal to the category of the given attribute value object.
-
-
-
Method Detail
-
unmodifiableView
public static AttributeSet unmodifiableView(AttributeSet attributeSet)
Creates an unmodifiable view of the given attribute set.- Parameters:
attributeSet
- Underlying attribute set.- Returns:
- Unmodifiable view of
attributeSet
. - Throws:
NullPointerException
- Thrown ifattributeSet
is null. Null is never a
-
unmodifiableView
public static DocAttributeSet unmodifiableView(DocAttributeSet attributeSet)
Creates an unmodifiable view of the given doc attribute set.- Parameters:
attributeSet
- Underlying doc attribute set.- Returns:
- Unmodifiable view of
attributeSet
. - Throws:
NullPointerException
- Thrown ifattributeSet
is null.
-
unmodifiableView
public static PrintRequestAttributeSet unmodifiableView(PrintRequestAttributeSet attributeSet)
Creates an unmodifiable view of the given print request attribute set.- Parameters:
attributeSet
- Underlying print request attribute set.- Returns:
- Unmodifiable view of
attributeSet
. - Throws:
NullPointerException
- Thrown ifattributeSet
is null.
-
unmodifiableView
public static PrintJobAttributeSet unmodifiableView(PrintJobAttributeSet attributeSet)
Creates an unmodifiable view of the given print job attribute set.- Parameters:
attributeSet
- Underlying print job attribute set.- Returns:
- Unmodifiable view of
attributeSet
. - Throws:
NullPointerException
- Thrown ifattributeSet
is null.
-
unmodifiableView
public static PrintServiceAttributeSet unmodifiableView(PrintServiceAttributeSet attributeSet)
Creates an unmodifiable view of the given print service attribute set.- Parameters:
attributeSet
- Underlying print service attribute set.- Returns:
- Unmodifiable view of
attributeSet
. - Throws:
NullPointerException
- Thrown ifattributeSet
is null.
-
synchronizedView
public static AttributeSet synchronizedView(AttributeSet attributeSet)
Creates a synchronized view of the given attribute set.- Parameters:
attributeSet
- Underlying attribute set.- Returns:
- Synchronized view of
attributeSet
. - Throws:
NullPointerException
- Thrown ifattributeSet
is null.
-
synchronizedView
public static DocAttributeSet synchronizedView(DocAttributeSet attributeSet)
Creates a synchronized view of the given doc attribute set.- Parameters:
attributeSet
- Underlying doc attribute set.- Returns:
- Synchronized view of
attributeSet
. - Throws:
NullPointerException
- Thrown ifattributeSet
is null.
-
synchronizedView
public static PrintRequestAttributeSet synchronizedView(PrintRequestAttributeSet attributeSet)
Creates a synchronized view of the given print request attribute set.- Parameters:
attributeSet
- Underlying print request attribute set.- Returns:
- Synchronized view of
attributeSet
. - Throws:
NullPointerException
- Thrown ifattributeSet
is null.
-
synchronizedView
public static PrintJobAttributeSet synchronizedView(PrintJobAttributeSet attributeSet)
Creates a synchronized view of the given print job attribute set.- Parameters:
attributeSet
- Underlying print job attribute set.- Returns:
- Synchronized view of
attributeSet
. - Throws:
NullPointerException
- Thrown ifattributeSet
is null.
-
synchronizedView
public static PrintServiceAttributeSet synchronizedView(PrintServiceAttributeSet attributeSet)
Creates a synchronized view of the given print service attribute set.- Parameters:
attributeSet
- Underlying print service attribute set.- Returns:
- Synchronized view of
attributeSet
.
-
verifyAttributeCategory
public static Class<?> verifyAttributeCategory(Object object, Class<?> interfaceName)
Verify that the given object is aClass
that implements the given interface, which is assumed to be interfaceAttribute
or a subinterface thereof.- Parameters:
object
- Object to test.interfaceName
- Interface the object must implement.- Returns:
- If
object
is aClass
that implementsinterfaceName
,object
is returned downcast to typeClass
; otherwise an exception is thrown. - Throws:
NullPointerException
- (unchecked exception) Thrown ifobject
is null.ClassCastException
- (unchecked exception) Thrown ifobject
is not aClass
that implementsinterfaceName
.
-
verifyAttributeValue
public static Attribute verifyAttributeValue(Object object, Class<?> interfaceName)
Verify that the given object is an instance of the given interface, which is assumed to be interfaceAttribute
or a subinterface thereof.- Parameters:
object
- Object to test.interfaceName
- Interface of which the object must be an instance.- Returns:
- If
object
is an instance ofinterfaceName
,object
is returned downcast to typeAttribute
; otherwise an exception is thrown. - Throws:
NullPointerException
- (unchecked exception) Thrown ifobject
is null.ClassCastException
- (unchecked exception) Thrown ifobject
is not an instance ofinterfaceName
.
-
verifyCategoryForValue
public static void verifyCategoryForValue(Class<?> category, Attribute attribute)
Verify that the given attribute category object is equal to the category of the given attribute value object. If so, this method returns doing nothing. If not, this method throws an exception.- Parameters:
category
- Attribute category to test.attribute
- Attribute value to test.- Throws:
NullPointerException
- (unchecked exception) Thrown if thecategory
is null or if theattribute
is null.IllegalArgumentException
- (unchecked exception) Thrown if thecategory
is not equal to the category of theattribute
.
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
21/11/2024 21:29:52 Cette version de la page est en cache (à la date du 21/11/2024 21:29:52) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 30/10/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/print/attribute/attributesetutilities.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.