javax.print.attribute.standard

Class JobState

Implemented Interfaces:
Attribute, Cloneable, PrintJobAttribute, Serializable

public class JobState
extends EnumSyntax
implements PrintJobAttribute

The JobState printing attribute reports the current state of a job.

The JobStateReasons attribute provides further detailed information about the given job state. Detailed information about the job state and job state reasons can be found in the RFC 2911.

IPP Compatibility: JobState is an IPP 1.1 attribute.

See Also:
Serialized Form

Field Summary

static JobState
ABORTED
The job has been aborted by the system.
static JobState
CANCELED
The job has been canceled by the client.
static JobState
COMPLETED
The job has completed successfully.
static JobState
PENDING
The job is pending processing.
static JobState
PENDING_HELD
The job is currently not a candidate for printing because of reasons reported by the job-state-reasons attribute.
static JobState
PROCESSING
The job is currently processed.
static JobState
PROCESSING_STOPPED
The job's processing has stopped.
static JobState
UNKNOWN
The job state is currently unknown.

Constructor Summary

JobState(int value)
Constructs a JobState object.

Method Summary

Class<
? extends Attribute> getCategory()
Returns category of this class.
protected EnumSyntax[]
getEnumValueTable()
Returns a table with the enumeration values for this object.
String
getName()
Returns the name of this attribute.
protected String[]
getStringTable()
Returns a table with the enumeration values represented as strings for this object.

Methods inherited from class javax.print.attribute.EnumSyntax

clone, getEnumValueTable, getOffset, getStringTable, getValue, hashCode, readResolve, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ABORTED

public static final JobState ABORTED
The job has been aborted by the system.

CANCELED

public static final JobState CANCELED
The job has been canceled by the client.

COMPLETED

public static final JobState COMPLETED
The job has completed successfully.

PENDING

public static final JobState PENDING
The job is pending processing.

PENDING_HELD

public static final JobState PENDING_HELD
The job is currently not a candidate for printing because of reasons reported by the job-state-reasons attribute. If the reasons are no longer present it will return to the pending state.

PROCESSING

public static final JobState PROCESSING
The job is currently processed.

PROCESSING_STOPPED

public static final JobState PROCESSING_STOPPED
The job's processing has stopped. The job-state-reasons attribute may indicate the reason(s). The job will return to the processing state if the reasons are no longer present.

UNKNOWN

public static final JobState UNKNOWN
The job state is currently unknown.

Constructor Details

JobState

protected JobState(int value)
Constructs a JobState object.
Parameters:
value - the enum value.

Method Details

? extends Attribute> getCategory

public Class< ? extends Attribute> getCategory()
Returns category of this class.
Specified by:
? extends Attribute> getCategory in interface Attribute
Returns:
The class JobState itself.

getEnumValueTable

protected EnumSyntax[] getEnumValueTable()
Returns a table with the enumeration values for this object.
Overrides:
getEnumValueTable in interface EnumSyntax
Returns:
The enumeration values.

getName

public final String getName()
Returns the name of this attribute.
Specified by:
getName in interface Attribute
Returns:
The name "job-state".

getStringTable

protected String[] getStringTable()
Returns a table with the enumeration values represented as strings for this object.
Overrides:
getStringTable in interface EnumSyntax
Returns:
The enumeration values as strings.

JobState.java -- Copyright (C) 2004, 2005, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.