Attribute (J4Cups 0.2.0 API)

java.lang.Object
- j4cups.protocol.attr.Attribute

All Implemented Interfaces:

Binary
```
public final class Attribute
extends 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(ByteBuffer bytes)
Instantiates a new (single valued or multi-valued) attribute from the given bytes.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getName()` The "name" field contains the textual name of the attribute.
`String`	`getStringValue()` The "value" field contains the value of a charset attribute.
`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(String name, Charset value)` Creates a singe-value attribute for charset values.
`static Attribute`	`of(String name, int value)` Creates a singe-value attribute for integer values.
`static Attribute`	`of(String name, Locale value)` Creates a singe-value attribute for the given language.
`static Attribute`	`of(String name, URI value)` Creates a singe-value attribute for URI values.
`static Attribute`	`of(ValueTags tag, String name, byte[] value)` Creates a singe-value attribute.
`static Attribute`	`of(ValueTags tag, String name, int value)` Creates a singe-value attribute for integer based values.
`static Attribute`	`of(ValueTags tag, String name, String value)` Creates a singe-value attribute for character-string values.
`String`	`toLongString()` This method shows a short representation of an attribute.
`String`	`toString()` This method shows a short representation of an attribute.
`void`	`writeBinaryTo(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(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(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(String name,
                           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(String name,
                           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(String name,
                           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,
                           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,
                           String name,
                           String value)
```
    Creates a singe-value attribute for character-string 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,
                           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
  - 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 String getName()
```
    The "name" field contains the textual name of the attribute.
    
    Returns:
    
    e.g. "slides-supported"
  - 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
  - getStringValue
```
public String getStringValue()
```
    The "value" field contains the value of a charset attribute.
    
    Returns:
    
    e.g. "one-sided"
  - getUriValue
```
public 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 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 Object
    
    Returns:
    
    e.g. "requested-attributes=copies-supported,..."
  - toLongString
```
public 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(OutputStream ostream)
                   throws 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:
    
    IOException - in case of I/O problems

Class Attribute

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface j4cups.protocol.Binary

Constructor Detail

Attribute

Method Detail

of

of

of

of

of

of

of

getValueTag

getName

getValue

getStringValue

getUriValue

isMultiValue

toString

toLongString

writeBinaryTo