Field (tlc-io-base 2.3.1 API)

java.lang.Object
- com.thelastcheck.io.base.Field

```
public class Field
extends Object
```

Field Summary

Fields
Modifier and Type Field and Description

protected static SimpleDateFormat sdfDate

protected static SimpleDateFormat sdfTime

Fields
Modifier and Type	Field and Description
`protected static SimpleDateFormat`	`sdfDate`
`protected static SimpleDateFormat`	`sdfTime`

Constructor Summary

Constructors
Constructor and Description
`Field()`
`Field(int offset, int length)`
`Field(int offset, int length, FieldType type)`
`Field(String fieldName, int fieldNumber, int offset, int length)`
`Field(String fieldName, int fieldNumber, int offset, int length, FieldType type)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clearBit(byte mask, ByteArray record)`
`Object`	`extract(ByteArray record)` Extract a data field from a ByteArray.
`byte`	`extractAsByte(ByteArray record)` Extract a data field from a ByteArray as a byte.
`ByteArray`	`extractAsByteArray(ByteArray record)` Extract a data field from a ByteArray as a ByteArray.
`byte[]`	`extractAsBytes(ByteArray record)` Extract a data field from a ByteArray as byte[].
`int`	`extractAsInt(ByteArray record)` Extract a data field from a ByteArray as an int.
`long`	`extractAsLong(ByteArray record)` Extract a data field from a ByteArray as a long.
`short`	`extractAsShort(ByteArray record)` Extract a data field from a ByteArray as a short.
`String`	`extractAsString(ByteArray record)` Extract a data field from a ByteArray record as a String.
`String`	`extractPnsAsString(ByteArray record)` Extract a data field from a ByteArray converting from PNS to a String.
`Date`	`extractStringAsDate(ByteArray record)` Extract a data field from a ByteArray as a Date.
`Date`	`extractStringAsDate(ByteArray record, TimeZone zone)` Extract a data field from a ByteArray as a Date.
`int`	`extractStringAsInt(ByteArray record)` Extract a data field from a ByteArray as a String and convert value to an int.
`long`	`extractStringAsLong(ByteArray record)` Extract a data field from a ByteArray as a String and convert value to a long.
`OnUsField`	`extractStringAsOnUsField(ByteArray record)` Extract a data field from a ByteArray as a String and convert value to an OnusField.
`RoutingNumber`	`extractStringAsRoutingNumber(ByteArray record)` Extract a data field from a ByteArray as a String and convert value to an RoutingNumber.
`Date`	`extractStringAsTime(ByteArray record)` Extract a data field from a ByteArray as a Date object containing only time values.
`Date`	`extractStringAsTime(ByteArray record, TimeZone zone)` Extract a data field from a ByteArray as a Date object containing only time values.
`void`	`formatToString(ByteArray record, org.apache.commons.lang3.builder.ToStringBuilder sb)` Format the field into a ToStringBuilder object.
`void`	`formatToXml(ByteArray record, ToXmlBuilder xb)` Format the field into a ToStringBuilder object.
`void`	`insert(byte[] value, ByteArray record)`
`void`	`insert(ByteArray value, ByteArray record)`
`void`	`insert(byte value, ByteArray record)`
`void`	`insert(int value, ByteArray record)`
`void`	`insert(long value, ByteArray record)`
`void`	`insert(OnUsField value, ByteArray record)`
`void`	`insert(RoutingNumber value, ByteArray record)`
`void`	`insert(short value, ByteArray record)`
`void`	`insert(String value, ByteArray record)`
`void`	`insertAsString(int value, ByteArray record)`
`void`	`insertAsString(long value, ByteArray record)`
`void`	`insertDate(Date value, ByteArray record)`
`void`	`insertDate(Date value, ByteArray record, TimeZone zone)`
`void`	`insertPns(String value, ByteArray record)`
`void`	`insertRight(String value, ByteArray record)`
`void`	`insertTime(Date value, ByteArray record)`
`void`	`insertTime(Date value, ByteArray record, TimeZone zone)`
`boolean`	`isType(FieldType type)`
`String`	`name()`
`void`	`setBit(byte mask, ByteArray record)`
`boolean`	`testBit(byte mask, ByteArray record)`
`String`	`toString()`
`FieldType`	`type()`

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

- Field Detail
  - sdfDate
```
protected static SimpleDateFormat sdfDate
```
  - sdfTime
```
protected static SimpleDateFormat sdfTime
```
- Constructor Detail
  - Field
```
public Field()
```
  - Field
```
public Field(int offset,
     int length)
```
  - Field
```
public Field(int offset,
     int length,
     FieldType type)
```
  - Field
```
public Field(String fieldName,
     int fieldNumber,
     int offset,
     int length)
```
  - Field
```
public Field(String fieldName,
     int fieldNumber,
     int offset,
     int length,
     FieldType type)
```
- Method Detail
  - isType
```
public boolean isType(FieldType type)
```
  - type
```
public FieldType type()
```
  - extract
```
public Object extract(ByteArray record)
               throws InvalidDataException
```
    Extract a data field from a ByteArray.
    
    Parameters:
    record - A ByteArray containing an ASN.1 format record
    
    Returns:
    An Object containing the extracted data. The type of object returned depends on the field type.
    
    Throws:
    
    InvalidDataException
  - extractAsBytes
```
public byte[] extractAsBytes(ByteArray record)
```
    Extract a data field from a ByteArray as byte[].
    
    Parameters:
    record - A ByteArray containing an ASN.1 format record
    
    Returns:
    A byte array containing the extracted data.
  - extractAsByteArray
```
public ByteArray extractAsByteArray(ByteArray record)
```
    Extract a data field from a ByteArray as a ByteArray.
    
    Parameters:
    record - A ByteArray containing an ASN.1 format record
    
    Returns:
    A ByteArray containing the extracted data.
  - extractAsString
```
public String extractAsString(ByteArray record)
```
    Extract a data field from a ByteArray record as a String.
    
    Parameters:
    record - A ByteArray containing an ASN.1 format record
    
    Returns:
    A String containing the extracted data.
  - extractStringAsLong
```
public long extractStringAsLong(ByteArray record)
                         throws InvalidDataException
```
    Extract a data field from a ByteArray as a String and convert value to a long.
    
    Parameters:
    record - A ByteArray containing an ASN.1 format record
    
    Returns:
    A long containing the extracted data.
    
    Throws:
    
    InvalidDataException
  - extractStringAsInt
```
public int extractStringAsInt(ByteArray record)
                       throws InvalidDataException
```
    Extract a data field from a ByteArray as a String and convert value to an int.
    
    Parameters:
    record - A ByteArray containing a ASN.1 format record
    
    Returns:
    An int containing the extracted data.
    
    Throws:
    
    InvalidDataException
  - extractAsLong
```
public long extractAsLong(ByteArray record)
```
    Extract a data field from a ByteArray as a long.
    
    Parameters:
    record - A ByteArray containing an ASN.1 format record
    
    Returns:
    A long containing the extracted data.
  - extractAsByte
```
public byte extractAsByte(ByteArray record)
```
    Extract a data field from a ByteArray as a byte.
    
    Parameters:
    record - A ByteArray containing an ASN.1 format record
    
    Returns:
    A byte containing the extracted data.
  - extractAsShort
```
public short extractAsShort(ByteArray record)
```
    Extract a data field from a ByteArray as a short.
    
    Parameters:
    record - A ByteArray containing an ASN.1 format record
    
    Returns:
    A short containing the extracted data.
  - extractAsInt
```
public int extractAsInt(ByteArray record)
```
    Extract a data field from a ByteArray as an int.
    
    Parameters:
    record - A ByteArray containing an ASN.1 format record
    
    Returns:
    An int containing the extracted data.
  - extractPnsAsString
```
public String extractPnsAsString(ByteArray record)
```
    Extract a data field from a ByteArray converting from PNS to a String.
    
    Parameters:
    record - A ByteArray containing an ASN.1 format record
    
    Returns:
    A string containing the unpacked data
  - extractStringAsDate
```
public Date extractStringAsDate(ByteArray record)
                         throws InvalidDataException
```
    Extract a data field from a ByteArray as a Date.
    
    Parameters:
    record - A ByteArray containing an ASN.1 format record
    
    Returns:
    A Date containing the extracted data.
    
    Throws:
    
    InvalidDataException
  - extractStringAsDate
```
public Date extractStringAsDate(ByteArray record,
                       TimeZone zone)
                         throws InvalidDataException
```
    Extract a data field from a ByteArray as a Date.
    
    Parameters:
    record - A ByteArray containing an ASN.1 format record
    
    Returns:
    A Date containing the extracted data or null if the string value is empty.
    
    Throws:
    
    InvalidDataException
  - extractStringAsTime
```
public Date extractStringAsTime(ByteArray record)
                         throws InvalidDataException
```
    Extract a data field from a ByteArray as a Date object containing only time values.
    
    Parameters:
    record - A ByteArray containing an ASN.1 format record
    
    Returns:
    A time value formatted as Date containing the extracted data or null if the string value is empty.
    
    Throws:
    
    InvalidDataException
  - extractStringAsTime
```
public Date extractStringAsTime(ByteArray record,
                       TimeZone zone)
                         throws InvalidDataException
```
    Extract a data field from a ByteArray as a Date object containing only time values.
    
    Parameters:
    record - A ByteArray containing an ASN.1 format record
    zone - A TimeZone object identifying the time zone for the time being extracted
    
    Returns:
    A time value formatted as Date containing the extracted data or null if the string value is empty.
    
    Throws:
    
    InvalidDataException
  - extractStringAsRoutingNumber
```
public RoutingNumber extractStringAsRoutingNumber(ByteArray record)
```
    Extract a data field from a ByteArray as a String and convert value to an RoutingNumber.
    
    Parameters:
    record - A ByteArray containing a ASN.1 format record
    
    Returns:
    A RoutingNumber containing the extracted data.
    
    Throws:
    
    InvalidDataException
  - extractStringAsOnUsField
```
public OnUsField extractStringAsOnUsField(ByteArray record)
```
    Extract a data field from a ByteArray as a String and convert value to an OnusField.
    
    Parameters:
    record - A ByteArray containing a ASN.1 format record
    
    Returns:
    A OnUsField containing the extracted data.
    
    Throws:
    
    InvalidDataException
  - insert
```
public void insert(byte[] value,
          ByteArray record)
```
    Parameters:
    value - A field value contained in an array of bytes.
    record - A ByteArray containing an ASN.1 format record
  - insert
```
public void insert(ByteArray value,
          ByteArray record)
```
    Parameters:
    value - A field value contained in a ByteArray to be stored into the ByteArray.
    record - A ByteArray containing an ASN.1 format record
  - insert
```
public void insert(String value,
          ByteArray record)
```
    Parameters:
    value - A field value contained in a String to be stored into the ByteArray.
    record - A ByteArray containing an ASN.1 format record
  - insertRight
```
public void insertRight(String value,
               ByteArray record)
```
    Parameters:
    value - A field value contained in a String to be stored into the ByteArray right justified and space filled.
    record - A ByteArray containing an ASN.1 format record
  - insertAsString
```
public void insertAsString(long value,
                  ByteArray record)
```
    Parameters:
    value - A field value contained in a long to be converted to a String and then to be stored into the ByteArray.
    record - A ByteArray containing an ASN.1 format record
  - insertAsString
```
public void insertAsString(int value,
                  ByteArray record)
```
    Parameters:
    value - A field value contained in an int to be converted to a String and then to be stored into the ByteArray.
    record - A ByteArray containing an ASN.1 format record
  - insert
```
public void insert(byte value,
          ByteArray record)
```
    Parameters:
    value - A field value contained in an int and stored in big endion binary format in the ByteArray.
    record - A ByteArray containing an ASN.1 format record
  - insert
```
public void insert(short value,
          ByteArray record)
```
    Parameters:
    value - A field value contained in an int and stored in big endion binary format in the ByteArray.
    record - A ByteArray containing an ASN.1 format record
  - insert
```
public void insert(int value,
          ByteArray record)
```
    Parameters:
    value - A field value contained in an int and stored in big endion binary format in the ByteArray.
    record - A ByteArray containing an ASN.1 format record
  - insert
```
public void insert(long value,
          ByteArray record)
```
    Parameters:
    value - A field value contained in an long and stored in big endion binary format in the ByteArray.
    record - A ByteArray containing an ASN.1 format record
  - insertDate
```
public void insertDate(Date value,
              ByteArray record)
```
    Parameters:
    value - A field value contained in a Date object to be converted to a String and then to be stored into the ByteArray.
    record - A ByteArray containing an ASN.1 format record
  - insertDate
```
public void insertDate(Date value,
              ByteArray record,
              TimeZone zone)
```
    Parameters:
    value - A field value contained in a Date object to be converted to a String and then to be stored into the ByteArray.
    zone - A TimeZone object identifying the time zone for the date being extracted. Based on the time value in the date object, this could result in the date value being a different date than the local date.
    record - A ByteArray containing an ASN.1 format record
  - insertTime
```
public void insertTime(Date value,
              ByteArray record)
```
    Parameters:
    value - A field value contained in a Date object as a time value to be converted to a String and then to be stored into the ByteArray.
    record - A ByteArray containing an ASN.1 format record
  - insertTime
```
public void insertTime(Date value,
              ByteArray record,
              TimeZone zone)
```
    Parameters:
    value - A field value contained in a Date object as a time value to be converted to a String and then to be stored into the ByteArray.
    record - A ByteArray containing an ASN.1 format record
  - insert
```
public void insert(RoutingNumber value,
          ByteArray record)
```
    Parameters:
    value - A field value contained in a RoutingNumber to be stored into the ByteArray.
    record - A ByteArray containing an ASN.1 format record
  - insert
```
public void insert(OnUsField value,
          ByteArray record)
```
    Parameters:
    value - A field value contained in a OnUsField to be stored into the ByteArray.
    record - A ByteArray containing an ASN.1 format record
  - insertPns
```
public void insertPns(String value,
             ByteArray record)
```
    Parameters:
    value - A field value to be stored as a PNS value in the ByteArray
    record - A ByteArray containing an ASN.1 format record
  - setBit
```
public void setBit(byte mask,
          ByteArray record)
```
    Parameters:
    mask - A mask value to indicate which bits are to be set.
    record - A ByteArray containing an ASN.1 format record
  - clearBit
```
public void clearBit(byte mask,
            ByteArray record)
```
    Parameters:
    mask - A mask value to indicate which bits are to be cleared.
    record - A ByteArray containing an ASN.1 format record
  - testBit
```
public boolean testBit(byte mask,
              ByteArray record)
```
    Parameters:
    mask - A mask value to indicate which bits are to be tested.
    record - A ByteArray containing an ASN.1 format record
  - name
```
public String name()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - formatToString
```
public void formatToString(ByteArray record,
                  org.apache.commons.lang3.builder.ToStringBuilder sb)
```
    Format the field into a ToStringBuilder object.
    
    Parameters:
    record -
    sb -
  - formatToXml
```
public void formatToXml(ByteArray record,
               ToXmlBuilder xb)
```
    Format the field into a ToStringBuilder object.
    
    Parameters:
    record -
    xb -

Class Field

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sdfDate

sdfTime

Constructor Detail

Field

Field

Field

Field

Field

Method Detail

isType

type

extract

extractAsBytes

extractAsByteArray

extractAsString

extractStringAsLong

extractStringAsInt

extractAsLong

extractAsByte

extractAsShort

extractAsInt

extractPnsAsString

extractStringAsDate

extractStringAsDate

extractStringAsTime

extractStringAsTime

extractStringAsRoutingNumber

extractStringAsOnUsField

insert

insert

insert

insertRight

insertAsString

insertAsString

insert

insert

insert

insert

insertDate

insertDate

insertTime

insertTime

insert

insert

insertPns

setBit

clearBit

testBit

name

toString

formatToString

formatToXml