Class CopiesSupported

java.lang.Object
javax.print.attribute.SetOfIntegerSyntax
javax.print.attribute.standard.CopiesSupported
All Implemented Interfaces:
Serializable, Cloneable, Attribute, SupportedValuesAttribute
public final class CopiesSupported extends SetOfIntegerSyntax implements SupportedValuesAttribute
Class CopiesSupported is a printing attribute class, a set of integers, that gives the supported values for a Copies attribute. It is restricted to a single contiguous range of integers; multiple non-overlapping ranges are not allowed.

IPP Compatibility: The CopiesSupported attribute's canonical array form gives the lower and upper bound for the range of copies to be included in an IPP "copies-supported" attribute. See class SetOfIntegerSyntax for an explanation of canonical array form. The category name returned by getName() gives the IPP attribute name.

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    CopiesSupported(int member)
    Construct a new copies supported attribute containing a single integer.
    CopiesSupported(int lowerBound, int upperBound)
    Construct a new copies supported attribute containing a single range of integers.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object object)
    Returns whether this copies supported attribute is equivalent to the passed in object.
    final Class<? extends Attribute>
    getCategory()
    Get the printing attribute class which is to be used as the "category" for this printing attribute value.
    final String
    getName()
    Get the name of the category of which this attribute value is an instance.

    Methods declared in class SetOfIntegerSyntax

    contains, contains, getMembers, hashCode, next, toString
    Modifier and Type
    Method
    Description
    boolean
    contains(int x)
    Determine if this set-of-integer attribute contains the given value.
    boolean
    contains(IntegerSyntax attribute)
    Determine if this set-of-integer attribute contains the given integer attribute's value.
    int[][]
    getMembers()
    Obtain this set-of-integer attribute's members in canonical array form.
    int
    hashCode()
    Returns a hash code value for this set-of-integer attribute.
    int
    next(int x)
    Determine the smallest integer in this set-of-integer attribute that is greater than the given value.
    String
    toString()
    Returns a string value corresponding to this set-of-integer attribute.

    Methods declared in class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Creates and returns a copy of this object.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Finalization is deprecated and subject to removal in a future release.
    final Class<?>
    getClass()
    Returns the runtime class of this Object.
    final void
    notify()
    Wakes up a single thread that is waiting on this object's monitor.
    final void
    notifyAll()
    Wakes up all threads that are waiting on this object's monitor.
    final void
    wait()
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
    final void
    wait(long timeoutMillis)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
    final void
    wait(long timeoutMillis, int nanos)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

  • Constructor Details

    • CopiesSupported

      public CopiesSupported(int member)
      Construct a new copies supported attribute containing a single integer. That is, only the one value of Copies is supported.
      Parameters:
      member - set member
      Throws:
      IllegalArgumentException - if member < 1

    • CopiesSupported

      public CopiesSupported(int lowerBound, int upperBound)
      Construct a new copies supported attribute containing a single range of integers. That is, only those values of Copies in the one range are supported.
      Parameters:
      lowerBound - Lower bound of the range
      upperBound - Upper bound of the range
      Throws:
      IllegalArgumentException - if a null range is specified or if a non-null range is specified with lowerBound less than 1

  • Method Details

    • equals

      public boolean equals(Object object)
      Returns whether this copies supported attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true:
      1. object is not null.
      2. object is an instance of class CopiesSupported.
      3. This copies supported attribute's members and object's members are the same.
      Overrides:
      equals in class SetOfIntegerSyntax
      Parameters:
      object - Object to compare to
      Returns:
      true if object is equivalent to this copies supported attribute, false otherwise
      See Also:

    • getCategory

      public final Class<? extends Attribute> getCategory()
      Get the printing attribute class which is to be used as the "category" for this printing attribute value.

      For class CopiesSupported, the category is class CopiesSupported itself.

      Specified by:
      getCategory in interface Attribute
      Returns:
      printing attribute class (category), an instance of class java.lang.Class

    • getName

      public final String getName()
      Get the name of the category of which this attribute value is an instance.

      For class CopiesSupported, the category name is "copies-supported".

      Specified by:
      getName in interface Attribute
      Returns:
      attribute category name