j4cups.protocol.attr

Class AttributeGroup

java.lang.Object

j4cups.protocol.attr.AttributeGroup

All Implemented Interfaces:

Binary

public class AttributeGroup
extends java.lang.Object
implements Binary

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). The IPP model document specifies the required attribute groups and their order for each operation request and response.

Each "attribute-group" field is encoded as follows:

 -----------------------------------------------
 |           begin-attribute-group-tag         |  1 byte
 ----------------------------------------------------------
 |                   attribute                 |  p bytes |- 0 or more
 ----------------------------------------------------------
 

Since:

0.0.2 (10.02.2018)

Author:

oboehm

Constructor Summary

Constructors

Constructor and Description
AttributeGroup(AttributeGroup other) This is the copy construtor.
AttributeGroup(java.nio.ByteBuffer bytes) Instantiates a new attribute group from the given bytes.
AttributeGroup(DelimiterTags type) Instantiates a new empty attribute group from the given bytes.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(Attribute attr) Adds an attribute to the given attributes.
Attribute	getAttribute(java.lang.String name) Looks for the attribute with the given name and returns it.
java.util.List<Attribute>	getAttributes() An "attribute-group" field contains zero or more "attribute" fields.
DelimiterTags	getBeginTag() 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.
boolean	hasAttribute(java.lang.String name) Checks if the given attribute is available.
java.lang.String	toLongString() All attribute values are put into the resulting string.
java.lang.String	toString() With this toString() implementation we want to provide the most important values which are useful for logging and debugging.
void	writeBinaryTo(java.io.OutputStream ostream) Converts the attribute-group to a byte array as described in RFC-2910 and writes it to the given output-stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface j4cups.protocol.Binary

toByteArray

Constructor Detail

AttributeGroup

public AttributeGroup(AttributeGroup other)

This is the copy construtor.

Parameters:

other - AttributeGroup which is copied

AttributeGroup

public AttributeGroup(DelimiterTags type)

Instantiates a new empty attribute group from the given bytes.

Parameters:

type - e.g. DelimiterTags.OPERATION_ATTRIBUTES_TAG

AttributeGroup

public AttributeGroup(java.nio.ByteBuffer bytes)

Instantiates a new attribute group from the given bytes. The given ByteBuffer must be positioned at the beginning of the attribute-group.

Parameters:

bytes - ByteBuffer positioned at the beginning

Method Detail

getBeginTag

public DelimiterTags getBeginTag()

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. Operations Attributes group versus a Job Attributes group.

Returns:

e.g. DelimiterTags.OPERATION_ATTRIBUTES_TAG

getAttributes

public java.util.List<Attribute> getAttributes()

An "attribute-group" field contains zero or more "attribute" fields.

Returns:

list of attributes

getAttribute

public Attribute getAttribute(java.lang.String name)

Looks for the attribute with the given name and returns it. If the attribute does not exist an IllegalArgumentException will be thrown.

Parameters:

name - of the attribute

Returns:

found attribute

hasAttribute

public boolean hasAttribute(java.lang.String name)

Checks if the given attribute is available.

Parameters:

name - the name of the attribute

Returns:

true or false

Since:

0.5

addAttribute

public void addAttribute(Attribute attr)

Adds an attribute to the given attributes.

Parameters:

attr - the new attribute

toString

public java.lang.String toString()

With this toString() implementation we want to provide the most important values which are useful for logging and debugging.

Overrides:

toString in class java.lang.Object

Returns:

a String with operation, request-id and other stuff

toLongString

public java.lang.String toLongString()

All attribute values are put into the resulting string.

Returns:

string with all attributes

writeBinaryTo

public void writeBinaryTo(java.io.OutputStream ostream)
                   throws java.io.IOException

Converts the attribute-group to a byte array as described in RFC-2910 and writes it to the given output-stream.

 -----------------------------------------------
 |           begin-attribute-group-tag         |  1 byte
 ----------------------------------------------------------
 |                   attribute                 |  p bytes |- 0 or more
 ----------------------------------------------------------
 

Specified by:

writeBinaryTo in interface Binary

Parameters:

ostream - an output stream

Throws:

java.io.IOException - in case of I/O problems