j4cups.protocol.attr

Class Attribute

java.lang.Object

j4cups.protocol.attr.Attribute

All Implemented Interfaces:

Binary

public final class Attribute
extends java.lang.Object
implements Binary

An "attribute" field is encoded as attribute-with-one-value and (optional) several addtional-values.

 -----------------------------------------------
 |          attribute-with-one-value           |  q bytes
 ----------------------------------------------------------
 |             additional-value                |  r bytes |- 0 or more
 ----------------------------------------------------------
 

When an attribute is single valued (e.g. "copies" with value of 10) or multi-valued with one value (e.g. "sides-supported" with just the value 'one-sided') it is encoded with just an "attribute-with-one- value" field. When an attribute is multi-valued with n values (e.g. "sides-supported" with the values 'one-sided' and 'two-sided-long- edge'), it is encoded with an "attribute-with-one-value" field followed by n-1 "additional-value" fields.

Since:

0.0.2 (11.02.2018)

Author:

Oli B.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Attribute.AdditionalValue An "additional-value" has four entries.
static class	Attribute.AttributeWithOneValue An "attribute-with-one-value" field is encoded with five subfields.

Constructor Summary

Constructors

Constructor and Description
Attribute(java.nio.ByteBuffer bytes) Instantiates a new (single valued or multi-valued) attribute from the given bytes.

Method Summary

Modifier and Type	Method and Description
void	add(Attribute value) For multi-value attributes you can use this method to add the single values to the attribute.
java.util.List<Attribute.AdditionalValue>	getAdditionalValues() Gets the different values for a multi-value attribute.
boolean	getBooleanValue() The "value" field contains the value of a boolean attribute.
int	getIntValue() The "value" field contains the value of a integer attribute.
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 a charset attribute.
java.net.URI	getUriValue() The "value" field contains the value of a URI 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'.
boolean	isMultiValue() When the attribte value is multi-valued this method returns true.
static Attribute	of(java.lang.String name, boolean value) Creates a singe-value attribute for boolean values.
static Attribute	of(java.lang.String name, java.nio.charset.Charset value) Creates a singe-value attribute for charset values.
static Attribute	of(java.lang.String name, int value) Creates a singe-value attribute for integer values.
static Attribute	of(java.lang.String name, int min, int max) Creates a singe-value attribute for a range of integer values.
static Attribute	of(java.lang.String name, java.util.Locale value) Creates a singe-value attribute for the given language.
static Attribute	of(java.lang.String name, PrinterResolution... resolutions) Creates a multi-value attribute with the different printer resolutions.
static Attribute	of(java.lang.String name, java.net.URI value) Creates a singe-value attribute for URI values.
static Attribute	of(ValueTags tag, java.lang.String name, byte[]... additionalValues) Creates a multi-value attribute for the given value-tag.
static Attribute	of(ValueTags tag, java.lang.String name, byte[] value) Creates a singe-value attribute.
static Attribute	of(ValueTags tag, java.lang.String name, int value) Creates a singe-value attribute for integer based values.
static Attribute	of(ValueTags tag, java.lang.String name, java.lang.String... additionalValues) Creates a multi-value attribute for character-string values.
static Attribute	of(ValueTags tag, java.lang.String name, java.lang.String value) Creates a single-value attribute for character-string values.
void	setValue(byte[] value) Sets the value of the attribute.
java.lang.String	toLongString() This method shows a short representation of an attribute.
java.lang.String	toString() This method shows a short representation of an attribute.
void	writeBinaryTo(java.io.OutputStream ostream) Converts the attribute 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

Attribute

public Attribute(java.nio.ByteBuffer bytes)

Instantiates a new (single valued or multi-valued) attribute from the given bytes. The given ByteBuffer must be positioned at the beginning of the attribute.

Parameters:

bytes - ByteBuffer positioned at the beginning

Method Detail

of

public static Attribute of(java.lang.String name,
                           int value)

Creates a singe-value attribute for integer values.

Parameters:

name - e.g. "job-id"

value - e.g. 42

Returns:

the attribute

of

public static Attribute of(java.lang.String name,
                           int min,
                           int max)

Creates a singe-value attribute for a range of integer values.

Parameters:

name - e.g. "copies-supported"

min - e.g. 1

max - e.g. 9999

Returns:

the attribute

of

public static Attribute of(java.lang.String name,
                           boolean value)

Creates a singe-value attribute for boolean values.

Parameters:

name - e.g. "last-document"

value - true or falce

Returns:

the attribute

of

public static Attribute of(java.lang.String name,
                           java.net.URI value)

Creates a singe-value attribute for URI values.

Parameters:

name - e.g. "job-uri"

value - an URI

Returns:

the attribute

of

public static Attribute of(java.lang.String name,
                           java.nio.charset.Charset value)

Creates a singe-value attribute for charset values.

Parameters:

name - e.g. "attributes-charset"

value - e.g. StandardCharsets.UTF_8

Returns:

the attribute

of

public static Attribute of(java.lang.String name,
                           java.util.Locale value)

Creates a singe-value attribute for the given language.

Parameters:

name - e.g. "attributes-natural-language"

value - e.g. the English Locale

Returns:

the attribute

of

public static Attribute of(ValueTags tag,
                           java.lang.String name,
                           int value)

Creates a singe-value attribute for integer based values.

Parameters:

tag - the value-tag

name - the name of the attribute

value - the string value of the attribute

Returns:

the attribute

of

public static Attribute of(ValueTags tag,
                           java.lang.String name,
                           byte[] value)

Creates a singe-value attribute.

Parameters:

tag - the value-tag

name - the name of the attribute

value - the binary value of the attribute

Returns:

the attribute

of

public static Attribute of(ValueTags tag,
                           java.lang.String name,
                           byte[]... additionalValues)

Creates a multi-value attribute for the given value-tag.

Parameters:

tag - the value-tag

name - the name of the attribute

additionalValues - the additional values

Returns:

the attribute

of

public static Attribute of(ValueTags tag,
                           java.lang.String name,
                           java.lang.String... additionalValues)

Creates a multi-value attribute for character-string values.

Parameters:

tag - the value-tag

name - the name of the attribute

additionalValues - additional values

Returns:

the attribute

of

public static Attribute of(ValueTags tag,
                           java.lang.String name,
                           java.lang.String value)

Creates a single-value attribute for character-string values.

Parameters:

tag - the value-tag

name - the name of the attribute

value - the value

Returns:

the attribute

of

public static Attribute of(java.lang.String name,
                           PrinterResolution... resolutions)

Creates a multi-value attribute with the different printer resolutions.

Parameters:

name - the name

resolutions - the different printer resolutions

Returns:

the attribute

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 - value as byte array

getValue

public byte[] getValue()

The "value" field contains the value of the attribute. If the attribute is a multi-value attribute this returns only the fist value.

Returns:

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

getAdditionalValues

public java.util.List<Attribute.AdditionalValue> getAdditionalValues()

Gets the different values for a multi-value attribute.

Returns:

the values

getIntValue

public int getIntValue()

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

Returns:

a 32-bit number

getBooleanValue

public boolean getBooleanValue()

The "value" field contains the value of a boolean attribute. The boolean value is stored as byte, whereas 0x00 is 'false' and 0x01 is 'true'.

Returns:

true (0x01) or false (0x00)

getStringValue

public java.lang.String getStringValue()

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

Returns:

e.g. "one-sided"

getUriValue

public java.net.URI getUriValue()

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

Returns:

an URI

isMultiValue

public boolean isMultiValue()

When the attribte value is multi-valued this method returns true.

Returns:

true or false

toString

public java.lang.String toString()

This method shows a short representation of an attribute. The difference to toLongString() is, that in case of a multi-value attribute only the first value is shown.

Overrides:

toString in class java.lang.Object

Returns:

e.g. "requested-attributes=copies-supported,..."

toLongString

public java.lang.String toLongString()

This method shows a short representation of an attribute. I.e. in case of a multi-value attribute all values are shown.

Returns:

string with all values

writeBinaryTo

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

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

Specified by:

writeBinaryTo in interface Binary

Parameters:

ostream - an output stream

Throws:

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

add

public void add(Attribute value)

For multi-value attributes you can use this method to add the single values to the attribute.

Parameters:

value - the value