beneficiaryReference.go

// Copyright 2020 The Moov Authors
// Use of this source code is governed by an Apache License
// license that can be found in the LICENSE file.

package wire

import (
	"encoding/json"
	"strings"
	"unicode/utf8"
)

// BeneficiaryReference is a reference for the beneficiary
type BeneficiaryReference struct {
	// tag
	tag string
	// BeneficiaryReference
	BeneficiaryReference string `json:"beneficiaryReference,omitempty"`

	// validator is composed for data validation
	validator
	// converters is composed for WIRE to GoLang Converters
	converters
}

// NewBeneficiaryReference returns a new BeneficiaryReference
func NewBeneficiaryReference() *BeneficiaryReference {
	br := &BeneficiaryReference{
		tag: TagBeneficiaryReference,
	}
	return br
}

// Parse takes the input string and parses the BeneficiaryReference values
//
// Parse provides no guarantee about all fields being filled in. Callers should make a Validate() call to confirm
// successful parsing and data validity.
func (br *BeneficiaryReference) Parse(record string) error {
	if utf8.RuneCountInString(record) < 6 {
		return NewTagMinLengthErr(6, len(record))
	}

	br.tag = record[:6]
	length := 6

	value, read, err := br.parseVariableStringField(record[length:], 16)
	if err != nil {
		return fieldError("BeneficiaryReference", err)
	}
	br.BeneficiaryReference = value
	length += read

	if err := br.verifyDataWithReadLength(record, length); err != nil {
		return NewTagMaxLengthErr(err)
	}

	return nil
}

func (br *BeneficiaryReference) UnmarshalJSON(data []byte) error {
	type Alias BeneficiaryReference
	aux := struct {
		*Alias
	}{
		(*Alias)(br),
	}
	if err := json.Unmarshal(data, &aux); err != nil {
		return err
	}
	br.tag = TagBeneficiaryReference
	return nil
}

// String returns a fixed-width BeneficiaryReference record
func (br *BeneficiaryReference) String() string {
	return br.Format(FormatOptions{
		VariableLengthFields: false,
	})
}

// Format returns a BeneficiaryReference record formatted according to the FormatOptions
func (br *BeneficiaryReference) Format(options FormatOptions) string {
	var buf strings.Builder
	buf.Grow(22)

	buf.WriteString(br.tag)
	buf.WriteString(br.FormatBeneficiaryReference(options) + Delimiter)

	return buf.String()
}

// Validate performs WIRE format rule checks on BeneficiaryReference and returns an error if not Validated
// The first error encountered is returned and stops that parsing.
func (br *BeneficiaryReference) Validate() error {
	if br.tag != TagBeneficiaryReference {
		return fieldError("tag", ErrValidTagForType, br.tag)
	}
	if err := br.isAlphanumeric(br.BeneficiaryReference); err != nil {
		return fieldError("BeneficiaryReference", err, br.BeneficiaryReference)
	}
	return nil
}

// BeneficiaryReferenceField gets a string of the BeneficiaryReference field
func (br *BeneficiaryReference) BeneficiaryReferenceField() string {
	return br.alphaField(br.BeneficiaryReference, 16)
}

// FormatBeneficiaryReference returns BeneficiaryReference formatted according to the FormatOptions
func (br *BeneficiaryReference) FormatBeneficiaryReference(options FormatOptions) string {
	return br.formatAlphaField(br.BeneficiaryReference, 16, options)
}