Skip navigation links
A B D E G H I J O S T V W 

A

AbstractIpp - Class in j4cups.protocol
The class AbstractIpp is the common super class of IppRequest and IppResponse which encapsulates the common code of both classes.
AbstractIpp(byte[]) - Constructor for class j4cups.protocol.AbstractIpp
Instantiates a new IPP request or responsel from the given bytes.
AbstractIpp(ByteBuffer) - Constructor for class j4cups.protocol.AbstractIpp
Instantiates a new IPP request or response from the given bytes.
AbstractIpp(AbstractIpp.Version, short, int, List<AttributeGroup>) - Constructor for class j4cups.protocol.AbstractIpp
Instantiates a new IPP request or response with no data.
AbstractIpp(AbstractIpp.Version, short, int, List<AttributeGroup>, byte[]) - Constructor for class j4cups.protocol.AbstractIpp
Instantiates a new IPP request or response.
AbstractIpp.Version - Class in j4cups.protocol
Container for the version information.
addAttribute(Attribute) - Method in class j4cups.protocol.attr.AttributeGroup
Adds an attribute to the given attributes.
AdditionalValue(ByteBuffer) - Constructor for class j4cups.protocol.attr.Attribute.AdditionalValue
 
Attribute - Class in j4cups.protocol.attr
An "attribute" field is encoded as attribute-with-one-value and (optional) several addtional-values.
Attribute(ByteBuffer) - Constructor for class j4cups.protocol.attr.Attribute
Instantiates a new (single valued or multi-valued) attribute from the given bytes.
Attribute.AdditionalValue - Class in j4cups.protocol.attr
An "additional-value" has four entries.
Attribute.AttributeWithOneValue - Class in j4cups.protocol.attr
An "attribute-with-one-value" field is encoded with five subfields.
AttributeGroup - Class in j4cups.protocol.attr
Each "attribute-group" field represents a single group of attributes, such as an Operation Attributes group or a Job Attributes group (see the Model document).
AttributeGroup(DelimiterTags) - Constructor for class j4cups.protocol.attr.AttributeGroup
Instantiates a new empty attribute group from the given bytes.
AttributeGroup(ByteBuffer) - Constructor for class j4cups.protocol.attr.AttributeGroup
Instantiates a new attribute group from the given bytes.
AttributeWithOneValue(ByteBuffer) - Constructor for class j4cups.protocol.attr.Attribute.AttributeWithOneValue
Instantiates a new attribute-with-one-value from the given bytes.
AttributeWithOneValue(ValueTags, String, byte[]) - Constructor for class j4cups.protocol.attr.Attribute.AttributeWithOneValue
Instantiates a new attribute-with-one-value.

B

Binary - Interface in j4cups.protocol
The Interface Binary describes objects which supports a binary presentation of the object.

D

DEFAULT_VERSION - Static variable in class j4cups.protocol.AbstractIpp
The actual supported version is 2.
DelimiterTags - Enum in j4cups.protocol.tags
The DelimiterTags delimit major sections of the protocol, namely attributes and data.

E

equals(Object) - Method in class j4cups.protocol.AbstractIpp.Version
 

G

getAttribute(String) - Method in class j4cups.protocol.AbstractIpp
Gets the attribute with the given name.
getAttributeGroups() - Method in class j4cups.protocol.AbstractIpp
The fourth field is the "attribute-group" field, and it occurs 0 or more times.
getAttributeGroups(DelimiterTags) - Method in class j4cups.protocol.AbstractIpp
Returns all attributes of the given delimiter-tag.
getAttributes() - Method in class j4cups.protocol.AbstractIpp
Gets a collected list of all attributes of the attribute-groups.
getAttributes() - Method in class j4cups.protocol.attr.AttributeGroup
An "attribute-group" field contains zero or more "attribute" fields.
getBeginTag() - Method in class j4cups.protocol.attr.AttributeGroup
The "begin-attribute-group-tag" field marks the beginning of an "attribute-group" field and its value identifies the type of attribute group, e.g.
getCode() - Method in enum j4cups.protocol.IppOperations
Gets the operation id or op-code of the operation.
getCode() - Method in enum j4cups.protocol.StatusCode
Gets the value of the statuscode.
getData() - Method in class j4cups.protocol.AbstractIpp
Returns the data part of the request.
getName() - Method in class j4cups.protocol.attr.Attribute.AttributeWithOneValue
The "name" field contains the textual name of the attribute.
getName() - Method in class j4cups.protocol.attr.Attribute
The "name" field contains the textual name of the attribute.
getOpCode() - Method in class j4cups.protocol.AbstractIpp
Returns the 2nd part (byte 2-3) with the operation-id or status-code.
getOpCodeAsString() - Method in class j4cups.protocol.AbstractIpp
Returns the 2nd part (byte 2-3) with the operation-id or status-code as string.
getOpCodeAsString() - Method in class j4cups.protocol.IppRequest
Returns the 2nd part (byte 2-3) with the operation-id as string.
getOpCodeAsString() - Method in class j4cups.protocol.IppResponse
Returns the 2nd part (byte 2-3) with the status-code as string.
getOperation() - Method in class j4cups.protocol.IppRequest
Returns the 2nd part (byte 2-3) with the operation-id.
getRequestId() - Method in class j4cups.protocol.AbstractIpp
Retunns the 3rd part (byte 4-7) of the request which contains the request-id.
getState() - Method in enum j4cups.protocol.enums.JobState
Gets the represenation of the state as 32 bit integer.
getStatusCode() - Method in class j4cups.protocol.IppResponse
Returns the 2nd part (byte 2-3) with the status-code.
getStringValue() - Method in class j4cups.protocol.attr.Attribute.AttributeWithOneValue
The "value" field contains the value of the attribute.
getStringValue() - Method in class j4cups.protocol.attr.Attribute
The "value" field contains the value of a charset attribute.
getUriValue() - Method in class j4cups.protocol.attr.Attribute
The "value" field contains the value of a URI attribute.
getValue() - Method in class j4cups.protocol.attr.Attribute.AttributeWithOneValue
The "value" field contains the value of the attribute.
getValue() - Method in class j4cups.protocol.attr.Attribute
The "value" field contains the value of the attribute.
getValue() - Method in enum j4cups.protocol.tags.DelimiterTags
Gets the byte value of the tag.
getValue() - Method in enum j4cups.protocol.tags.ValueTags
Gets the byte value of the tag.
getValueTag() - Method in class j4cups.protocol.attr.Attribute.AttributeWithOneValue
The "value-tag" field specifies the attribute syntax, e.g. 0x44 for the attribute syntax 'keyword'.
getValueTag() - Method in class j4cups.protocol.attr.Attribute
The "value-tag" field specifies the attribute syntax, e.g. 0x44 for the attribute syntax 'keyword'.
getVersion() - Method in class j4cups.protocol.AbstractIpp
Gets the first part (byte 0-1) with the supported IPP version.

H

hasData() - Method in class j4cups.protocol.AbstractIpp
The data part of the request can be empty.
hashCode() - Method in class j4cups.protocol.AbstractIpp.Version
 

I

IppOperations - Enum in j4cups.protocol
The enum IppOperations represents the IPP operations which are described in RFC-8011.
IppRequest - Class in j4cups.protocol
The IppRequest represents an IPP request as is defined in RFC-2910.
IppRequest(byte[]) - Constructor for class j4cups.protocol.IppRequest
Instantiates a new IPP request from the given bytes.
IppRequest(ByteBuffer) - Constructor for class j4cups.protocol.IppRequest
Instantiates a new IPP request from the given bytes.
IppResponse - Class in j4cups.protocol
The IppResponse represents an IPP response as is defined in RFC-2910.
IppResponse(IppRequest) - Constructor for class j4cups.protocol.IppResponse
The IppResponse is the response to a IppRequest.
isCharacterStringValue() - Method in enum j4cups.protocol.tags.ValueTags
One kind of value tags are character-string values, which are the values from 0x40 - 0x4f.
isMultiValue() - Method in class j4cups.protocol.attr.Attribute
When the attribte value is multi-valued this method returns true.
isValid(int) - Static method in enum j4cups.protocol.tags.DelimiterTags
The range for a delimiter-tag is between 0 and 0x0f.
isValid(int) - Static method in enum j4cups.protocol.tags.ValueTags
The range for a value-tag is between 0x10 and 0x0f.

J

j4cups.protocol - package j4cups.protocol
This package supports the data types which are described in RFC-2910 and RFC-8011.
j4cups.protocol.attr - package j4cups.protocol.attr
In this package are the building blocks for attribute and attribute-groups.
j4cups.protocol.enums - package j4cups.protocol.enums
This package is the container for enum values.
j4cups.protocol.tags - package j4cups.protocol.tags
This package represents the which are described in section 3.5 of RFC-2910.
JobState - Enum in j4cups.protocol.enums
The JobState describes the IPP Job Life Cycle.

O

of(String, int) - Static method in class j4cups.protocol.attr.Attribute
Creates a singe-value attribute for integer values.
of(String, URI) - Static method in class j4cups.protocol.attr.Attribute
Creates a singe-value attribute for URI values.
of(String, Charset) - Static method in class j4cups.protocol.attr.Attribute
Creates a singe-value attribute for charset values.
of(String, Locale) - Static method in class j4cups.protocol.attr.Attribute
Creates a singe-value attribute for the given language.
of(ValueTags, String, int) - Static method in class j4cups.protocol.attr.Attribute
Creates a singe-value attribute for integer based values.
of(ValueTags, String, String) - Static method in class j4cups.protocol.attr.Attribute
Creates a singe-value attribute for character-string values.
of(ValueTags, String, byte[]) - Static method in class j4cups.protocol.attr.Attribute
Creates a singe-value attribute.
of(int) - Static method in enum j4cups.protocol.enums.JobState
Allows you to map a int value to the corresponding state.
of(int) - Static method in enum j4cups.protocol.IppOperations
Allows you to map an id (or op-code) to the corresponding operation.
of(int) - Static method in enum j4cups.protocol.StatusCode
Allows you to map a value to the corresponding statuscode
of(int) - Static method in enum j4cups.protocol.tags.DelimiterTags
Allows you to map a byte value to the corresponding tag.
of(int) - Static method in enum j4cups.protocol.tags.ValueTags
Allows you to map a byte value to the corresponding tag.

S

StatusCode - Enum in j4cups.protocol
The status-code values range from 0x0000 to 0x7fff.

T

toByteArray() - Method in class j4cups.protocol.AbstractIpp
Converts the IppResponse to a byte array as described in RFC-2910.
toByteArray() - Method in class j4cups.protocol.AbstractIpp.Version
 
toByteArray() - Method in class j4cups.protocol.attr.Attribute.AttributeWithOneValue
Converts an attribute-with-one-value to a byte array.
toByteArray() - Method in interface j4cups.protocol.Binary
Converts the object to its binary presentation
toLongString() - Method in class j4cups.protocol.AbstractIpp
Puts all attribute information into the resulting string.
toLongString() - Method in class j4cups.protocol.attr.Attribute
This method shows a short representation of an attribute.
toLongString() - Method in class j4cups.protocol.attr.AttributeGroup
All attribute values are put into the resulting string.
toString() - Method in class j4cups.protocol.AbstractIpp
With this toString() implementation we want to provide the most important values which are useful for logging and debugging.
toString() - Method in class j4cups.protocol.AbstractIpp.Version
Prints the two bytes as string.
toString() - Method in class j4cups.protocol.attr.Attribute
This method shows a short representation of an attribute.
toString() - Method in class j4cups.protocol.attr.AttributeGroup
With this toString() implementation we want to provide the most important values which are useful for logging and debugging.
toString() - Method in enum j4cups.protocol.IppOperations
This implementation generates the same representation as described in section RFC-8011 (section 5.4.15).
toString() - Method in enum j4cups.protocol.tags.DelimiterTags
This implementation generates the same representation as in the corresponding RFCs.

V

valueOf(String) - Static method in enum j4cups.protocol.enums.JobState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum j4cups.protocol.IppOperations
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum j4cups.protocol.StatusCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum j4cups.protocol.tags.DelimiterTags
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum j4cups.protocol.tags.ValueTags
Returns the enum constant of this type with the specified name.
values() - Static method in enum j4cups.protocol.enums.JobState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum j4cups.protocol.IppOperations
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum j4cups.protocol.StatusCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum j4cups.protocol.tags.DelimiterTags
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum j4cups.protocol.tags.ValueTags
Returns an array containing the constants of this enum type, in the order they are declared.
ValueTags - Enum in j4cups.protocol.tags
The ValueTags specify the type of each attribute value.
Version(byte, byte) - Constructor for class j4cups.protocol.AbstractIpp.Version
Expects the first two bytes of an IPP request or response.

W

writeBinaryTo(OutputStream) - Method in class j4cups.protocol.attr.Attribute
Converts the attribute to a byte array as described in RFC-2910 and writes it to the given output-stream.
writeBinaryTo(OutputStream) - Method in class j4cups.protocol.attr.AttributeGroup
Converts the attribute-group to a byte array as described in RFC-2910 and writes it to the given output-stream.
writeBinaryTo(OutputStream) - Method in interface j4cups.protocol.Binary
Writes the binary presentation to an output stream.
A B D E G H I J O S T V W 
Skip navigation links

Copyright © 2018. All rights reserved.