javax.print.attribute: public final class: AttributeSetUtilities

javax.print.attribute
public final class: AttributeSetUtilities [javadoc | source]

java.lang.Object
   javax.print.attribute.AttributeSetUtilities

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.

author: Alan - Kaminsky

Method from javax.print.attribute.AttributeSetUtilities Summary:
synchronizedView, synchronizedView, synchronizedView, synchronizedView, synchronizedView, unmodifiableView, unmodifiableView, unmodifiableView, unmodifiableView, unmodifiableView, verifyAttributeCategory, verifyAttributeValue, verifyCategoryForValue

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

Method from javax.print.attribute.AttributeSetUtilities Detail:
public static AttributeSet synchronizedView(AttributeSet attributeSet) { if (attributeSet == null) { throw new NullPointerException(); } return new SynchronizedAttributeSet(attributeSet); } Creates a synchronized view of the given attribute set.
public static DocAttributeSet synchronizedView(DocAttributeSet attributeSet) { if (attributeSet == null) { throw new NullPointerException(); } return new SynchronizedDocAttributeSet(attributeSet); } Creates a synchronized view of the given doc attribute set.
public static PrintRequestAttributeSet synchronizedView(PrintRequestAttributeSet attributeSet) { if (attributeSet == null) { throw new NullPointerException(); } return new SynchronizedPrintRequestAttributeSet(attributeSet); } Creates a synchronized view of the given print request attribute set.
public static PrintJobAttributeSet synchronizedView(PrintJobAttributeSet attributeSet) { if (attributeSet == null) { throw new NullPointerException(); } return new SynchronizedPrintJobAttributeSet(attributeSet); } Creates a synchronized view of the given print job attribute set.
public static PrintServiceAttributeSet synchronizedView(PrintServiceAttributeSet attributeSet) { if (attributeSet == null) { throw new NullPointerException(); } return new SynchronizedPrintServiceAttributeSet(attributeSet); } Creates a synchronized view of the given print service attribute set.
public static AttributeSet unmodifiableView(AttributeSet attributeSet) { if (attributeSet == null) { throw new NullPointerException(); } return new UnmodifiableAttributeSet(attributeSet); } Creates an unmodifiable view of the given attribute set.
public static DocAttributeSet unmodifiableView(DocAttributeSet attributeSet) { if (attributeSet == null) { throw new NullPointerException(); } return new UnmodifiableDocAttributeSet(attributeSet); } Creates an unmodifiable view of the given doc attribute set.
public static PrintRequestAttributeSet unmodifiableView(PrintRequestAttributeSet attributeSet) { if (attributeSet == null) { throw new NullPointerException(); } return new UnmodifiablePrintRequestAttributeSet(attributeSet); } Creates an unmodifiable view of the given print request attribute set.
public static PrintJobAttributeSet unmodifiableView(PrintJobAttributeSet attributeSet) { if (attributeSet == null) { throw new NullPointerException(); } return new UnmodifiablePrintJobAttributeSet(attributeSet); } Creates an unmodifiable view of the given print job attribute set.
public static PrintServiceAttributeSet unmodifiableView(PrintServiceAttributeSet attributeSet) { if (attributeSet == null) { throw new NullPointerException(); } return new UnmodifiablePrintServiceAttributeSet (attributeSet); } Creates an unmodifiable view of the given print service attribute set.
public static Class<?> verifyAttributeCategory(Object object, Class<?> interfaceName) { Class result = (Class) object; if (interfaceName.isAssignableFrom (result)) { return result; } else { throw new ClassCastException(); } } Verify that the given object is a Class that implements the given interface, which is assumed to be interface Attribute or a subinterface thereof.
public static Attribute verifyAttributeValue(Object object, Class<?> interfaceName) { if (object == null) { throw new NullPointerException(); } else if (interfaceName.isInstance (object)) { return (Attribute) object; } else { throw new ClassCastException(); } } Verify that the given object is an instance of the given interface, which is assumed to be interface Attribute or a subinterface thereof.
public static void verifyCategoryForValue(Class<?> category, Attribute attribute) { if (!category.equals (attribute.getCategory())) { throw new IllegalArgumentException(); } } 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.

Method from javax.print.attribute.AttributeSetUtilities Detail:

 public static AttributeSet synchronizedView(AttributeSet attributeSet) {
        if (attributeSet == null) {
            throw new NullPointerException();
        }
        return new SynchronizedAttributeSet(attributeSet);
}

Creates a synchronized view of the given attribute set.

 public static DocAttributeSet synchronizedView(DocAttributeSet attributeSet) {
        if (attributeSet == null) {
            throw new NullPointerException();
        }
        return new SynchronizedDocAttributeSet(attributeSet);
}

Creates a synchronized view of the given doc attribute set.

 public static PrintRequestAttributeSet synchronizedView(PrintRequestAttributeSet attributeSet) {
        if (attributeSet == null) {
            throw new NullPointerException();
        }
        return new SynchronizedPrintRequestAttributeSet(attributeSet);
}

Creates a synchronized view of the given print request attribute set.

 public static PrintJobAttributeSet synchronizedView(PrintJobAttributeSet attributeSet) {
        if (attributeSet == null) {
            throw new NullPointerException();
        }
        return new SynchronizedPrintJobAttributeSet(attributeSet);
}

Creates a synchronized view of the given print job attribute set.

 public static PrintServiceAttributeSet synchronizedView(PrintServiceAttributeSet attributeSet) {
        if (attributeSet == null) {
            throw new NullPointerException();
        }
        return new SynchronizedPrintServiceAttributeSet(attributeSet);
}

Creates a synchronized view of the given print service attribute set.

 public static AttributeSet unmodifiableView(AttributeSet attributeSet) {
        if (attributeSet == null) {
            throw new NullPointerException();
        }
        return new UnmodifiableAttributeSet(attributeSet);
}

Creates an unmodifiable view of the given attribute set.

 public static DocAttributeSet unmodifiableView(DocAttributeSet attributeSet) {
        if (attributeSet == null) {
            throw new NullPointerException();
        }
        return new UnmodifiableDocAttributeSet(attributeSet);
}

Creates an unmodifiable view of the given doc attribute set.

 public static PrintRequestAttributeSet unmodifiableView(PrintRequestAttributeSet attributeSet) {
        if (attributeSet == null) {
            throw new NullPointerException();
        }
        return new UnmodifiablePrintRequestAttributeSet(attributeSet);
}

Creates an unmodifiable view of the given print request attribute set.

 public static PrintJobAttributeSet unmodifiableView(PrintJobAttributeSet attributeSet) {
        if (attributeSet == null) {
            throw new NullPointerException();
        }
        return new UnmodifiablePrintJobAttributeSet(attributeSet);
}

Creates an unmodifiable view of the given print job attribute set.

 public static PrintServiceAttributeSet unmodifiableView(PrintServiceAttributeSet attributeSet) {
        if (attributeSet == null) {
            throw new NullPointerException();
        }
        return new UnmodifiablePrintServiceAttributeSet (attributeSet);
}

Creates an unmodifiable view of the given print service attribute set.

 public static Class<?> verifyAttributeCategory(Object object,
    Class<?> interfaceName) {
        Class result = (Class) object;
        if (interfaceName.isAssignableFrom (result)) {
            return result;
        }
        else {
            throw new ClassCastException();
        }
}

Class

Attribute

 public static Attribute verifyAttributeValue(Object object,
    Class<?> interfaceName) {
        if (object == null) {
            throw new NullPointerException();
        }
        else if (interfaceName.isInstance (object)) {
            return (Attribute) object;
        } else {
            throw new ClassCastException();
        }
}

Attribute

 public static  void verifyCategoryForValue(Class<?> category,
    Attribute attribute) {
        if (!category.equals (attribute.getCategory())) {
            throw new IllegalArgumentException();
        }
}

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.