Class NumberUpSupported

java.lang.Object
javax.print.attribute.SetOfIntegerSyntax
javax.print.attribute.standard.NumberUpSupported
All Implemented Interfaces:
Serializable, Cloneable, Attribute, SupportedValuesAttribute
public final class NumberUpSupported extends SetOfIntegerSyntax implements SupportedValuesAttribute
Class NumberUpSupported is a printing attribute class, a set of integers, that gives the supported values for a NumberUp attribute.

IPP Compatibility: The NumberUpSupported attribute's canonical array form gives the lower and upper bound for each range of number-up to be included in an IPP "number-up-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
    NumberUpSupported(int member)
    Construct a new number up supported attribute containing a single integer.
    NumberUpSupported(int[][] members)
    Construct a new number up supported attribute with the given members.
    NumberUpSupported(int lowerBound, int upperBound)
    Construct a new number up supported attribute containing a single range of integers.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object object)
    Returns whether this number up 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()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Constructor Details

    • NumberUpSupported

      public NumberUpSupported(int[][] members)
      Construct a new number up supported attribute with the given members. The supported values for NumberUp are specified in "array form;" see class SetOfIntegerSyntax for an explanation of array form.
      Parameters:
      members - set members in array form
      Throws:
      NullPointerException - if members is null or any element of members is null
      IllegalArgumentException - if any element of members is not a length-one or length-two array. Also if members is a zero-length array or if any member of the set is less than 1.

    • NumberUpSupported

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

    • NumberUpSupported

      public NumberUpSupported(int lowerBound, int upperBound)
      Construct a new number up supported attribute containing a single range of integers. That is, only those values of NumberUp 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 number up 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 NumberUpSupported.
      3. This number up 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 number up 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 NumberUpSupported, the category is class NumberUpSupported 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 NumberUpSupported, the category name is "number-up-supported".

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