instructedAmount.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"
)

// InstructedAmount is the InstructedAmount of the wire
type InstructedAmount struct {
	// tag
	tag string
	// CurrencyCode
	CurrencyCode string `json:"currencyCode,omitempty"`
	// Amount  Must begin with at least one numeric character (0-9) and contain only one decimal comma marker
	// (e.g., $1,234.56 should be entered as 1234,56 and $0.99 should be entered as
	Amount string `json:"amount,omitempty"`

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

// NewInstructedAmount returns a new InstructedAmount
func NewInstructedAmount() *InstructedAmount {
	ia := &InstructedAmount{
		tag: TagInstructedAmount,
	}
	return ia
}

// Parse takes the input string and parses the InstructedAmount 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 (ia *InstructedAmount) Parse(record string) error {
	if utf8.RuneCountInString(record) < 8 {
		return NewTagMinLengthErr(8, len(record))
	}

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

	value, read, err := ia.parseFixedStringField(record[length:], 3)
	if err != nil {
		return fieldError("SwiftFieldTag", err)
	}
	ia.CurrencyCode = value
	length += read

	value, read, err = ia.parseVariableStringField(record[length:], 15)
	if err != nil {
		return fieldError("Amount", err)
	}
	ia.Amount = value
	length += read

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

	return nil
}

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

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

// Format returns a InstructedAmount record formatted according to the FormatOptions
func (ia *InstructedAmount) Format(options FormatOptions) string {
	var buf strings.Builder
	buf.Grow(24)

	buf.WriteString(ia.tag)
	buf.WriteString(ia.CurrencyCodeField())
	buf.WriteString(ia.FormatAmount(options) + Delimiter)

	return buf.String()
}

// Validate performs WIRE format rule checks on InstructedAmount and returns an error if not Validated
// The first error encountered is returned and stops that parsing.
func (ia *InstructedAmount) Validate() error {
	if err := ia.fieldInclusion(); err != nil {
		return err
	}
	if ia.tag != TagInstructedAmount {
		return fieldError("tag", ErrValidTagForType, ia.tag)
	}
	if err := ia.isCurrencyCode(ia.CurrencyCode); err != nil {
		return fieldError("CurrencyCode", err, ia.CurrencyCode)
	}
	if err := ia.isAmount(ia.Amount); err != nil {
		return fieldError("Amount", err, ia.Amount)
	}
	return nil
}

// fieldInclusion validate mandatory fields. If fields are
// invalid the WIRE will return an error.
func (ia *InstructedAmount) fieldInclusion() error {
	if ia.Amount == "" {
		return fieldError("Amount", ErrFieldRequired)
	}
	if ia.CurrencyCode == "" {
		return fieldError("CurrencyCode", ErrFieldRequired)

	}
	return nil
}

// CurrencyCodeField gets a string of the CurrencyCode field
func (ia *InstructedAmount) CurrencyCodeField() string {
	return ia.alphaField(ia.CurrencyCode, 3)
}

// AmountField gets a string of the Amount field
func (ia *InstructedAmount) AmountField() string {
	return ia.alphaField(ia.Amount, 15)
}

// FormatCurrencyCode returns CurrencyCode formatted according to the FormatOptions
func (ia *InstructedAmount) FormatCurrencyCode(options FormatOptions) string {
	return ia.formatAlphaField(ia.CurrencyCode, 3, options)
}

// FormatAmount returns Amount formatted according to the FormatOptions
func (ia *InstructedAmount) FormatAmount(options FormatOptions) string {
	return ia.formatAlphaField(ia.Amount, 15, options)
}