BinaryAsLongField (IBM JZOS Toolkit API)

java.lang.Object
- com.ibm.jzos.fields.BinaryAsLongField

All Implemented Interfaces:

Field, LongAccessor

Direct Known Subclasses:

BinarySignedLongField, BinaryUnsignedLongField
```
public class BinaryAsLongField
extends java.lang.Object
implements LongAccessor
```
A 4-8 byte binary Field with long accessors.

Since:

2.1.0

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_FIELD_WIDTH`
`static int`	`MAX_FIELD_WIDTH`
`static long`	`SIGNED_MAX_LEN1_VAL`
`static long`	`SIGNED_MAX_LEN2_VAL`
`static long`	`SIGNED_MAX_LEN3_VAL`
`static long`	`SIGNED_MAX_LEN4_VAL`
`static long`	`SIGNED_MAX_LEN5_VAL`
`static long`	`SIGNED_MAX_LEN6_VAL`
`static long`	`SIGNED_MAX_LEN7_VAL`
`static long`	`SIGNED_MAX_LEN8_VAL`
`static long`	`SIGNED_MIN_LEN1_VAL`
`static long`	`SIGNED_MIN_LEN2_VAL`
`static long`	`SIGNED_MIN_LEN3_VAL`
`static long`	`SIGNED_MIN_LEN4_VAL`
`static long`	`SIGNED_MIN_LEN5_VAL`
`static long`	`SIGNED_MIN_LEN6_VAL`
`static long`	`SIGNED_MIN_LEN7_VAL`
`static long`	`SIGNED_MIN_LEN8_VAL`
`static long`	`UNSIGNED_MAX_LEN1_VAL`
`static long`	`UNSIGNED_MAX_LEN2_VAL`
`static long`	`UNSIGNED_MAX_LEN3_VAL`
`static long`	`UNSIGNED_MAX_LEN4_VAL`
`static long`	`UNSIGNED_MAX_LEN5_VAL`
`static long`	`UNSIGNED_MAX_LEN6_VAL`
`static long`	`UNSIGNED_MAX_LEN7_VAL`
`static long`	`UNSIGNED_MAX_LEN8_VAL`

Constructor Summary

Constructors
Constructor and Description
`BinaryAsLongField(int offset)` Construct a signed instance with a field width = DEFAULT_FIELD_WIDTH = 8.
`BinaryAsLongField(int offset, int length)` Construct a signed instance with a given offset and length.
`BinaryAsLongField(int offset, int length, boolean signed)` Construct an instance.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Long aLong, long along)` Compare a Long, possibly null, with a long for equality.
`int`	`getByteLength()` Answer the length of the field described by the receiver
`long`	`getLong(byte[] buffer)` Answer a long from the given byte array buffer, at the offset of this field.
`long`	`getLong(byte[] buffer, int bufOffset)` Answer a long from the given byte array buffer, at the bufOffset + offset of this field.
`int`	`getOffset()` Answer the offset of this field into some array of bytes
`boolean`	`isSigned()` Answer true if this field described a signed binary int, false if unsigned.
`void`	`putLong(long value, byte[] buffer)` Put a signed long into thegiven byte array buffer, at the bufOffset of this field.
`void`	`putLong(long value, byte[] buffer, int bufOffset)` Put a signed long into thegiven byte array buffer, at the bufOffset + offset of this field.
`void`	`setOffset(int offset)`
`void`	`setSigned(boolean signed)` Deprecated. Change the sign of the field. When Data Access Acceleration (DAA) is enabled, this method is not supported and an UnsupportedOperationException will be thrown.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MAX_FIELD_WIDTH
```
public static final int MAX_FIELD_WIDTH
```
    See Also:
    
    Constant Field Values
  - DEFAULT_FIELD_WIDTH
```
public static final int DEFAULT_FIELD_WIDTH
```
    See Also:
    
    Constant Field Values
  - SIGNED_MIN_LEN1_VAL
```
public static final long SIGNED_MIN_LEN1_VAL
```
    See Also:
    
    Constant Field Values
  - SIGNED_MAX_LEN1_VAL
```
public static final long SIGNED_MAX_LEN1_VAL
```
    See Also:
    
    Constant Field Values
  - SIGNED_MIN_LEN2_VAL
```
public static final long SIGNED_MIN_LEN2_VAL
```
    See Also:
    
    Constant Field Values
  - SIGNED_MAX_LEN2_VAL
```
public static final long SIGNED_MAX_LEN2_VAL
```
    See Also:
    
    Constant Field Values
  - SIGNED_MIN_LEN3_VAL
```
public static final long SIGNED_MIN_LEN3_VAL
```
    See Also:
    
    Constant Field Values
  - SIGNED_MAX_LEN3_VAL
```
public static final long SIGNED_MAX_LEN3_VAL
```
    See Also:
    
    Constant Field Values
  - SIGNED_MIN_LEN4_VAL
```
public static final long SIGNED_MIN_LEN4_VAL
```
    See Also:
    
    Constant Field Values
  - SIGNED_MAX_LEN4_VAL
```
public static final long SIGNED_MAX_LEN4_VAL
```
    See Also:
    
    Constant Field Values
  - SIGNED_MIN_LEN5_VAL
```
public static final long SIGNED_MIN_LEN5_VAL
```
    See Also:
    
    Constant Field Values
  - SIGNED_MAX_LEN5_VAL
```
public static final long SIGNED_MAX_LEN5_VAL
```
    See Also:
    
    Constant Field Values
  - SIGNED_MIN_LEN6_VAL
```
public static final long SIGNED_MIN_LEN6_VAL
```
    See Also:
    
    Constant Field Values
  - SIGNED_MAX_LEN6_VAL
```
public static final long SIGNED_MAX_LEN6_VAL
```
    See Also:
    
    Constant Field Values
  - SIGNED_MIN_LEN7_VAL
```
public static final long SIGNED_MIN_LEN7_VAL
```
    See Also:
    
    Constant Field Values
  - SIGNED_MAX_LEN7_VAL
```
public static final long SIGNED_MAX_LEN7_VAL
```
    See Also:
    
    Constant Field Values
  - SIGNED_MIN_LEN8_VAL
```
public static final long SIGNED_MIN_LEN8_VAL
```
    See Also:
    
    Constant Field Values
  - SIGNED_MAX_LEN8_VAL
```
public static final long SIGNED_MAX_LEN8_VAL
```
    See Also:
    
    Constant Field Values
  - UNSIGNED_MAX_LEN1_VAL
```
public static final long UNSIGNED_MAX_LEN1_VAL
```
    See Also:
    
    Constant Field Values
  - UNSIGNED_MAX_LEN2_VAL
```
public static final long UNSIGNED_MAX_LEN2_VAL
```
    See Also:
    
    Constant Field Values
  - UNSIGNED_MAX_LEN3_VAL
```
public static final long UNSIGNED_MAX_LEN3_VAL
```
    See Also:
    
    Constant Field Values
  - UNSIGNED_MAX_LEN4_VAL
```
public static final long UNSIGNED_MAX_LEN4_VAL
```
    See Also:
    
    Constant Field Values
  - UNSIGNED_MAX_LEN5_VAL
```
public static final long UNSIGNED_MAX_LEN5_VAL
```
    See Also:
    
    Constant Field Values
  - UNSIGNED_MAX_LEN6_VAL
```
public static final long UNSIGNED_MAX_LEN6_VAL
```
    See Also:
    
    Constant Field Values
  - UNSIGNED_MAX_LEN7_VAL
```
public static final long UNSIGNED_MAX_LEN7_VAL
```
    See Also:
    
    Constant Field Values
  - UNSIGNED_MAX_LEN8_VAL
```
public static final long UNSIGNED_MAX_LEN8_VAL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BinaryAsLongField
```
public BinaryAsLongField(int offset)
```
    Construct a signed instance with a field width = DEFAULT_FIELD_WIDTH = 8.
    
    Parameters:
    
    offset - int the offset in some byte array to the start of this field.
  - BinaryAsLongField
```
public BinaryAsLongField(int offset,
                         int length)
```
    Construct a signed instance with a given offset and length.
    
    Parameters:
    
    offset - int the offset in some byte array to the start of this field.
    
    length - int the size of the field in bytes
  - BinaryAsLongField
```
public BinaryAsLongField(int offset,
                         int length,
                         boolean signed)
```
    Construct an instance.
    
    Parameters:
    
    offset - int the offset in some byte array to the start of this field.
    
    length - int the size of the field in bytes
    
    signed - boolean true if the field is signed, false if unsigned.
- Method Detail
  - getByteLength
```
public int getByteLength()
```
    Answer the length of the field described by the receiver
    
    Specified by:
    
    getByteLength in interface Field
    
    Returns:
    
    int
  - getOffset
```
public int getOffset()
```
    Answer the offset of this field into some array of bytes
    
    Specified by:
    
    getOffset in interface Field
    
    Returns:
    
    int
  - setOffset
```
public void setOffset(int offset)
```
    Specified by:
    
    setOffset in interface Field
    
    See Also:
    
    getOffset()
  - getLong
```
public long getLong(byte[] buffer,
                    int bufOffset)
```
    Answer a long from the given byte array buffer, at the bufOffset + offset of this field.
    
    Specified by:
    
    getLong in interface LongAccessor
    
    Parameters:
    
    buffer - the byte array
    
    bufOffset - the additional offset into the byte array
    
    Returns:
    
    long
    
    Throws:
    
    java.lang.IllegalArgumentException - if the value in the field is unsigned and too large to be represented as a java long
  - getLong
```
public long getLong(byte[] buffer)
```
    Answer a long from the given byte array buffer, at the offset of this field.
    
    Specified by:
    
    getLong in interface LongAccessor
    
    Parameters:
    
    buffer - the byte array
    
    Returns:
    
    long
    
    Throws:
    
    java.lang.IllegalArgumentException - if the value in the field is unsigned and too large to be represented as a java long
  - putLong
```
public void putLong(long value,
                    byte[] buffer,
                    int bufOffset)
             throws java.lang.IllegalArgumentException
```
    Put a signed long into thegiven byte array buffer, at the bufOffset + offset of this field.
    
    Specified by:
    
    putLong in interface LongAccessor
    
    Parameters:
    
    value - the signed long value
    
    buffer - the byte array
    
    bufOffset - the additional offset into the byte array
    
    Throws:
    
    java.lang.IllegalArgumentException - if the value is out of range
  - putLong
```
public void putLong(long value,
                    byte[] buffer)
             throws java.lang.IllegalArgumentException
```
    Put a signed long into thegiven byte array buffer, at the bufOffset of this field.
    
    Specified by:
    
    putLong in interface LongAccessor
    
    Parameters:
    
    value - the signed long value
    
    buffer - the byte array
    
    Throws:
    
    java.lang.IllegalArgumentException - if the value is out of range
  - isSigned
```
public boolean isSigned()
```
    Answer true if this field described a signed binary int, false if unsigned.
    
    Specified by:
    
    isSigned in interface LongAccessor
  - setSigned
```
public void setSigned(boolean signed)
```
    Deprecated. Change the sign of the field. When Data Access Acceleration (DAA) is enabled, this method is not supported and an UnsupportedOperationException will be thrown.
    
    See Also:
    
    isSigned()
  - equals
```
public boolean equals(java.lang.Long aLong,
                      long along)
```
    Compare a Long, possibly null, with a long for equality.
    
    Parameters:
    
    aLong -
    
    along -
    
    Returns:
    
    boolean true if equal, false otherwise

Methods inherited from class java.lang.Object

MAX_FIELD_WIDTH

DEFAULT_FIELD_WIDTH

SIGNED_MIN_LEN1_VAL

SIGNED_MAX_LEN1_VAL

SIGNED_MIN_LEN2_VAL

SIGNED_MAX_LEN2_VAL

SIGNED_MIN_LEN3_VAL

SIGNED_MAX_LEN3_VAL

SIGNED_MIN_LEN4_VAL

SIGNED_MAX_LEN4_VAL

SIGNED_MIN_LEN5_VAL

SIGNED_MAX_LEN5_VAL

SIGNED_MIN_LEN6_VAL

SIGNED_MAX_LEN6_VAL

SIGNED_MIN_LEN7_VAL

SIGNED_MAX_LEN7_VAL

SIGNED_MIN_LEN8_VAL

SIGNED_MAX_LEN8_VAL

UNSIGNED_MAX_LEN1_VAL

UNSIGNED_MAX_LEN2_VAL

UNSIGNED_MAX_LEN3_VAL

UNSIGNED_MAX_LEN4_VAL

UNSIGNED_MAX_LEN5_VAL

UNSIGNED_MAX_LEN6_VAL

UNSIGNED_MAX_LEN7_VAL

UNSIGNED_MAX_LEN8_VAL

BinaryAsLongField

BinaryAsLongField

BinaryAsLongField

getByteLength

getOffset

setOffset

getLong

getLong

putLong

putLong

isSigned

setSigned

equals