AckTypeField (AMPS Java Client (5.3.2.1.6d15937f.540279))

java.lang.Object
- com.crankuptheamps.client.fields.Field
- - com.crankuptheamps.client.fields.AckTypeField

```
public class AckTypeField
extends Field
```
Field data for a Message consisting of the Acknowlegement Type. This is used to hold the type of Acknowledgement for the Acknowledgement Message.

Field Summary

Fields
Modifier and Type Field and Description

protected static java.nio.charset.Charset LATIN1

protected static byte LATIN1_ZERO
- Fields inherited from class com.crankuptheamps.client.fields.Field
  buffer, length, position

Fields
Modifier and Type	Field and Description
`protected static java.nio.charset.Charset`	`LATIN1`
`protected static byte`	`LATIN1_ZERO`

Constructor Summary

Constructors
Constructor and Description

AckTypeField()

Constructors
Constructor and Description
`AckTypeField()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`decodeAckType(byte[] buffer, int pos, int len)` Decodes the acknowledgement type given by AMPS.
`static java.lang.String`	`encodeAckType(int ack)` Converts the acknowlegement from an integer to a string.
`int`	`getValue()` This method gets the value of the AckType.
`void`	`setValue(int v)` This method sets the value of the AckType to an integer according to the action that has been performed on the AckType.

Methods inherited from class com.crankuptheamps.client.fields.Field
byteAt, copy, copyFrom, equals, hashCode, isNull, reset, set, set, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - LATIN1
```
protected static final java.nio.charset.Charset LATIN1
```
  - LATIN1_ZERO
```
protected static final byte LATIN1_ZERO
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AckTypeField
```
public AckTypeField()
```
- Method Detail
  - getValue
```
public int getValue()
```
    This method gets the value of the AckType.
    
    Returns:
    
    Returns AckType with the integer value of none, if the buffer is null. If the buffer is not null, it grabs the position and the length of the AckType.
  - setValue
```
public void setValue(int v)
```
    This method sets the value of the AckType to an integer according to the action that has been performed on the AckType.
    
    Parameters:
    
    v - the value to set
  - decodeAckType
```
public static final int decodeAckType(byte[] buffer,
                                      int pos,
                                      int len)
```
    Decodes the acknowledgement type given by AMPS.
    
    Parameters:
    
    buffer - An array of bytes, which is the first parameter passed to decodeAckType.
    
    pos - An integer which holds the position of the offset.
    
    len - An integer which holds the length of the acknowlegement.
    
    Returns:
    
    the constant from Message.AckType for the input value
  - encodeAckType
```
public static final java.lang.String encodeAckType(int ack)
```
    Converts the acknowlegement from an integer to a string.
    
    Parameters:
    
    ack - The integer representing the acknowledgement produced by AMPS.
    
    Returns:
    
    A string that represents the acknowledgement type

Class AckTypeField

Field Summary

Fields inherited from class com.crankuptheamps.client.fields.Field

Constructor Summary

Method Summary

Methods inherited from class com.crankuptheamps.client.fields.Field

Methods inherited from class java.lang.Object

Field Detail

LATIN1

LATIN1_ZERO

Constructor Detail

AckTypeField

Method Detail

getValue

setValue

decodeAckType

encodeAckType