j4cups.protocol.attr

Class Attribute.AttributeWithOneValue

java.lang.Object

j4cups.protocol.attr.Attribute.AttributeWithOneValue

Direct Known Subclasses:

Attribute.AdditionalValue

Enclosing class:

Attribute

public static class Attribute.AttributeWithOneValue
extends java.lang.Object

An "attribute-with-one-value" field is encoded with five subfields.

 -----------------------------------------------
 |                   value-tag                 |   1 byte
 -----------------------------------------------
 |               name-length  (value is u)     |   2 bytes
 -----------------------------------------------
 |                     name                    |   u bytes
 -----------------------------------------------
 |              value-length  (value is v)     |   2 bytes
 -----------------------------------------------
 |                     value                   |   v bytes
 -----------------------------------------------
 

The "value-tag" field specifies the attribute syntax, e.g. 0x44 for the attribute syntax 'keyword'.

The "name-length" field specifies the length of the "name" field in bytes, e.g. u in the above diagram or 15 for the name "sides- supported".

The "name" field contains the textual name of the attribute, e.g. "sides-supported".

The "value-length" field specifies the length of the "value" field in bytes, e.g. v in the above diagram or 9 for the (keyword) value 'one-sided'.

The "value" field contains the value of the attribute, e.g. the textual value 'one-sided'.

Constructor Summary

Constructors

Constructor and Description
AttributeWithOneValue(java.nio.ByteBuffer bytes) Instantiates a new attribute-with-one-value from the given bytes.
AttributeWithOneValue(ValueTags valueTag, java.lang.String name, byte[] value) Instantiates a new attribute-with-one-value.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() The "name" field contains the textual name of the attribute.
java.lang.String	getStringValue() The "value" field contains the value of the attribute.
byte[]	getValue() The "value" field contains the value of the attribute.
ValueTags	getValueTag() The "value-tag" field specifies the attribute syntax, e.g. 0x44 for the attribute syntax 'keyword'.
void	setValue(byte[] value) Sets the value of the attribute.
byte[]	toByteArray() Converts an attribute-with-one-value to a byte array.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeWithOneValue

public AttributeWithOneValue(java.nio.ByteBuffer bytes)

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

Parameters:

bytes - ByteBuffer positioned at the beginning

AttributeWithOneValue

public AttributeWithOneValue(ValueTags valueTag,
                             java.lang.String name,
                             byte[] value)

Instantiates a new attribute-with-one-value.

Parameters:

valueTag - the value-tag

name - name of the attribute

value - binary value of the attribute

Method Detail

getValueTag

public ValueTags getValueTag()

The "value-tag" field specifies the attribute syntax, e.g. 0x44 for the attribute syntax 'keyword'.

Returns:

e.g. ValueTags.KEYWORD

getName

public java.lang.String getName()

The "name" field contains the textual name of the attribute.

Returns:

e.g. "slides-supported"

setValue

public void setValue(byte[] value)

Sets the value of the attribute.

Parameters:

value - as byte array

getValue

public byte[] getValue()

The "value" field contains the value of the attribute.

Returns:

e.g. the textual value 'one-sided' as bytes

getStringValue

public java.lang.String getStringValue()

The "value" field contains the value of the attribute.

Returns:

e.g. "one-sided"

toByteArray

public byte[] toByteArray()

Converts an attribute-with-one-value to a byte array.

 -----------------------------------------------
 |                   value-tag                 |   1 byte
 -----------------------------------------------
 |               name-length  (value is u)     |   2 bytes
 -----------------------------------------------
 |                     name                    |   u bytes
 -----------------------------------------------
 |              value-length  (value is v)     |   2 bytes
 -----------------------------------------------
 |                     value                   |   v bytes
 -----------------------------------------------
 

Returns:

byte array