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

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

Direct Known Subclasses:

AckTypeField, BooleanField, CommandField, IntegerField, LongField, ReasonField, StatusField, StringField
```
public class Field
extends java.lang.Object
```
Base class for the different types of field data that make up a Message. Implemented with byte array and int offset and length primitives to maximize heap efficiency of cloning, reads, updates, and comparisons.

Field Summary

Fields
Modifier and Type Field and Description

byte[] buffer

int length

int position

Fields
Modifier and Type	Field and Description
`byte[]`	`buffer`
`int`	`length`
`int`	`position`

Constructor Summary

Constructors
Constructor and Description
`Field()` Default constructor.
`Field(byte[] buffer, int position, int length)` Constructs an instance with the specified region of a byte buffer.
`Field(java.lang.String value)` Constructs an instance with the bytes of the specified string value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte`	`byteAt(int i)` Returns the byte at `position` plus index i.
`Field`	`copy()` Constructs a new Field and sets its value to a deep copy of this instance.
`void`	`copyFrom(Field f)` Sets the value of this instance to a deep copy of the value of the specified field.
`boolean`	`equals(java.lang.Object obj)` Default implementation for `Object.equals(java.lang.Object)` for a Field.
`int`	`hashCode()` Default implementation of `Object.hashCode()` for a Field.
`boolean`	`isNull()` Indicates whether this instance's value is null.
`void`	`reset()` Resets the value of this instance to null.
`void`	`set(byte[] buffer)` Sets the value of this instance with the specified buffer.
`void`	`set(byte[] buffer, int position, int length)` Sets the value of this instance with the specified region of a byte buffer.
`java.lang.String`	`toString()` Converts the value to a string representation where each byte is interpreted as a Java character.

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

- Field Detail
  - buffer
```
public byte[] buffer
```
  - position
```
public int position
```
  - length
```
public int length
```
- Constructor Detail
  - Field
```
public Field()
```
    Default constructor.
  - Field
```
public Field(java.lang.String value)
```
    Constructs an instance with the bytes of the specified string value. The string is interpreted as the UTF-8 representation.
    
    Parameters:
    
    value - The string to be converted into UTF-8 bytes.
  - Field
```
public Field(byte[] buffer,
             int position,
             int length)
```
    Constructs an instance with the specified region of a byte buffer. Note: the bytes are not copied from the buffer. The specified buffer region is referenced by this instance.
    
    Parameters:
    
    buffer - The byte buffer.
    
    position - The starting positon of the value in the byte buffer.
    
    length - The length from the starting position of the value in the byte buffer.
- Method Detail
  - set
```
public final void set(byte[] buffer,
                      int position,
                      int length)
```
    Sets the value of this instance with the specified region of a byte buffer. Note: the bytes are not copied from the buffer. The specified buffer region is referenced by this instance.
    
    Parameters:
    
    buffer - The byte buffer.
    
    position - The starting positon of the value in the byte buffer.
    
    length - The length from the starting position of the value in the byte buffer.
  - set
```
public void set(byte[] buffer)
```
    Sets the value of this instance with the specified buffer. Note: the bytes are not copied from the buffer. The buffer is referenced by this instance.
    
    Parameters:
    
    buffer - The byte buffer to be copied.
  - isNull
```
public boolean isNull()
```
    Indicates whether this instance's value is null.
    
    Returns:
    
    True if null, false if not.
  - reset
```
public void reset()
```
    Resets the value of this instance to null.
  - byteAt
```
public byte byteAt(int i)
```
    Returns the byte at position plus index i.
    
    Parameters:
    
    i - The given index.
    
    Returns:
    
    The specified byte.
  - hashCode
```
public int hashCode()
```
    Default implementation of Object.hashCode() for a Field.
    
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Default implementation for Object.equals(java.lang.Object) for a Field. For two Fields to be considered equal, their values must have the same length and all bytes in the value must be equal.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - The object to compare this with.
  - copy
```
public Field copy()
```
    Constructs a new Field and sets its value to a deep copy of this instance.
    
    Returns:
    
    The new deep copy of this instance.
  - toString
```
public java.lang.String toString()
```
    Converts the value to a string representation where each byte is interpreted as a Java character.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    The Java string.
  - copyFrom
```
public void copyFrom(Field f)
```
    Sets the value of this instance to a deep copy of the value of the specified field.
    
    Parameters:
    
    f - The Field to copy from.

Class Field

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

buffer

position

length

Constructor Detail

Field

Field

Field

Method Detail

set

set

isNull

reset

byteAt

hashCode

equals

copy

toString

copyFrom